跳转到主要内容

Autocrypt邮件代理的支持工具和API

项目描述

muacrypt是一个支持工具,用于实现Autocrypt Level 1兼容的邮件代理。Autocrypt状态保存在一个或多个账户中,这些账户处理和生成来自各自收件箱和发件箱的autocrypt头。每个账户都与一组电子邮件地址相关联,指定为正则表达式。功能通过命令行工具muacrypt和通过import muacrypt获得的Python API公开。存在一个不断发展的插件架构,允许添加和修改muacrypt的行为。

此README的目的是帮助贡献者设置运行测试和使用命令行工具。有关项目的整体目标的更多文档可以在

https://muacrypt.readthedocs.io

找到。

测试

要使用代码和运行测试,您需要安装

  • 命令行客户端“gpg”,可选的“gpg2”,通过“gnupg”和“gnugp2”在debian上可用。

  • 用于加快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检出,我们强烈建议创建并激活一个python虚拟环境,然后在编辑模式下使用pip(无需sudo)

$ 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

项目详情


下载文件

下载您平台的文件。如果您不确定要选择哪个,请了解更多关于安装包的信息。

源分发

muacrypt-0.9.1.tar.gz (61.7 kB 查看哈希值)

上传时间

构建分发

muacrypt-0.9.1-py2.py3-none-any.whl (59.1 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面