Metadata-Version: 2.1
Name: whad
Version: 1.2.1
Summary: Wireless protocols hacking framework
Author: Damien CAUQUIL, Romain CAYRE
Author-email: 'dcauquil@quarkslab.com, rcayre@laas.fr'
License: Apache
Project-URL: Homepage, https://github.com/whad-team/whad-client
Project-URL: Documentation, https://whad.readthedocs.io/en/stable/
Project-URL: Issues, https://github.com/whad-team/whad-client/issues
Platform: unix
Platform: linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Requires-Python: <4,>=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: protobuf==3.20.*
Requires-Dist: scapy==2.5.0rc3
Requires-Dist: elementpath==2.4.0
Requires-Dist: pyserial==3.5.0
Requires-Dist: pycryptodomex==3.11.0
Requires-Dist: pyusb==1.2.1
Requires-Dist: cryptography==36.0.0
Requires-Dist: prompt_toolkit==3.0.43
Requires-Dist: hexdump==3.3
Requires-Dist: pynput==1.7.7
Requires-Dist: Sphinx>=5.3.0
Requires-Dist: sphinx-rtd-theme==2.0.0
Requires-Dist: sphinxcontrib-mermaid==0.9.2
Requires-Dist: requests==2.27.1
Requires-Dist: distro==1.6.0

# WHAD: Wireless HAcking Devices

[![Tests](https://github.com/virtualabs/whad-client/actions/workflows/tests.yml/badge.svg)](https://github.com/virtualabs/whad-client/actions/workflows/tests.yml)

This framework provides a set of command-line tools to play with/hack/explore
wireless protocols and devices as well as a library to create powerful wireless
tools to use with hardware devices running a compatible firmware.

## Installation

Installation is pretty straightforward with ``pip``:

```
pip install whad
```

## Online documentation

Project documentation is [available on ReadTheDocs](https://whad.readthedocs.io/en/stable/).

## Running unit tests

You can run unit tests locally for the default python version using:
```
pytest
```

You can run unit tests for every supported python version using:
```
tox
```

(Obviously, you need to install python interpreter from 3.6 to 3.10 included to run tox).
The tests are automatically run by github actions when something is pushed to main branch or when a pull request is merged.
