py-heimdallr-client 0.0.2

Python API for Heimdallr

This module is a Python API for Heimdallr.

Installation

pip install py-heimdallr-client

Contributing

Please use a linter to help follow PEP8 style guidelines. We use Vincent Driessen’s git-flow so please make pull requests to the develop branch. For any new features you might add please add the corresponding documentation and tests. To setup the project for development you need virtualenv. Once you have virtualenv installed and setup can run:

mkvirtualenv py-heimdallr-client
workon py-heimdallr-client
git clone [e-mail]:Layer3DLab/py-heimdallr-client.git
cd py-heimdallr-client
git checkout develop
npm install
pip install -r dev_requirements.txt

NOTE: if you’re on OSX and cryptography fails to install you may need to follow these directions.

Adding Documentation

We use Sphinx with the autodoc and napoleon extensions to generate the documentation for this module. So to add documentation simply add Python docstrings to whatever classes, methods, etc. that you add. We use Google style docstrings (examples here). To build the docs run the following from the project directory:

cd docs
make html

Adding Tests

We use unittest for our testing suite. To run the tests you can just call python setup.py test from the project directory. To run them directly you can just call python tests/__init__.py To run coverage tests and generate an HTML report run:

coverage  run --source="./heimdallr_client" --branch -m unittest tests
coverage html