Development

Setup

Install both library dependencies and the dependencies needed for testing:

$ pip3 install -q -r requirements.txt
$ pip3 install -q -r test_requirements.txt

Testing

Using nosetests, in the project directory, run:

$ nosetests -v

To generate a test coverage report with nosetests:

$ nosetests -v --with-coverage --cover-package=hgijson --cover-inclusive

Documentation

The documentation can be served using mkdocs and then viewed through a web browser. After installing mkdocs, setup from the project root directory using:

mkdocs serve