secretvaults

A set of tools for interacting with Nillion's Private Storage.

Description and Purpose

Provides functions to simplify usage of Nillion's Private Storage.

Installation and Usage

You can install the package using pip:

pip install secretvaults

The library can be imported in the usual ways:

import secretvaults
from secretvaults import *

Examples and Documentation

Please see the examples directory for examples and documentation.

Development

All installation and development dependencies are fully specified in pyproject.toml. The project.optional-dependencies object is used to specify optional requirements for various development tasks. This makes it possible to specify additional options (such as docs, lint, and so on) when performing installation using pip:

python -m pip install ".[docs,lint]"

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 test

Style conventions are enforced using Pylint:

python -m pip install ".[lint]"
python -m pylint src/secretvaults

Contributions

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 to 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.