Skip to main content

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 if you can. 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 specifying an email message filename:

$ autocrypt process-incoming EMAIL_MESSAGE_FILE

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

$ autocrypt show

Download files

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

Source Distribution

autocrypt-0.3.0.tar.gz (41.2 kB view details)

Uploaded Source

File details

Details for the file autocrypt-0.3.0.tar.gz.

File metadata

  • Download URL: autocrypt-0.3.0.tar.gz
  • Upload date:
  • Size: 41.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for autocrypt-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fc45fff0b66cd8118887d04a75c7eba82b29567eaf78b80b3e4d57f164eeb3b9
MD5 d87b75810060610c6b08533a2a6ee885
BLAKE2b-256 2e2c9164f4cb36c91174025349329765ca5bf653dd6bd131eea2df182951201f

See more details on using hashes here.

Release history Release notifications | RSS feed

0.7.3

1 file

0.7.2

1 file

0.7.1

1 file

0.7.0

1 file

This release

0.3.0 This release

1 file

0.2

0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page