调查WhatsApp业务API设置的问题。
wadebug的Python项目详细描述
WhatsApp Business API设置调试器
用户指南:https://developers.facebook.com/docs/whatsapp/guides/wadebug
wadebug是一个命令行工具,可以帮助查找whatsapp的任何潜在问题 业务api设置,并使请求whatsapp支持的帮助更加有效。
要运行,只需在命令行中键入wadebug
,然后检查诊断。
它将指导一些问题,如果您需要更多
支持。
用法
要执行所有操作:
$ wadebug
执行一个特定动作
$ wadebug partial check_network
安装
对于用户:
$ pip3 install wadebug
对于开发人员:
这个工具使用tox
来测试python 2.7和3.6。tox
将创建
虚拟环境来运行这两个的测试。在系统的python上安装tox。
所有其他的依赖进入virtualenvs。
- 使用pip
pip install tox
在系统上安装tox,您可能需要在sudo
中运行命令 - 安装tox后,在根目录中运行
tox
。测试应该运行并通过。 - 运行
source .tox/py3/bin/activate
以启用其中一个virtualenv。依赖项将自动安装。 - 运行
pip install --editable .
以在所有反映更改的目录中启用wadebug
。 - 使用环境变量
WADEBUG_DEV_MODE=True
运行wadebug
,以启用完整stacktrace。默认情况下,变量设置为false。
测试
要执行所有单元测试,请从项目的根文件夹目录运行:
$ tox
警告:不要从virtualenv运行tox
,因为它将失败。
tox
将在python 2和3中运行测试。
要在python 3中运行测试以获得更快的反馈,可以从virtualenv中运行$ pytest
,也可以从virtualenv中运行$ tox -epy3
。
要在特定模块中运行测试:
source .tox/py3/bin/activate # to enable virtualenv on Bash $ pytest wadebug/wa_actions/tests/test_check_webapp_port.py -v
(-v
打开详细模式,显示模块中的每个测试用例)
依赖关系
- 此工具使用https://docker-py.readthedocs.io与Docker进行交互
- 它使用
click
来构建命令行界面
更多详细信息可以在setup.py
文件中找到。
架构
模块wa_actions.implementations
是工具的核心。每一个动作
是一个python类,有一个名为_run
的静态方法。此方法描述
要执行的操作。
其思想是开发人员可以实现一个新的action
来调查
在不了解wadebug
体系结构的情况下部署可能会出现问题。
可以在wadebug/wa_actions/implementations/dummy_action.py
上显示三个示例操作,以了解它们是如何创建的。
在wadebug/wa_actions/implementations/check_webapp_port.py
上可以找到实际操作的实现。
许可证
瓦德布是MIT licensed。