nuc

Data structures and functionalities for the Nillion Network user identity and authorization framework.

Installation and Usage

The library can be imported in the usual ways:

import nuc
from nuc import *

Development

This project is managed via uv. To install dependencies run:

uv sync --dev

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:

uv sync --dev --extra docs --extra lint

Documentation

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

uv sync --extra docs
cd docs
uv run sphinx-apidoc -f -E --templatedir=_templates -o _source ../src && uv run 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):

uv sync --extra test
uv run pytest

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

python src/nuc/nuc.py -v

Style conventions are enforced using Pylint:

uv sync --extra lint
uv run pylint src/nuc test/test_nuc.py

Type checking is enforced using Pyright:

uv sync --extra lint
uv run pyright

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.