Developer Documentation

Install requirement

pip install -r requirements.txt
pip install -r dev-requirements.txt
pip install -r doc-requirements.txt

Makefile

First check Makefile. It contains many useful commands to work with the project:

test:

pytest

coverage:

pytest -s –cov –cov-report html –cov-fail-under 100

yamllint:

yamllint -d relaxed .

black:

black .

build:

python -m build

install:

make build pip install dist/*.whl

uninstall:

pip uninstall replay-wizard -y rm -rf dist rm -rf replay_wizard.egg-info

reinstall:

make uninstall make install

pylint:

pylint $(shell git ls-files ‘*.py’)

lint:

make yamllint make pylint

sphinx-help:

make help -f Sphinxfile

package_docs:

sphinx-apidoc -o docs/package replay_wizard/

capture:

python capture.py debug

time_capture:

python capture.py debug -t true

replay:

python replay.py debug -d 5

time_replay:

python replay.py debug -t true -d 5

monitor_replay:

python replay.py debug -t true -d 5 -m true

capture_mouse:

python capture.py debug -k false -mo true -t true

capture_all:

python capture.py debug -mo true -t true

Get started

You can start with test and test coverage:

make coverage
make test

Check lint and test coverage before sending pull-request

make lint

Build documentation

make package_docs
cd docs
make clean html
make html