{ "info": { "author": "holger krekel and the muacrypt team", "author_email": "holger@merlinux.eu", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX", "Programming Language :: Python", "Topic :: Utilities" ], "description": "muacrypt: Autocrypt encryption for mail agents\n==============================================\n\n``muacrypt`` is a support tool for implementing `Autocrypt Level 1\n`_ compliant mail agents.\nAutocrypt state is kept in one or more accounts which process and produce\nautocrypt headers from respective incoming and outgoing e-mail. Each account is\ntied to a set of e-mail addresses, specified as a regular expression.\nFunctionality is exposed through a command line tool ``muacrypt`` and a\nPython api obtained through ``import muacrypt``. There is an evolving plugin\narchitecture which allows to add and modify behaviour of muacrypt.\n\nThis README is intended to help contributors to get setup with running\ntests and using the command line tool. The online docs at\n\nhttps://muacrypt.readthedocs.io\n\ncontain more documentation about overall goals of the project.\n\ntesting\n-------\n\nTo use the code and run tests you need to have installed:\n\n- the command line client \"gpg\", optionally \"gpg2\",\n available through \"gnupg\" and \"gnugp2\" on debian.\n\n- something to speed up gpg key creation, e.g.\n by installing \"rng-tools\" on debian.\n\n- python2.7 and python3.5 including headers\n (\"python2.7-dev\" and \"python3.5-dev\" on debian).\n\n- \"tox\" to run automated tests (\"python-tox\" on Debian)\n\nIn one installation command on Debian::\n\n apt install gnupg2 rng-tools python2.7-dev python3.5-dev python-tox\n\nAfterwards you can run all tests::\n\n $ tox\n\n\ninstallation\n------------\n\nYou'll need the command line client \"gpg\", optionally \"gpg2\",\navailable through \"gnupg\" and \"gnugp2\" on debian.\n\nTo install the muacrypt command line tool you can install\nthe \"muacrypt\" python package into your virtual environment\nof choice. If you don't know about python's virtual environments\nyou may just install the debian package \"python-pip\" and then\nuse \"pip\" to install the muacrypt library and command line too::\n\n $ pip install --user muacrypt\n\nThe ``muacrypt`` command line tool will be installed into\n``$HOME/.local/bin`` which needs to be in your ``PATH``.\n\ninstallation for development\n++++++++++++++++++++++++++++\n\nIf you plan to work/modify the sources and have\na github checkout we strongly recommend to create\nand activate a python virtualenv and then once use\n**pip without sudo in edit mode**::\n\n $ virtualenv venv\n $ source venv/bin/activate\n $ pip install -e .\n\nChanges you subsequently make to the sources will be\navailable without further installing the muacrypt\npackage again.\n\n\nrunning the command line\n++++++++++++++++++++++++\n\nAfter installation simply run the main command::\n\n muacrypt\n\nto see available sub commands and options. Start by\ninitializing an Autocrypt account which will maintain\nits own keyring and not interfere with your possibly\nexisting gpg default keyring::\n\n $ muacrypt add-account\n\nAfterwards you can create an Autocrypt header\nfor an email address::\n\n $ muacrypt make-header x@example.org\n\nYou can process and integrate peer's Autocrypt\nkeys by piping an email message into the ``process-incoming`` subcommand::\n\n $ muacrypt process-incoming