README.rst 2.5 KB

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