67 lines
1.9 KiB
ReStructuredText
67 lines
1.9 KiB
ReStructuredText
PGPy: Pretty Good Privacy for Python
|
|
====================================
|
|
|
|
.. image:: https://badge.fury.io/py/PGPy.svg
|
|
:target: https://badge.fury.io/py/PGPy
|
|
:alt: Latest stable version
|
|
|
|
.. image:: https://travis-ci.com/SecurityInnovation/PGPy.svg?branch=master
|
|
:target: https://travis-ci.com/SecurityInnovation/PGPy?branch=master
|
|
:alt: Travis-CI
|
|
|
|
.. image:: https://coveralls.io/repos/github/SecurityInnovation/PGPy/badge.svg?branch=master
|
|
:target: https://coveralls.io/github/SecurityInnovation/PGPy?branch=master
|
|
:alt: Coveralls
|
|
|
|
.. image:: https://readthedocs.org/projects/pgpy/badge/?version=latest
|
|
:target: https://pgpy.readthedocs.io/en/latest/?badge=latest
|
|
:alt: Documentation Status
|
|
|
|
`PGPy` is a Python library for implementing Pretty Good Privacy into Python programs, conforming to the OpenPGP specification per RFC 4880.
|
|
|
|
Features
|
|
--------
|
|
|
|
Currently, PGPy can load keys and signatures of all kinds in both ASCII armored and binary formats.
|
|
|
|
It can create and verify RSA, DSA, and ECDSA signatures, at the moment. It can also encrypt and decrypt messages using RSA and ECDH.
|
|
|
|
Installation
|
|
------------
|
|
|
|
To install PGPy, simply:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install PGPy
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
`PGPy Documentation <https://pgpy.readthedocs.io/en/latest/>`_ on Read the Docs
|
|
|
|
Discussion
|
|
----------
|
|
|
|
Please report any bugs found on the `issue tracker <https://github.com/SecurityInnovation/PGPy/issues>`_
|
|
|
|
You can also join ``#pgpy`` on Freenode to ask questions or get involved
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- Python >= 3.5
|
|
|
|
Tested with: 3.8, 3.7, 3.6, 3.5
|
|
|
|
- `Cryptography <https://pypi.python.org/pypi/cryptography>`_
|
|
|
|
- `pyasn1 <https://pypi.python.org/pypi/pyasn1/>`_
|
|
|
|
- `six <https://pypi.python.org/pypi/six>`_
|
|
|
|
License
|
|
-------
|
|
|
|
BSD 3-Clause licensed. See the bundled `LICENSE <https://github.com/SecurityInnovation/PGPy/blob/master/LICENSE>`_ file for more details.
|