Metadata-Version: 2.1
Name: wadebug
Version: 0.1.5
Summary: Investigate issues with WhatsApp Business API setup.
Home-page: https://developers.facebook.com/docs/whatsapp/guides/wadebug
Author: Thiago Moraes
Author-email: tmoraes@fb.com
License: MIT
Description: # WhatsApp Business API Setup Debugger
        
        User Guide: https://developers.facebook.com/docs/whatsapp/guides/wadebug
        
        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
        support.
        
        # Usage
        
        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:
        ```
        $ wadebug
        ```
        
        To list all available options:
        ```
        $ wadebug ls
        ```
        
        To execute one specific check:
        ```
        $ wadebug partial check_mysql_version check_network
        ```
        
        JSON mode:
        ```
        $ wadebug --json
        ```
        
        # Installation
        
        ## For users:
        `$ pip3 install wadebug`
        
        ## For developers:
        
        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.
        
        1. Install tox on your system using pip `pip install tox`, you may need to run the command in `sudo`
        2. After installing tox, run `tox` in the root directory. Tests should run and pass.
        3. Run `source .tox/py3/bin/activate` to enable one of the virtualenvs. Dependencies will be installed automatically.
        4. Run `pip install --editable .` to enable `wadebug` in all directories that would reflect your changes.
        5. Run `wadebug` with environment variable `WADEBUG_DEV_MODE=True` to enable full stacktrace. The variable is set to False by default.
        
        
        # Testing
        
        To execute all unit tests, from project's root folder directory run:
        ```
        $ tox
        ```
        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)
        
        
        # Dependencies
        
        * This tool uses https://docker-py.readthedocs.io for interacting with Docker
        * It uses `click` to build the command-line interface
        
        More details can be found at `setup.py` file.
        
        # Architecture
        The module `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 `wadebug` architecture.
        
        Three sample actions can be seem on `wadebug/wa_actions/implementations/dummy_action.py` to understand how they are created.
        On `wadebug/wa_actions/implementations/check_webapp_port.py` the implementation of a real action can be found.
        
        ## License
        
        WADebug is [MIT licensed](./LICENSE).
        
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
