Skip to main content

Python API for Heimdallr

Project description

This module is a Python API for Heimdallr.


pip install py-heimdallr-client


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
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 test from the project directory. To run them directly you can just call python tests/ To run coverage tests and generate an HTML report run:

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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py-heimdallr-client-0.0.2.tar.gz (9.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page