Contribution Guide

Contributions are welcome, please open any PR you wish in this project’s Github repo!

Project TODO

Implement roles for this package so administrators can restrict use of the command/module.
Add a lookup method to lookup.lib that doesn’t create nodes by default. This will be code reuse, because it won’t be usable in lookupOrCreate, but it may be a useful method.

Dev Environment

A Pipfile is included in this project to enforce a consistent dev environment. Install it with the pipenv tool, or use the Makefile:

make setup

Testing

There is a pytest test suite for this project in the tests/ directory. You can run it with the project’s Makefile or directly with pytest:

make tests

pytest tests/ -svx

Building and Releasing

The build/release process is managed by the Makefile. Building can be done without releasing, but releasing always forces a fresh build, even if it rebuilds the same exact code. A VERSION argument is required when releasing, but not when building.

Make sure that all changes are committed before releasing. git commit and git push are run, so any staged changes, or uncommitted changes in certain folders, may be committed by accident.

Build:

make build

Release:

make release VERSION=1.2.3

Docs

This documentation is built with Sphinx and is configured in the doc folder. Documentation is automatically built everytime that make release is executed. But they may also be built separately using this command:

make docs

There is also a Makefile command to open the current version of the docs locally:

make read-docs