https://github.com/lapets/univariate
Data structure for representing secret shares of elements of finite sets and univariate functions thereof, designed for use within secure multi-party computation (MPC) protocol implementations.
https://github.com/lapets/univariate
Last synced: 10 months ago
JSON representation
Data structure for representing secret shares of elements of finite sets and univariate functions thereof, designed for use within secure multi-party computation (MPC) protocol implementations.
- Host: GitHub
- URL: https://github.com/lapets/univariate
- Owner: lapets
- License: mit
- Created: 2022-09-21T03:22:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-22T15:33:11.000Z (over 3 years ago)
- Last Synced: 2025-01-23T12:46:32.549Z (12 months ago)
- Language: Python
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
==========
univariate
==========
Data structure for representing secret shares of elements of finite sets and univariate functions thereof, designed for use within secure multi-party computation (MPC) protocol implementations.
|pypi| |readthedocs| |actions| |coveralls|
.. |pypi| image:: https://badge.fury.io/py/univariate.svg
:target: https://badge.fury.io/py/univariate
:alt: PyPI version and link.
.. |readthedocs| image:: https://readthedocs.org/projects/univariate/badge/?version=latest
:target: https://univariate.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.
.. |actions| image:: https://github.com/lapets/univariate/workflows/lint-test-cover-docs/badge.svg
:target: https://github.com/lapets/univariate/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.
.. |coveralls| image:: https://coveralls.io/repos/github/lapets/univariate/badge.svg?branch=main
:target: https://coveralls.io/github/lapets/univariate?branch=main
:alt: Coveralls test coverage summary.
Installation and Usage
----------------------
This library is available as a `package on PyPI `__::
python -m pip install univariate
The library can be imported in the usual ways::
import univariate
from univariate import univariate
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 .. && 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
Alternatively, all unit tests are included in the module itself and can be executed using `doctest `__::
python src/univariate/univariate.py -v
Style conventions are enforced using `Pylint `__::
python -m pip install .[lint]
python -m pylint src/univariate
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 `__ by a package maintainer. First, install the dependencies required for packaging and publishing::
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 `__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number)::
git tag ?.?.?
git push origin ?.?.?
Remove any old build/distribution files. Then, package the source into a distribution archive::
rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .
Finally, upload the package distribution archive to `PyPI `__::
python -m twine upload dist/*