Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Autocrypt: E-mail Encryption for Everyone example implementation

Project Description

this tool is under heavy development, use at your own risk

The Python Autocrypt implementation offers a command line tool and API. This README is intended to help contributors to get setup with running tests and using the code and “autocrypt” command line. There also are online docs at https://py-autocrypt.readthedocs.io which contain more documentation.

testing

To use the code and run tests you need to have installed:

  • the command line client “gpg”, optionally “gpg2”, available through “gnupg” and “gnugp2” on debian.
  • something to speed up gpg key creation, e.g. by installing “rng-tools” on debian.
  • python2.7 and python3.5 including headers (“python2.7-dev” and “python3.5-dev” on debian). If python3.5 is not present tests for it will be skipped.
  • tox either installed via “pip install tox” or via the “python-tox” debian package.

If this is all there simply issue:

tox

to run all the tests against the autocrypt classes and the command line.

installation

You’ll need the command line client “gpg”, optionally “gpg2”, available through “gnupg” and “gnugp2” on debian.

To install the autocrypt command line tool you can install the “autocrypt” python package into your virtual environment of choice. If you don’t know about python’s virtual environments you may just install the debian package “python-pip” and then use “pip” to install the autocrypt library and command line too:

$ sudo pip install autocrypt

This will install the required dependency “click”, a python framework for writing command line clients.

installation for development

If you plan to work/modify the sources and have a github checkout we strongly recommend to create and activate a python virtualenv and then once use pip without sudo in edit mode:

$ virtualenv venv
$ source venv/bin/activate
$ pip install -e .

Changes you subsequently make to the sources will be available without further installing the autocrypt package again.

running the command line

After _installation simply run the main command:

autocrypt

to see available sub commands and options. Start by initializing an Autocrypt account which will maintain its own keyring and not interfere with your possibly existing gpg default keyring:

$ autocrypt init

Afterwards you can create an autocrypt header for an email address:

$ autocrypt make-header x@example.org

You can process and integrate peer’s Autocrypt keys by piping an email message into the process-incoming subcommand:

$ autocrypt process-incoming <EMAIL_MESSAGE_FILE

At any point you can show the status of your autocrypt account:

$ autocrypt show
Release History

Release History

This version
History Node

0.7.0

History Node

0.3.0

History Node

0.2

History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
autocrypt-0.7.0.tar.gz (49.0 kB) Copy SHA256 Checksum SHA256 Source Jun 26, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting