Pure Python data structure for working with Ed25519 (and Ristretto) group elements and operations.
Project description
Pure Python data structure for working with Ed25519 (and Ristretto) group elements and operations.
Purpose
This library provides a native Python implementation of Ed25519 group elements and a number of operations over them. The library makes it possible to fill gaps in application prototypes that may have specific limitations with respect to their operating environment or their ability to rely on non-Python dependencies.
The implementation is based upon and is compatible with the corresponding implementation of Ed25519 and Ristretto group elements used in libsodium. For more information and background about the underlying mathematical structures and primitives, consult materials about Curve25519, the Ristretto group, and the related Ed25519 system.
Package Installation and Usage
The package is available on PyPI:
python -m pip install ge25519
The library can be imported in the usual ways:
import ge25519 from ge25519 import *
Documentation
The documentation can be generated automatically from the source files using Sphinx:
cd docs python -m pip install -r requirements.txt sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../setup.py && make html
Testing and Conventions
All unit tests are executed and their coverage is measured when using pytest (see setup.cfg for configuration details):
python -m pip install pytest pytest-cov python -m pytest
Concise unit tests are implemented with the help of fountains; new reference specifications for these tests can be generated by running the testing module directly:
python test/test_ge25519.py
Style conventions are enforced using Pylint:
python -m pip install pylint python -m pylint ge25519 ./test/test_ge25519.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
Beginning with version 0.1.0, 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 by a package maintainer. Install the wheel package, remove any old build/distribution files, and package the source into a distribution archive:
python -m pip install wheel rm -rf dist *.egg-info python setup.py sdist bdist_wheel
Next, install the twine package and upload the package distribution archive to PyPI:
python -m pip install twine python -m twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.