Example

An example workflow that demonstrates use of the library is presented below:

import nilql
cluster = {'nodes': [{}, {}, {}]}
secret_key = nilql.SecretKey.generate(cluster, {'store': True})
plaintext = 123
ciphertext = nilql.encrypt(secret_key, plaintext)
decrypted = nilql.decrypt(secret_key, ciphertext)
assert(plaintext == decrypted)

Documentation

The documentation can be generated automatically from the source files using Sphinx:

python -m pip install ".[docs]"
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using pytest (see the pyproject.toml file for configuration details):

python -m pip install ".[test]"
python -m pytest

The subset of the unit tests included in the module itself and can be executed using doctest:

python src/nilql/nilql.py -v

Style conventions are enforced using Pylint:

python -m pip install ".[lint]"
python -m pylint src/nilql test/test_nilql.py

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

The version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.

Publishing

This library can be published as a package on PyPI via the GitHub Actions workflow found in .github/workflows/build-publish-sign-release.yml that follows the recommendations found in the Python Packaging User Guide.

Ensure that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an automation rule that activates and sets as the default all tagged versions.