README.rst 2.3 KB
Newer Older
1 2
pyca/cryptography
=================
3

4
.. image:: https://img.shields.io/pypi/v/cryptography.svg
5
    :target: https://pypi.org/project/cryptography/
6 7
    :alt: Latest Version

8 9 10 11
.. image:: https://readthedocs.org/projects/cryptography/badge/?version=latest
    :target: https://cryptography.io
    :alt: Latest Docs

12
.. image:: https://travis-ci.org/pyca/cryptography.svg?branch=master
13 14
    :target: https://travis-ci.org/pyca/cryptography

15 16
.. image:: https://codecov.io/github/pyca/cryptography/coverage.svg?branch=master
    :target: https://codecov.io/github/pyca/cryptography?branch=master
17 18


19
``cryptography`` is a package which provides cryptographic recipes and
20
primitives to Python developers.  Our goal is for it to be your "cryptographic
21
standard library". It supports Python 2.7, Python 3.4+, and PyPy 5.4+.
22

23 24
``cryptography`` includes both high level recipes and low level interfaces to
common cryptographic algorithms such as symmetric ciphers, message digests, and
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
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`_.

42 43 44 45 46 47 48 49
You can install ``cryptography`` with:

.. code-block:: console

    $ pip install cryptography

For full details see `the installation documentation`_.

50 51 52 53 54 55 56 57 58 59
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.

60 61 62 63 64 65
Security
~~~~~~~~

Need to report a security issue? Please consult our `security reporting`_
documentation.

66 67

.. _`documentation`: https://cryptography.io/
68
.. _`the installation documentation`: https://cryptography.io/en/latest/installation/
69 70
.. _`issue tracker`: https://github.com/pyca/cryptography/issues
.. _`cryptography-dev`: https://mail.python.org/mailman/listinfo/cryptography-dev
71
.. _`security reporting`: https://cryptography.io/en/latest/security/