Commit 6dcb2465 authored by sand's avatar sand

update README

parent 810ea264
Pipeline #2362 passed with stage
in 35 seconds
......@@ -4,11 +4,25 @@ pgp-mime-lib
Simple Python package to send
[PGP/MIME](https://www.ietf.org/rfc/rfc3156.txt) multipart/encrypted
and multipart/signed emails. Uses the
[python-gnupg](https://gnupg.readthedocs.io/en/latest/) Python module to talk to
gpg.
[pgpy](https://github.com/SecurityInnovation/PGPy) Python module that
implements the OpenPGP protocol.
The package is agnostic with respect to key management: recipients'
public keys are not permanently stored in a keyring, but are passed
along with each message by the caller.
Python compatibility: 2.7 / 3.5+
## Running SMTP tests
To have the test suite send you a signed and encrypted email, set up the following environment
variables before running the tests:
- `SMTP_SERVER`
- `SMTP_USER`
- `SMTP_PASSWORD`
- `SMTP_RECIPIENT`
- `SMTP_PUBLIC_KEY` (a PGP public key file)
In `tox.ini` you can use [setenv](https://tox.readthedocs.io/en/latest/config.html#conf-setenv) or
[passenv](https://tox.readthedocs.io/en/latest/config.html#conf-passenv).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment