SDK for interacting with Nillion's Private Storage solutions.

Navigation

Verified details

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

Unverified details

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

Project description

SDK for interacting with Nillion’s Private Storage solutions.

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

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 Usage 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 ../src && 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

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 frederickjansen from gravatar.com frederickjansen Avatar for g5f from gravatar.com g5f Avatar for lapets from gravatar.com lapets Avatar for stephorpilla from gravatar.com stephorpilla

Unverified details

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

Release history Release notifications | RSS feed

This version

0.3.2

0.3.1

0.3.0

0.2.1

0.1.2

0.1.1

0.0.0a10 pre-release

0.0.0a9 pre-release

0.0.0a8 pre-release

0.0.0a7 pre-release

0.0.0a6 pre-release

0.0.0a5 pre-release

0.0.0a4 pre-release

0.0.0a3 pre-release

0.0.0a2 pre-release

0.0.0a1 pre-release

0.0.0a0 pre-release

Download files

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

Source Distribution

secretvaults-0.3.2.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

secretvaults-0.3.2-py3-none-any.whl (37.3 kB view details)

Uploaded Python 3

File details

Details for the file secretvaults-0.3.2.tar.gz.

File metadata

  • Download URL: secretvaults-0.3.2.tar.gz
  • Upload date:
  • Size: 30.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for secretvaults-0.3.2.tar.gz
Algorithm Hash digest
SHA256 660dd9c1bda1c1d0395b4ed16ff6cf0fc6d6587ad0a9bd7061640d05f4644f41
MD5 be77092fb6625ec01ae5562fd795f049
BLAKE2b-256 fb4331433116c5795679b6f5b92129732e2209cf421628dcff9bfec527b0e6c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for secretvaults-0.3.2.tar.gz:

Publisher: build-publish-sign-release.yml on NillionNetwork/secretvaults-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 secretvaults-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: secretvaults-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 37.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for secretvaults-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 65a3158b287ea106d7369723b9a53bcb5c6786974c74634bce71b1d71fba33f9
MD5 6a5ce94d94c70c0717cd151a1a7d142f
BLAKE2b-256 d1dfa3e34005625cad877e93c62050b8715caa451fb254ea9f020e9afc5f5f60

See more details on using hashes here.

Provenance

The following attestation bundles were made for secretvaults-0.3.2-py3-none-any.whl:

Publisher: build-publish-sign-release.yml on NillionNetwork/secretvaults-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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page