diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 35 |
1 files changed, 27 insertions, 8 deletions
@@ -1,8 +1,8 @@ -Cryptography -============ +pyca/cryptography +================= .. image:: https://img.shields.io/pypi/v/cryptography.svg - :target: https://pypi.python.org/pypi/cryptography/ + :target: https://pypi.org/project/cryptography/ :alt: Latest Version .. image:: https://readthedocs.org/projects/cryptography/badge/?version=latest @@ -12,16 +12,19 @@ Cryptography .. image:: https://travis-ci.org/pyca/cryptography.svg?branch=master :target: https://travis-ci.org/pyca/cryptography -.. image:: https://img.shields.io/coveralls/pyca/cryptography/master.svg - :target: https://coveralls.io/r/pyca/cryptography?branch=master +.. image:: https://github.com/pyca/cryptography/workflows/CI/badge.svg?branch=master + :target: https://github.com/pyca/cryptography/actions?query=workflow%3ACI+branch%3Amaster + +.. image:: https://codecov.io/github/pyca/cryptography/coverage.svg?branch=master + :target: https://codecov.io/github/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.3+, and PyPy. +standard library". It supports Python 2.7, Python 3.5+, and PyPy 5.4+. -``cryptography`` includes both high level recipes, and low level interfaces to -common cryptographic algorithms such as symmetric ciphers, message digests and +``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: @@ -39,6 +42,14 @@ key derivation functions. For example, to encrypt something with You can find more information in the `documentation`_. +You can install ``cryptography`` with: + +.. code-block:: console + + $ pip install cryptography + +For full details see `the installation documentation`_. + Discussion ~~~~~~~~~~ @@ -49,7 +60,15 @@ We maintain a `cryptography-dev`_ mailing list for development discussion. You can also join ``#cryptography-dev`` on Freenode to ask questions or get involved. +Security +~~~~~~~~ + +Need to report a security issue? Please consult our `security reporting`_ +documentation. + .. _`documentation`: https://cryptography.io/ +.. _`the installation documentation`: https://cryptography.io/en/latest/installation/ .. _`issue tracker`: https://github.com/pyca/cryptography/issues .. _`cryptography-dev`: https://mail.python.org/mailman/listinfo/cryptography-dev +.. _`security reporting`: https://cryptography.io/en/latest/security/ |