Investigate issues with WhatsApp Business API setup.
WhatsApp Business API Setup Debugger
WADebug is a command-line tool to help find any potential issues with WhatsApp Business API setup, and to make requesting for help from WhatsApp support more effective.
To run, simply type
wadebug on command-ine and check the diagnostic.
It will guide on some problems and provide guidance if you need additional
To retrieve and save logs under wadebug_logs/ in the current directory:
$ wadebug logs
To retrieve logs and send them to Facebook for troubleshooting:
$ wadebug logs --send
[New since v0.1.5] To retrieve logs starting from a particular date time (GMT timezone), e.g.:
$ wadebug logs --since='2020-01-07 3:00:02'
To execute all checks:
To list all available options:
$ wadebug ls
To execute one specific check:
$ wadebug partial check_mysql_version check_network
$ wadebug --json
$ pip3 install wadebug
This tool uses
tox to test in Python 3.
tox will create
virtual environments to run tests. Install tox on your system's Python.
All other dependencies with go into virtualenvs.
- Install tox on your system using pip
pip install tox, you may need to run the command in
- After installing tox, run
toxin the root directory. Tests should run and pass.
source .tox/py3/bin/activateto enable one of the virtualenvs. Dependencies will be installed automatically.
pip install --editable .to enable
wadebugin all directories that would reflect your changes.
wadebugwith environment variable
WADEBUG_DEV_MODE=Trueto enable full stacktrace. The variable is set to False by default.
To execute all unit tests, from project's root folder directory run:
Warning: do NOT run
tox from a virtualenv as it will fail.
tox will run tests in Python 3 and run flake8 linter.
To run tests in Python 3 for faster feedback, run either
$ pytest from within the virtualenv or
$ tox -epy3 out of it.
To run tests in a particular module:
source .tox/py3/bin/activate # to enable virtualenv on Bash $ pytest wadebug/wa_actions/tests/test_check_webapp_port.py -v
-v turns on verbose mode, which shows every test case in the module)
- This tool uses https://docker-py.readthedocs.io for interacting with Docker
- It uses
clickto build the command-line interface
More details can be found at
wa_actions.implementations is the heart of the tool. Each action
is a Python class with one static method called
_run. This method describes the
action to perform.
The idea is that a developer can implement a new
action to investigate a
potential problem with the deployment without knowing anything about
Three sample actions can be seem on
wadebug/wa_actions/implementations/dummy_action.py to understand how they are created.
wadebug/wa_actions/implementations/check_webapp_port.py the implementation of a real action can be found.
WADebug is MIT licensed.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for wadebug-0.1.5-py2.py3-none-any.whl