Metadata-Version: 2.4
Name: ptcommands
Version: 0.1.1
Summary: A command catalog extracted from penetration-testing course PDFs.
Author: Amin Baash
License: MIT
Keywords: nmap,penetration-testing,security,commands
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# ptcommands

A small Python library and CLI for the command catalog extracted from the uploaded penetration-testing course PDFs.

> Safety note: this library only stores and displays commands. It does not run Nmap. Only run scanning commands on systems you own or have permission to test.

## Install locally

```bash
cd ptcommands_lib
python -m pip install -e .
```

## Use as a library

```python
from ptcommands import COMMANDS, filter_commands

for item in filter_commands(COMMANDS, section="Section 7", category="nmap", search="ports"):
    print(item.command, "=>", item.usage)
```

## Use as a command-line tool

```bash
ptcommands
ptcommands --category nmap
ptcommands --section "Section 7" --search ports
ptcommands --markdown > COMMANDS.md
```

## Build a distributable package

```bash
python -m pip install build
python -m build
```

The generated package files will be in `dist/`.
