Development

Generating documentation

You can either use makefile:

cd docs
make html

Or you can use autobuild:

cd docs
sphinx-autobuild . _build/html/

Or you can use the script:

script/docs

Linting project

You can run pylint yourself:

pylint mockerena

Or you can use the script:

script/lint

Running tests

Testing requires 3 python libraries to be installed prior to running. If you use the test script you can avoid installing these dependencies yourself. To install dependencies run:

pip install pytest pytest-cov pytest-flask

Once the dependencies are installed you can run pytest yourself:

pytest tests/

Or you can use the script:

script/test

Updating dependencies

You can run pip update yourself:

pip install -U -r requirements.txt

Or you can use the script:

script/update