Metadata-Version: 2.4
Name: toycrypto
Version: 0.5.1
Summary: Modules that can be used to illustrate and explore cryptographic concepts. This should never be used for security purposes.
Project-URL: Documentation, https://jpgoldberg.github.io/toy-crypto-math/
Project-URL: Issues, https://github.com/jpgoldberg/toy-crypto-math/issues
Project-URL: Source, https://github.com/jpgoldberg/toy-crypto-math
Project-URL: Changelog, https://github.com/jpgoldberg/toy-crypto-math/blob/main/CHANGELOG.md
Author-email: Jeffrey Goldberg <jeffrey@goldmark.org>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Security :: Cryptography
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: jsonref>=1.1.0
Requires-Dist: jsonschema>=4.25.0
Requires-Dist: primefac>=2.0.12
Requires-Dist: referencing>=0.36.2
Provides-Extra: c-deps
Requires-Dist: bitarray; extra == 'c-deps'
Description-Content-Type: text/markdown

# Toy cryptographic utilities

[![mypy status][type-badge]](https://mypy.readthedocs.io/en/stable/)
[![ruff status][lint-badge]](https://docs.astral.sh/ruff/)
[![pytest status][test-badge]](https://docs.pytest.org/en/stable/)
![Doctest status][doctest-badge]
[![PyPI](https://img.shields.io/pypi/v/toycrypto?label=pypi%20package)][published]
[![Documentation][doc-build-badge]][documentation]
[![License: MIT](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/jpgoldberg/toy-crypto-math/blob/main/LICENSE.txt)

----

This is a collection of utilities that can be used for illustrating or
exploring some cryptographic concepts.
Although it includes implementations of some cryptographic algorithms,
these are **not secure** implementations.

See the [documentation] for use (or not) and [reasons why this exists](https://jpgoldberg.github.io/toy-crypto-math/why/).

Note that if you need to do cryptography in Python,
I recommend [pyca](https://cryptography.io/) or [PyNaCl](https://pynacl.readthedocs.io/en/latest/).
If you want tools to explore the algebraic and number theoretic constructs used in cryptography,
look at [SageMath](https://doc.sagemath.org/) or [SymPy](https://www.sympy.org/en/index.html).

[published]: https://pypi.org/project/toycrypto/ "toycrypto on PyPi"
[documentation]: https://jpgoldberg.github.io/toy-crypto-math/

[type-badge]: https://github.com/jpgoldberg/toy-crypto-math/actions/workflows/type-check.yml/badge.svg
[lint-badge]: https://github.com/jpgoldberg/toy-crypto-math/actions/workflows/lint.yml/badge.svg
[test-badge]: https://github.com/jpgoldberg/toy-crypto-math/actions/workflows/pytest.yml/badge.svg
[doctest-badge]: https://github.com/jpgoldberg/toy-crypto-math/actions/workflows/doctest.yml/badge.svg
[doc-build-badge]: https://github.com/jpgoldberg/toy-crypto-math/actions/workflows/gh-pages.yml/badge.svg
