Autocrypt 邮件代理的支持工具和 API
项目描述
muacrypt是一个支持工具，用于实现符合Autocrypt Level 1的邮件代理。自动加密状态保存在一个或多个帐户中，这些帐户处理和生成来自相应传入和传出电子邮件的自动加密标头。每个帐户都绑定到一组电子邮件地址，指定为正则表达式。功能通过命令行工具muacrypt和通过import muacrypt获得的 Python api 公开。有一个不断发展的插件架构，允许添加和修改 muacrypt 的行为。
本自述文件旨在帮助贡献者通过运行测试和使用命令行工具进行设置。在线文档位于
https://muacrypt.readthedocs.io
包含有关项目总体目标的更多文档。
测试
要使用代码并运行测试，您需要安装：
命令行客户端“gpg”，可选“gpg2”，可通过 debian 上的“gnupg”和“gnugp2”获得。
加快 gpg 密钥创建的方法，例如在 debian 上安装“rng-tools”。
python2.7 和 python3.5 包括头文件（debian 上的“python2.7-dev”和“python3.5-dev”）。
“tox” 运行自动化测试（Debian 上的“python-tox”）
在 Debian 上的一个安装命令中：
apt install gnupg2 rng-tools python2.7-dev python3.5-dev python-tox
之后，您可以运行所有测试：
$ tox
安装
您将需要命令行客户端“gpg”，可选的“gpg2”，可通过 debian 上的“gnupg”和“gnugp2”获得。
要安装 muacrypt 命令行工具，您可以将“muacrypt”python 包安装到您选择的虚拟环境中。如果您不了解 python 的虚拟环境，您可以只安装 debian 包“python-pip”，然后使用“pip”安装 muacrypt 库和命令行：
$ pip install --user muacrypt
muacrypt命令行工具将安装到 $HOME/.local/bin中，它需要在您的PATH中。
开发安装
如果您计划工作/修改源代码并进行 github checkout，我们强烈建议您创建并激活 python virtualenv，然后 在编辑模式下使用不带 sudo 的 pip：
$ virtualenv venv $ source venv/bin/activate $ pip install -e .
您随后对源所做的更改将可用，而无需再次安装 muacrypt 包。
运行命令行
安装后只需运行主命令：
muacrypt
查看可用的子命令和选项。首先初始化一个 Autocrypt 帐户，该帐户将维护自己的密钥环，并且不会干扰您可能现有的 gpg 默认密钥环：
$ muacrypt add-account
之后，您可以为电子邮件地址创建 Autocrypt 标头：
$ muacrypt make-header x@example.org
您可以通过将电子邮件消息传递到process-incoming子命令来处理和集成对等方的 Autocrypt 密钥：
$ muacrypt process-incoming <EMAIL_MESSAGE_FILE
您可以随时显示您的 muacrypt 帐户的状态：
$ muacrypt status
项目详情
维护者
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。