mirror of
https://github.com/saymrwulf/cryptography.git
synced 2026-05-14 20:37:55 +00:00
cryptography is a package designed to expose cryptographic primitives and recipes to Python developers.
dbf183506c
Cryptography uses new features from tox 2.4. Tox 2.3 happily ignores the new config stanzes and doesn't install dependency. This can lead to strange test failures. With minversion=2.4, tox 2.3 fails to run properly: $ tox ERROR: tox version is 2.3.1, required is at least 2.4 Signed-off-by: Christian Heimes <christian@python.org> |
||
|---|---|---|
| .jenkins | ||
| .travis | ||
| docs | ||
| src | ||
| tests | ||
| vectors | ||
| .coveragerc | ||
| .gitignore | ||
| .mention-bot | ||
| .travis.yml | ||
| AUTHORS.rst | ||
| CHANGELOG.rst | ||
| codecov.yml | ||
| CONTRIBUTING.rst | ||
| dev-requirements.txt | ||
| LICENSE | ||
| LICENSE.APACHE | ||
| LICENSE.BSD | ||
| LICENSE.PSF | ||
| MANIFEST.in | ||
| README.rst | ||
| setup.py | ||
| tasks.py | ||
| tox.ini | ||
Cryptography
============
.. image:: https://img.shields.io/pypi/v/cryptography.svg
:target: https://pypi.python.org/pypi/cryptography/
:alt: Latest Version
.. image:: https://readthedocs.org/projects/cryptography/badge/?version=latest
:target: https://cryptography.io
:alt: Latest Docs
.. image:: https://travis-ci.org/pyca/cryptography.svg?branch=master
:target: https://travis-ci.org/pyca/cryptography
.. image:: https://codecov.io/github/pyca/cryptography/coverage.svg?branch=master
:target: https://codecov.io/github/pyca/cryptography?branch=master
``cryptography`` is a package which provides cryptographic recipes and
primitives to Python developers. Our goal is for it to be your "cryptographic
standard library". It supports Python 2.6-2.7, Python 3.3+, and PyPy 2.6+.
``cryptography`` includes both high level recipes, and low level interfaces to
common cryptographic algorithms such as symmetric ciphers, message digests and
key derivation functions. For example, to encrypt something with
``cryptography``'s high level symmetric encryption recipe:
.. code-block:: pycon
>>> from cryptography.fernet import Fernet
>>> # Put this somewhere safe!
>>> key = Fernet.generate_key()
>>> f = Fernet(key)
>>> token = f.encrypt(b"A really secret message. Not for prying eyes.")
>>> token
'...'
>>> f.decrypt(token)
'A really secret message. Not for prying eyes.'
You can find more information in the `documentation`_.
You can install ``cryptography`` with:
.. code-block:: console
$ pip install cryptography
For full details see `the installation documentation`_.
Discussion
~~~~~~~~~~
If you run into bugs, you can file them in our `issue tracker`_.
We maintain a `cryptography-dev`_ mailing list for development discussion.
You can also join ``#cryptography-dev`` on Freenode to ask questions or get
involved.
.. _`documentation`: https://cryptography.io/
.. _`the installation documentation`: https://cryptography.io/en/latest/installation/
.. _`issue tracker`: https://github.com/pyca/cryptography/issues
.. _`cryptography-dev`: https://mail.python.org/mailman/listinfo/cryptography-dev