cryptography/README.rst

46 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2013-08-07 02:30:47 +00:00
Cryptography
============
.. image:: https://travis-ci.org/pyca/cryptography.png?branch=master
2013-11-06 00:29:00 +00:00
: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
2013-08-07 18:50:05 +00:00
2013-10-27 20:53:34 +00:00
``cryptography`` is a package designed to expose cryptographic recipes and
2014-02-11 02:52:47 +00:00
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.
2013-08-07 16:56:34 +00:00
2014-02-11 02:52:47 +00:00
``cryptography`` includes both high level recipes, and low level algorithms.
For example, to encrypt something with ``cryptography``:
2013-08-07 16:56:34 +00:00
2014-02-11 02:52:47 +00:00
.. code-block:: python
>>> 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.'
2014-02-11 02:52:47 +00:00
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.
2013-10-22 21:25:49 +00:00
You can also join ``#cryptography-dev`` on Freenode to ask questions or get
involved.
2013-10-22 21:25:49 +00:00
.. _`documentation`: https://cryptography.io/
.. _`issue tracker`: https://github.com/pyca/cryptography/issues
.. _`cryptography-dev`: https://mail.python.org/mailman/listinfo/cryptography-dev