Metadata-Version: 2.3
Name: pwndocapi
Version: 1.3.4
Summary: Python API client for PwnDoc
License: MIT
Author: Syslifters
Requires-Python: >=3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
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: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: pydantic (>=1.8.0)
Requires-Dist: requests (>=2.25.0)
Description-Content-Type: text/markdown

![](./.github/banner.png)

<p align="center">
    A python library to interact with Pwndoc instances for pentest reports generation.
    <br>
    <img alt="PyPI" src="https://img.shields.io/pypi/v/pwndocapi">
    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/p0dalirius/pwndocapi">
    <img alt="Python pip build" src="https://github.com/p0dalirius/pwndocapi/actions/workflows/python-pip-build.yml/badge.svg">
    <a href="https://twitter.com/intent/follow?screen_name=podalirius_" title="Follow"><img src="https://img.shields.io/twitter/follow/podalirius_?label=Podalirius&style=social"></a>
    <a href="https://www.youtube.com/c/Podalirius_?sub_confirmation=1" title="Subscribe"><img alt="YouTube Channel Subscribers" src="https://img.shields.io/youtube/channel/subscribers/UCF_x5O7CSfr82AfNVTKOv_A?style=social"></a>
    <br>
</p>

## Features
- [x] Connect to a remote pwndoc instance.
- [x] Manages the audits (create, delete, list audits).
- [x] Add new findings to your audit.

## Examples of usage

### Create a new audit

```py
import pwndocapi

p = pwndocapi.pwndoc("192.168.1.19", 8443, verbose=True)
p.login("username", "password")
# Create a new audit
audit = p.audits.create("PoC Audit", "fr", "TI Externe")
print("audit:", audit)
```

## Contributing

Pull requests are welcome. Feel free to open an issue if you want to add other features.

