Contributing

• Feel free to contribute to this project! Just fork it, make any changes on your fork and add a pull request on the current branch! Any advice, help or questions would be appreciated

Documentation

• This site uses Just the Docs.
• Install dependencies using

$ cd docs
$ bundle install

• Test locally using

$ cd docs
$ bundle exec jekyll serve -c _config_dev.yml --livereload --open-url

Testing

• Test cases must be updated as we don’t want any unexpected exceptions to pop up in between long runs.
• Install pytest and coverage.

$ pip install -r requirements_dev.txt

• Before committing, make sure to run all the test cases.

$ coverage run -m pytest -q --tb=short modules/tests/

• Or a module-specific test case using

$ pytest -q --tb=short modules/tests/test_extractor.py::TestCheckerFunctions::test_outex_002

• Check code coverage

$ coverage report -m
$ coverage html