Quick Start

Working with OpenAdapt

Experiencing difficulty? Get support on our Discord.

Installation

OpenAdapt requires Python3.10, you can download it here or try our installer, which will download Python for you.

First, clone & navigate to the repository:

git clone https://github.com/MLDSAI/OpenAdapt.git
cd OpenAdapt

If poetry is not installed, you can use pip to install it:

pip install poetry

Lastly, run these lines to setup the environment:

poetry install
poetry shell
alembic upgrade head

git clone https://github.com/MLDSAI/OpenAdapt.git
cd OpenAdapt
python3.10 -m venv .venv
source .venv/bin/activate
pip install wheel
pip install -r requirements.txt
pip install -e .
alembic upgrade head

pip install openadapt

Good to know: After installing OpenAdapt, run pytest to verify that the installation was successful.

Make your first recording

Note: A GUI is currently in development, see app (module)

To make your first recording, try the following command:

python -m openadapt.record "testing openadapt"

You should see the following when recording has begun:

| INFO     | __mp_main__:performance_stats_writer:422 - performance stats writer starting
| INFO     | __mp_main__:write_events:211 - event_type='window' starting
| INFO     | __mp_main__:write_events:211 - event_type='screen' starting
| INFO     | __mp_main__:write_events:211 - event_type='action' starting

To stop recording, focus the terminal and send CTRL+C (SIGINT). The recording is finished saving when you see something like this:

| INFO     | __main__:record:637 - joining...
| INFO     | __mp_main__:write_events:221 - event_type='window' done
| INFO     | __mp_main__:write_events:221 - event_type='action' done
| INFO     | __main__:read_screen_events:356 - done
| INFO     | __main__:process_events:126 - done
| INFO     | __mp_main__:write_events:221 - event_type='screen' done
| INFO     | __main__:record:652 - saved recording_timestamp=1686243306.393652
| INFO     | __mp_main__:performance_stats_writer:433 - performance stats writer done

To check what the recording looks like, run python -m openadapt.visualize