| Name | fe25519 JSON |
| Version |
1.5.0
JSON |
| download |
| home_page | |
| Summary | Pure-Python data structure for working with Ed25519 (and Ristretto) field elements and operations. |
| upload_time | 2023-08-26 17:07:57 |
| maintainer | |
| docs_url | None |
| author | Andrei Lapets |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=======
fe25519
=======
Pure-Python data structure for working with Ed25519 (and Ristretto) field elements and operations.
|pypi| |readthedocs| |actions| |coveralls|
.. |pypi| image:: https://badge.fury.io/py/fe25519.svg
:target: https://badge.fury.io/py/fe25519
:alt: PyPI version and link.
.. |readthedocs| image:: https://readthedocs.org/projects/fe25519/badge/?version=latest
:target: https://fe25519.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.
.. |actions| image:: https://github.com/nthparty/fe25519/workflows/lint-test-cover-docs/badge.svg
:target: https://github.com/nthparty/fe25519/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.
.. |coveralls| image:: https://coveralls.io/repos/github/nthparty/fe25519/badge.svg?branch=main
:target: https://coveralls.io/github/nthparty/fe25519?branch=main
:alt: Coveralls test coverage summary.
Purpose
-------
This library provides a native Python implementation of `Ed25519 <https://ed25519.cr.yp.to>`__ field 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 field elements used in `libsodium <https://github.com/jedisct1/libsodium>`__. For more information and background about the underlying mathematical structures and primitives, consult materials about `Curve25519 <https://cr.yp.to/ecdh.html>`__, the `Ristretto <https://ristretto.group>`__ group, and the related `Ed25519 <https://ed25519.cr.yp.to>`__ system.
Installation and Usage
----------------------
This library is available as a `package on PyPI <https://pypi.org/project/fe25519>`__:
.. code-block:: bash
python -m pip install fe25519
The library can be imported in the usual ways:
.. code-block:: python
import fe25519
from fe25519 import fe25519
Development
-----------
All installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__:
.. code-block:: bash
python -m pip install .[docs,lint]
Documentation
^^^^^^^^^^^^^
The documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:
.. code-block:: bash
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 <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details):
.. code-block:: bash
python -m pip install .[test]
python -m pytest
Concise unit tests are implemented with the help of `fountains <https://pypi.org/project/fountains>`__; new reference specifications for these tests can be generated by running the testing module directly:
.. code-block:: bash
python test/test_fe25519.py
Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:
.. code-block:: bash
python -m pip install .[lint]
python -m pylint src/fe25519 test/test_fe25519.py
Contributions
^^^^^^^^^^^^^
In order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/nthparty/fe25519>`__ 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 <https://semver.org/#semantic-versioning-200>`__.
Publishing
^^^^^^^^^^
This library can be published as a `package on PyPI <https://pypi.org/project/fe25519>`__ by a package maintainer. First, install the dependencies required for packaging and publishing:
.. code-block:: bash
python -m pip install .[publish]
Ensure that the correct version number appears in ``pyproject.toml``, and 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 <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number):
.. code-block:: bash
git tag ?.?.?
git push origin ?.?.?
Remove any old build/distribution files. Then, package the source into a distribution archive:
.. code-block:: bash
rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .
Finally, upload the package distribution archive to `PyPI <https://pypi.org>`__:
.. code-block:: bash
python -m twine upload dist/*
Raw data
{
"_id": null,
"home_page": "",
"name": "fe25519",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Andrei Lapets",
"author_email": "a@lapets.io",
"download_url": "https://files.pythonhosted.org/packages/78/5d/190d1104a421195901b2a001af63563ddc58cf81e639d1262ea2a0465619/fe25519-1.5.0.tar.gz",
"platform": null,
"description": "=======\r\nfe25519\r\n=======\r\n\r\nPure-Python data structure for working with Ed25519 (and Ristretto) field elements and operations.\r\n\r\n|pypi| |readthedocs| |actions| |coveralls|\r\n\r\n.. |pypi| image:: https://badge.fury.io/py/fe25519.svg\r\n :target: https://badge.fury.io/py/fe25519\r\n :alt: PyPI version and link.\r\n\r\n.. |readthedocs| image:: https://readthedocs.org/projects/fe25519/badge/?version=latest\r\n :target: https://fe25519.readthedocs.io/en/latest/?badge=latest\r\n :alt: Read the Docs documentation status.\r\n\r\n.. |actions| image:: https://github.com/nthparty/fe25519/workflows/lint-test-cover-docs/badge.svg\r\n :target: https://github.com/nthparty/fe25519/actions/workflows/lint-test-cover-docs.yml\r\n :alt: GitHub Actions status.\r\n\r\n.. |coveralls| image:: https://coveralls.io/repos/github/nthparty/fe25519/badge.svg?branch=main\r\n :target: https://coveralls.io/github/nthparty/fe25519?branch=main\r\n :alt: Coveralls test coverage summary.\r\n\r\nPurpose\r\n-------\r\nThis library provides a native Python implementation of `Ed25519 <https://ed25519.cr.yp.to>`__ field 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.\r\n\r\nThe implementation is based upon and is compatible with the corresponding implementation of Ed25519 and Ristretto field elements used in `libsodium <https://github.com/jedisct1/libsodium>`__. For more information and background about the underlying mathematical structures and primitives, consult materials about `Curve25519 <https://cr.yp.to/ecdh.html>`__, the `Ristretto <https://ristretto.group>`__ group, and the related `Ed25519 <https://ed25519.cr.yp.to>`__ system.\r\n\r\nInstallation and Usage\r\n----------------------\r\nThis library is available as a `package on PyPI <https://pypi.org/project/fe25519>`__:\r\n\r\n.. code-block:: bash\r\n\r\n python -m pip install fe25519\r\n\r\nThe library can be imported in the usual ways:\r\n\r\n.. code-block:: python\r\n\r\n import fe25519\r\n from fe25519 import fe25519\r\n\r\nDevelopment\r\n-----------\r\nAll installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__:\r\n\r\n.. code-block:: bash\r\n\r\n python -m pip install .[docs,lint]\r\n\r\nDocumentation\r\n^^^^^^^^^^^^^\r\nThe documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:\r\n\r\n.. code-block:: bash\r\n\r\n python -m pip install .[docs]\r\n cd docs\r\n sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html\r\n\r\nTesting and Conventions\r\n^^^^^^^^^^^^^^^^^^^^^^^\r\nAll unit tests are executed and their coverage is measured when using `pytest <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details):\r\n\r\n.. code-block:: bash\r\n\r\n python -m pip install .[test]\r\n python -m pytest\r\n\r\nConcise unit tests are implemented with the help of `fountains <https://pypi.org/project/fountains>`__; new reference specifications for these tests can be generated by running the testing module directly:\r\n\r\n.. code-block:: bash\r\n\r\n python test/test_fe25519.py\r\n\r\nStyle conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:\r\n\r\n.. code-block:: bash\r\n\r\n python -m pip install .[lint]\r\n python -m pylint src/fe25519 test/test_fe25519.py\r\n\r\nContributions\r\n^^^^^^^^^^^^^\r\nIn order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/nthparty/fe25519>`__ for this library.\r\n\r\nVersioning\r\n^^^^^^^^^^\r\nBeginning 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 <https://semver.org/#semantic-versioning-200>`__.\r\n\r\nPublishing\r\n^^^^^^^^^^\r\nThis library can be published as a `package on PyPI <https://pypi.org/project/fe25519>`__ by a package maintainer. First, install the dependencies required for packaging and publishing:\r\n\r\n.. code-block:: bash\r\n\r\n python -m pip install .[publish]\r\n\r\nEnsure that the correct version number appears in ``pyproject.toml``, and 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 <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number):\r\n\r\n.. code-block:: bash\r\n\r\n git tag ?.?.?\r\n git push origin ?.?.?\r\n\r\nRemove any old build/distribution files. Then, package the source into a distribution archive:\r\n\r\n.. code-block:: bash\r\n\r\n rm -rf build dist src/*.egg-info\r\n python -m build --sdist --wheel .\r\n\r\nFinally, upload the package distribution archive to `PyPI <https://pypi.org>`__:\r\n\r\n.. code-block:: bash\r\n\r\n python -m twine upload dist/*\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pure-Python data structure for working with Ed25519 (and Ristretto) field elements and operations.",
"version": "1.5.0",
"project_urls": {
"Documentation": "https://fe25519.readthedocs.io",
"Repository": "https://github.com/nthparty/fe25519"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "006203f171160749e7c3b433267ab00b8cf33972e42a9500acf4ba1ffe4e7518",
"md5": "7dfe09b52724ae98a86b2014d8472b61",
"sha256": "59f458a1fa8853af136e64fdd909d7ef861d411251a01a49b1836eebdb3f4284"
},
"downloads": -1,
"filename": "fe25519-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7dfe09b52724ae98a86b2014d8472b61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8492,
"upload_time": "2023-08-26T17:07:55",
"upload_time_iso_8601": "2023-08-26T17:07:55.793265Z",
"url": "https://files.pythonhosted.org/packages/00/62/03f171160749e7c3b433267ab00b8cf33972e42a9500acf4ba1ffe4e7518/fe25519-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "785d190d1104a421195901b2a001af63563ddc58cf81e639d1262ea2a0465619",
"md5": "4793233f189e3c1edec420f220b7d54e",
"sha256": "95afb5eed3c78dc78c4deed693c0c655a4a9b64f1725afa5ec64dea8b2050efb"
},
"downloads": -1,
"filename": "fe25519-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "4793233f189e3c1edec420f220b7d54e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12482,
"upload_time": "2023-08-26T17:07:57",
"upload_time_iso_8601": "2023-08-26T17:07:57.439073Z",
"url": "https://files.pythonhosted.org/packages/78/5d/190d1104a421195901b2a001af63563ddc58cf81e639d1262ea2a0465619/fe25519-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-26 17:07:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nthparty",
"github_project": "fe25519",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fe25519"
}
