Easy-to-import Python module with a basic, efficient, native implementation of the extended Euclidean algorithm.
Project description
Easy-to-import Python module with a basic, efficient, native implementation of the extended Euclidean algorithm.
Installation and Usage
This library is available as a package on PyPI:
python -m pip install egcd
The library can be imported in the usual way:
from egcd import egcd
The function egcd is an efficient implementation of the extended Euclidean algorithm. It accepts two integer inputs b and n, returning a tuple of the form (gcd(b, n), a, m) where the three integers in the tuple satisfy the identity (a * b) + (n * m) == gcd(b, n):
>>> egcd(1, 1) (1, 0, 1) >>> egcd(12, 8) (4, 1, -1) >>> egcd(23894798501898, 23948178468116) (2, 2437250447493, -2431817869532) >>> egcd(pow(2, 50), pow(3, 50)) (1, -260414429242905345185687, 408415383037561)
Development
All installation and development dependencies are managed using setuptools and are fully specified in setup.py. The extras_require parameter 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 .. ../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 .[test] python -m pytest
Alternatively, all unit tests are included in the module itself and can be executed using doctest:
python egcd/egcd.py -v
Style conventions are enforced using Pylint:
python -m pip install .[lint] python -m pylint egcd
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. First, install the dependencies required for packaging and publishing:
python -m pip install .[publish]
Remove any old build/distribution files. Then, package the source into a distribution archive using the wheel package:
rm -rf dist *.egg-info python setup.py sdist bdist_wheel
Finally, upload the package distribution archive to PyPI using the twine package:
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.