path: root/python-wadebug.spec

%global _empty_manifest_terminate_build 0
Name:		python-wadebug
Version:	0.1.5
Release:	1
Summary:	Investigate issues with WhatsApp Business API setup.
License:	MIT
URL:		https://developers.facebook.com/docs/whatsapp/guides/wadebug
Source0:	https://mirrors.aliyun.com/pypi/web/packages/c5/66/74e1972f2957e6e87c5e0a2cf6bc5839d350eef54b8a31a9546dadcda2ec/wadebug-0.1.5.tar.gz
BuildArch:	noarch

Requires:	python3-click
Requires:	python3-docker
Requires:	python3-outdated
Requires:	python3-pydash
Requires:	python3-PyMySQL
Requires:	python3-pytest
Requires:	python3-pytest-cov
Requires:	python3-PyYAML
Requires:	python3-six
Requires:	python3-mock
Requires:	python3-enum34

%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).




%package -n python3-wadebug
Summary:	Investigate issues with WhatsApp Business API setup.
Provides:	python-wadebug
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-wadebug
# 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).




%package help
Summary:	Development documents and examples for wadebug
Provides:	python3-wadebug-doc
%description help
# 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).




%prep
%autosetup -n wadebug-0.1.5

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-wadebug -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.5-1
- Package Spec generated