用于ThreeMA网关服务发送和接收消息(包括文本、图像、文件和传递报告)的API。
threema.gatewa的Python项目详细描述
threema gateway是用于threema网关服务的python 3模块。 此api可用于向任何3ma发送和接收文本消息 用户。
注
在python 3不是默认python运行时的计算机上,应该 使用pip3而不是pip。
先决条件
$ sudo apt-get install python3 python3-pip
我们建议使用venv创建一个独立的python环境:
$ pyvenv venv
您可以通过运行 此命令:
$ source venv/bin/activate
当虚拟环境处于活动状态时,使用 pip将安装到此环境中。
要停用虚拟环境,只需运行:
$ deactivate
如果你想更轻松地处理你的虚拟机,你也可以 看看virtualenvwrapper。
安装
如果您使用的是虚拟环境,请先激活它。
运行以下命令安装模块:
$ pip install threema.gateway
依赖项libnacl将自动安装。但是,你 可能需要安装libsodium才能使libnacl工作。
命令行用法
脚本threema-gateway为 三马之门。运行以下命令查看用法信息:
$ threema-gateway --help
功能级别
Level | Text | Capabilities | Image | File | Credits |
---|---|---|---|---|---|
1 | X | ||||
2 | X | X | X | X | |
3 | X | X | X | X | X |
您可以通过调用下面的 命令:
$ threema-gateway version
回调服务器
回调服务器可用于接收消息。演示脚本 threema-callback-server在命令上打印接收到的消息 行。运行以下命令查看用法信息。
$ threema-callback-server --help
脚本位于here。
贡献
如果你想参与这个项目,你应该安装 可编辑环境中项目的可选dev要求:
$ git clone https://github.com/lgrahl/threema-msgapi-sdk-python.git $ cd threema-msgapi-sdk-python $ pip install -e .[dev]
在创建拉取请求之前,建议运行以下命令 用于检查代码样式冲突(flake8)的命令,优化 导入(isort)并运行项目的测试:
$ flake8 . $ isort -rc . $ py.test
您还应该运行类型检查程序,它可能会捕获一些其他错误:
$ mypy .
报告安全问题
请直接向下列一个或两个报告安全问题 联系人:
- 丹尼洛·巴根
- 电子邮件:mail@dbrgn.ch
- 3MA:EBEP4UCA
- gpg:EA456E8BAF0109429583EED83578F667F2F3A5FA
- 伦纳特格拉尔
- 电子邮件:lennart.grahl@gmail.com
- 3MA:msfvew6c
- gpg:3FDB14868A2B36D638F3C495F98FBED10482ABA6