Metadata-Version: 2.1
Name: pentesttools
Version: 0.0.4
Summary: Pentest-Tools.com Vulnerability Scanners Library
Author-email: The Pentest-Tools Team <contact@pentest-tools.com>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: coverage ; extra == 'dev'

# PTT-CLI

Command Line Interface for PentestTools.

# Installing
PentestTools Python module is delivered through PyPI, so it can be installed directly via pip:
```bash
pip install pentesttools
```

# Scanning
The `pentesttools` package provides a command line interface through the `ptt` utility. Right
now it supports the Website Scanner service.
```bash
ptt run website_scanner <url>
```

# Development installation
If you want to easily modify the sources and your modifications:
```bash
pip install --edit .
```

# Uninstalling

```bash
pip uninstall pentesttools
```

# Testing and Coverage
You can run the tests and make coverage reports like this:
```bash
python3 -m pytest src/tests
```

```bash
coverage run -m pytest src/tests
coverage report -m
```
