| Cryptography |
| ============ |
| |
| .. image:: https://travis-ci.org/pyca/cryptography.png?branch=master |
| :target: https://travis-ci.org/pyca/cryptography |
| |
| .. image:: https://coveralls.io/repos/pyca/cryptography/badge.png?branch=master |
| :target: https://coveralls.io/r/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.2+, and PyPy. |
| |
| ``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`_. |
| |
| 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/ |
| .. _`issue tracker`: https://github.com/pyca/cryptography/issues |
| .. _`cryptography-dev`: https://mail.python.org/mailman/listinfo/cryptography-dev |