Contribution guide

This documents guides you on how to contribute to this project.

Prerequisites

1. git clone git@github.com:webscopeio/license.sh.git
2. Install
3. pipenv
4. pipenv install && pipenv shell
5. Run
6. license audit of license.sh pipenv run ./license.sh or
7. unit tests pipenv run python -m unittest
8. run style formater black .
9. open documentation with pipenv run mkdocs serve
10. Read Architecture section.

Packaging

In order to distribute & test this package, run python3 setup.py sdist in a home directory.

It will generate .tar.gz file in dist/ directory which you can install with pip install <file.tar.gz>