Metadata-Version: 2.4
Name: pubstomp
Version: 0.1.1
Summary: Advanced async pentesting toolkit with crawling, fuzzing, and reporting
Author-email: Nolan Coe <nolancoe@proton.me>
License: MIT License
        
        Copyright (c) 2025 Nolan Coe
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp
Requires-Dist: beautifulsoup4
Requires-Dist: colorama
Requires-Dist: tqdm
Requires-Dist: validators
Dynamic: license-file

# README.md

# PubStomp

**PubStomp** is an advanced asynchronous pentesting toolkit designed for efficient reconnaissance, vulnerability fuzzing, and reporting against web applications.

## Features
-  Async web crawling and spidering
-  Custom wordlists for fuzzing endpoints
-  Optional XSS payload testing
- 離 Report generation to JSON
-  Colored terminal output with progress bars
-  Configurable output and log file paths

## Installation
Install via pip from source:

```bash
pip install .
```

Or once published:
```bash
pip install pubstomp
```

> ⚠️ If the `pubstomp` command is not found after install, it's likely because `~/.local/bin` is not in your `$PATH`.
> 
> You can fix this by adding the following line to your shell config (e.g., `~/.bashrc`, `~/.zshrc`):
>
> ```bash
> export PATH="$HOME/.local/bin:$PATH"
> ```
>
> Then reload it with:
>
> ```bash
> source ~/.bashrc  # or source ~/.zshrc
> ```
>
> Alternatively, you can create a system-wide symlink:
>
> ```bash
> sudo ln -s ~/.local/bin/pubstomp /usr/local/bin/pubstomp
> ```

## Usage
Set your output and log paths:

```bash
pubstomp --setoutput ~/targets
pubstomp --setlog ~/logs/pubstomp.log
```

Run a scan:
```bash
pubstomp example.com --depth 2 --xss --report
```

Check saved paths:
```bash
pubstomp --showoutput
pubstomp --showlog
```

## CLI Options
```bash
pubstomp -h
```
Prints all command-line options.

## License
This project is licensed under the MIT License.
