• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1pyca/cryptography
2=================
3
4.. image:: https://img.shields.io/pypi/v/cryptography.svg
5    :target: https://pypi.org/project/cryptography/
6    :alt: Latest Version
7
8.. image:: https://readthedocs.org/projects/cryptography/badge/?version=latest
9    :target: https://cryptography.io
10    :alt: Latest Docs
11
12.. image:: https://travis-ci.org/pyca/cryptography.svg?branch=master
13    :target: https://travis-ci.org/pyca/cryptography
14
15.. image:: https://codecov.io/github/pyca/cryptography/coverage.svg?branch=master
16    :target: https://codecov.io/github/pyca/cryptography?branch=master
17
18
19``cryptography`` is a package which provides cryptographic recipes and
20primitives to Python developers.  Our goal is for it to be your "cryptographic
21standard library". It supports Python 2.7, Python 3.4+, and PyPy 5.3+.
22
23``cryptography`` includes both high level recipes and low level interfaces to
24common cryptographic algorithms such as symmetric ciphers, message digests, and
25key derivation functions. For example, to encrypt something with
26``cryptography``'s high level symmetric encryption recipe:
27
28.. code-block:: pycon
29
30    >>> from cryptography.fernet import Fernet
31    >>> # Put this somewhere safe!
32    >>> key = Fernet.generate_key()
33    >>> f = Fernet(key)
34    >>> token = f.encrypt(b"A really secret message. Not for prying eyes.")
35    >>> token
36    '...'
37    >>> f.decrypt(token)
38    'A really secret message. Not for prying eyes.'
39
40You can find more information in the `documentation`_.
41
42You can install ``cryptography`` with:
43
44.. code-block:: console
45
46    $ pip install cryptography
47
48For full details see `the installation documentation`_.
49
50Discussion
51~~~~~~~~~~
52
53If you run into bugs, you can file them in our `issue tracker`_.
54
55We maintain a `cryptography-dev`_ mailing list for development discussion.
56
57You can also join ``#cryptography-dev`` on Freenode to ask questions or get
58involved.
59
60Security
61~~~~~~~~
62
63Need to report a security issue? Please consult our `security reporting`_
64documentation.
65
66
67.. _`documentation`: https://cryptography.io/
68.. _`the installation documentation`: https://cryptography.io/en/latest/installation/
69.. _`issue tracker`: https://github.com/pyca/cryptography/issues
70.. _`cryptography-dev`: https://mail.python.org/mailman/listinfo/cryptography-dev
71.. _`security reporting`: https://cryptography.io/en/latest/security/
72