Metadata-Version: 2.3
Name: stoobly-agent
Version: 1.1.1
Summary: Record, mock, and test HTTP(s) requests. CLI agent for Stoobly
License: Apache-2.0
Author: Matt Le
Author-email: themathewle@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
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: click (>=8.1.0,<9.0.0)
Requires-Dist: diff-match-patch (>=v20241021,<20241022)
Requires-Dist: distro (>=1.9.0,<1.10)
Requires-Dist: dnspython (>=2.7.0,<2.8)
Requires-Dist: docker (>=7.1.0,<8.0)
Requires-Dist: httptools (>=0.4.0)
Requires-Dist: jmespath (>=1.0.0)
Requires-Dist: mergedeep (>=1.3,<1.4)
Requires-Dist: mitmproxy (>=11.0.2,<11.1.0)
Requires-Dist: multipart (>=1.2.1,<1.3)
Requires-Dist: openapi-core (>=0.19.0,<0.20.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: pyyaml (>=6.0.1)
Requires-Dist: requests (>=2.31.0)
Requires-Dist: stoobly_orator (>=0.9.12)
Requires-Dist: tabulate (>=0.8.8)
Requires-Dist: watchdog (>=6.0.0,<=6.1.0)
Requires-Dist: yamale (>=6.0.0,<=7.0.0)
Project-URL: Homepage, https://github.com/Stoobly/stoobly-agent
Description-Content-Type: text/markdown

# Stoobly Agent

[![Release Version](https://img.shields.io/github/v/release/Stoobly/stoobly-agent)](https://github.com/Stoobly/stoobly-agent/releases/latest)
![PyPI](https://img.shields.io/pypi/v/stoobly-agent?color=green)

[![CI](https://github.com/Stoobly/stoobly-agent/actions/workflows/tests.yaml/badge.svg)](https://github.com/Stoobly/stoobly-agent/actions/workflows/tests.yaml)
[![CodeQL](https://github.com/Stoobly/stoobly-agent/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Stoobly/stoobly-agent/actions/workflows/github-code-scanning/codeql)


🌐 Stoobly is a feature-rich man-in-the-middle proxy tool to **record and mock HTTP/HTTPS requests and responses.**

🚀 Easily create scalable API mocks with little setup time. 

⚡ Maintaining hard-coded inputs and responses is expensive. De-clutter your codebase and **streamline maintenance with replay and record.**

💡 Upon request interception, mocking is configurable to match against all request components.

🔨 Need advanced configuration? Take advantage of features like scenarios, filters, rewriting, match rules, and lifecycle hooks.

See our docs for more detailed information! https://docs.stoobly.com

## Prerequisite

- Python 3.10, 3.11, 3.12

## Installation

To install [see our guides here](https://docs.stoobly.com/getting-started/install-and-run)

## Usage

### Run with both UI and proxy

```
stoobly-agent run
```

### Run with just proxy

```
stoobly-agent run --headless
```

### See available options

```
stoobly-agent --help
```

## Next steps

Configure the proxy settings by [following this guide](https://docs.stoobly.com/getting-started/proxy-configuration)

Start easily recording requests [with this guide](https://docs.stoobly.com/getting-started/record-requests)

Then, try mocking your requests [with this guide!](https://docs.stoobly.com/guides/mocking-apis)


## Having trouble?

File a new [Github issue here](https://github.com/Stoobly/stoobly-agent/issues) and we'll take a look

