Developer Guide

Setup Development Environment

1. Install pip3 and development dependencies:

   wget https://bootstrap.pypa.io/get-pip.py
   sudo python3 get-pip.py
   sudo pip3 install tox
   

2. Install a native toolchain to build extensions and other required tools:

   sudo apt install python3-dev build-essential graphviz
   

3. Optionally, it is recommended to install the webdev package to run a development web server from a local directory:

   sudo pip3 install webdev
   webdev .tox/doc/tmp/html
   

Building Package

tox -e build

Output will be available at dist/.

• Source distribution: ninjecto-<version>.tar.gz.
• Python wheel: ninjecto-<version>-py3-none-any.whl
• Binary wheel: ninjecto-<version>-cp36-cp36m-linux_x86_64.whl

Note

The tags of the binary wheel will change depending on the interpreter and operating system you build the binary wheel on.

Building Documentation

tox -e doc

Output documentation will be available at .tox/doc/tmp/html. To view the documentation execute:

webdev .tox/doc/tmp/html

Running Tests

tox -e test

Results will be available at .tox/test/tmp/. To view the results execute:

webdev .tox/test/tmp/

• Test XML results: tests.xml.
• Coverage XML results: coverage.xml.
• Coverage HTML report: htmlcov/index.html.