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

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for lapets from gravatar.com lapets

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Requires: Python >=3.9
  • Provides-Extra: docs , test , lint , coveralls , publish
Report project as malware

Project description

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

PyPI version and link. Read the Docs documentation status. GitHub Actions status. Coveralls test coverage summary.

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.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for lapets from gravatar.com lapets

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Requires: Python >=3.9
  • Provides-Extra: docs , test , lint , coveralls , publish

Release history Release notifications | RSS feed

This version

0.1.0

0.1.0rc3 pre-release

0.1.0rc2 pre-release

0.1.0rc1 pre-release

0.0.0

Download files

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

Source Distribution

nuc-0.1.0.tar.gz (29.6 kB view details)

Uploaded Source

Built Distribution

nuc-0.1.0-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file nuc-0.1.0.tar.gz.

File metadata

  • Download URL: nuc-0.1.0.tar.gz
  • Upload date:
  • Size: 29.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nuc-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6a715bf07a8adf2901b68c9597ba44ae28506c3fb0fa03530c092bc0f8ba22f0
MD5 4211fa680d569e847328f93ea080ee0f
BLAKE2b-256 e958acfdbdd6dc8e8575a1bc2ade9eedf7d33d99ac428573df5a46a4f4b76949

See more details on using hashes here.

Provenance

The following attestation bundles were made for nuc-0.1.0.tar.gz:

Publisher: build-publish-sign-release.yml on NillionNetwork/nuc-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nuc-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: nuc-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nuc-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6845133866f2d41592be74ca2a41295d09d7a6d89886a5a1181dceefd4fe5a65
MD5 4749b9cd37347df04546a8ff757ee330
BLAKE2b-256 80baa99b12ee5132976d974fe65f9dbeaaafe4183a8558859c72bd271f87e25c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nuc-0.1.0-py3-none-any.whl:

Publisher: build-publish-sign-release.yml on NillionNetwork/nuc-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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