overload-cli 0.1.0__py3-none-any.whl

overload_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,267 @@
+Metadata-Version: 2.4
+Name: overload-cli
+Version: 0.1.0
+Summary: Free load testing tool that reads Postman collections — browser UI + CLI
+Project-URL: Homepage, https://github.com/dprakash2101/overload
+Project-URL: Repository, https://github.com/dprakash2101/overload
+Project-URL: Issues, https://github.com/dprakash2101/overload/issues
+Project-URL: Documentation, https://dprakash2101.github.io/overload/
+Project-URL: Changelog, https://github.com/dprakash2101/overload/blob/main/CHANGELOG.md
+Author: Devi Prakash
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-testing,assertions,ci-cd,load-testing,performance,postman,stress-test
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT 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
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: uvicorn[standard]>=0.20.0
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Overload
+
+Free, open-source load testing tool that reads Postman collections. Run tests from a browser dashboard or the terminal CLI.
+
+**📚 [Read the Full Documentation](https://dprakash2101.github.io/overload/)**
+
+---
+
+## Install
+
+```bash
+pip install overload-cli
+```
+
+Or in dev mode from source:
+
+```bash
+git clone https://github.com/dprakash2101/overload
+cd overload
+pip install -e ".[dev]"
+```
+
+---
+
+## Two Ways to Run
+
+### Option 1 — Browser UI (results on screen)
+
+Run `overload` with no arguments. It starts a local server and opens a dashboard in your browser where you configure the test, watch live progress, and view charts and reports — **no terminal reading required**.
+
+```bash
+overload
+# Opens http://localhost:3000 automatically
+```
+
+**Step-by-step in the browser:**
+
+1. The app auto-detects any Postman collection JSON files in your working directory and lists them under **"Detected Files"**. Click **Load** next to the one you want.
+2. Optionally load a Postman environment file the same way.
+3. Pick the **Test Type** from the dropdown (Burst, Load, Stress, Spike, etc.).
+4. Adjust the config fields that appear (concurrency, RPS, duration, etc.).
+5. Click **Start Test**. The dashboard shows live progress: phase, request count, RPS, and a real-time latency chart.
+6. When the test finishes, click **View Report** to open the full HTML report in a new tab — latency charts, timeline scatter, per-second breakdown, and the raw request log.
+7. Click **Stop** at any time to cancel immediately with partial results saved.
+
+**Options:**
+
+```bash
+overload ui --port 8080          # Use a different port
+overload ui --no-browser         # Start server without auto-opening browser
+overload ui --host 0.0.0.0       # Bind to all interfaces (LAN access)
+```
+
+---
+
+### Option 2 — CLI (results in terminal)
+
+Run tests headlessly and see a progress bar + summary printed to the terminal. An HTML report is saved to disk.
+
+```bash
+overload run --collection path/to/collection.json --pattern burst
+```
+
+**Output looks like:**
+
+```
+  OVERLOAD — BURST TEST
+  Collection: my_api.json
+  Requests: 5
+  Run ID: burst_20260529_abc123
+
+  [####################] 100% (200 requests) — complete
+
+  Results:
+    Total: 200  OK: 198  Errors: 2
+    Latency — min: 45ms  p95: 312ms  max: 891ms
+    Duration: 4.2s  Avg RPS: 47.6
+
+  Report: /path/to/overload_report_20260529_abc123.html
+```
+
+**All CLI flags for `overload run`:**
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--collection` | *(required)* | Path to Postman collection JSON |
+| `--environment` | — | Path to Postman environment JSON |
+| `--pattern` | `burst` | Test type: `load`, `stress`, `spike`, `soak`, `ramp`, `burst`, `breakpoint`, `custom`, `ratelimit` |
+| `--requests` | `200` | Total requests (burst / rate limit tests) |
+| `--concurrency` | `20` | Max simultaneous connections |
+| `--rps` | `50` | Target requests per second |
+| `--duration` | `300` | Test duration in seconds |
+| `--timeout` | `30` | Per-request timeout in seconds |
+| `--stages` | — | Custom stages JSON: `'[{"duration":60,"rps":100}]'` |
+| `--var KEY=VALUE` | — | Override a collection variable (repeatable) |
+| `--save-responses` | off | Save response bodies in the report |
+| `--no-verify-ssl` | off | Skip SSL certificate verification |
+| `--output` | `reports` | Directory to write the HTML report |
+| `--format` | `html` | Report format: `html`, `json`, `csv` |
+| `--assert EXPR` | — | Assertion threshold (repeatable), e.g. `p95_latency_ms<500` |
+| `--junit PATH` | — | Write JUnit XML report for CI systems |
+| `--config PATH` | — | Load config from `overload.config.yaml` |
+| `--open-report` | off | Open HTML report in browser after run |
+
+**Sequential runner (run requests in order):**
+
+```bash
+overload sequential --collection my_api.json --iterations 5 --delay 500
+```
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--collection` | *(required)* | Path to Postman collection JSON |
+| `--environment` | — | Path to Postman environment JSON |
+| `--iterations` | `1` | How many times to run the full collection |
+| `--delay` | `0` | Milliseconds to wait between requests |
+| `--timeout` | `30` | Per-request timeout in seconds |
+| `--output` | `.` | Directory to write the HTML report |
+
+---
+
+## Test Types
+
+| Type | What it does |
+|------|-------------|
+| **Burst** | Fires all N requests at once as fast as possible |
+| **Load** | Sustained traffic — ramp up → hold at target RPS → ramp down |
+| **Stress** | Steps up RPS until errors exceed the failure threshold |
+| **Spike** | Baseline RPS → sudden spike → recovery, to test elasticity |
+| **Soak** | Steady low RPS over a long duration (find memory leaks / drift) |
+| **Ramp** | Linearly increases from start RPS to end RPS |
+| **Breakpoint** | Binary search to find the exact RPS where latency or errors degrade |
+| **Custom** | Define your own stages: `[{"duration": 60, "rps": 100}, ...]` |
+| **Rate Limit** | Verifies that the API enforces its rate limit correctly |
+| **Sequential** | Runs each request in collection order, N iterations |
+
+---
+
+## CI/CD Integration
+
+Overload can gate your CI pipeline. Add assertions and the process exits `1` on failure — the universal CI signal.
+
+**Inline assertions:**
+
+```bash
+overload run --collection api.json --pattern load --rps 100 --duration 60 \
+  --assert "p95_latency_ms<500" \
+  --assert "error_rate_pct<1" \
+  --junit results.xml
+```
+
+**Using a config file:**
+
+Save your test config with assertions to `overload.config.yaml` (the browser UI can do this via **Save Config**):
+
+```yaml
+test_type: load
+config:
+  target_rps: 100
+  hold_duration_seconds: 60
+  concurrency: 20
+thresholds:
+  - metric: p95_latency_ms
+    operator: "<"
+    value: 500
+  - metric: error_rate_pct
+    operator: "<"
+    value: 1
+```
+
+Then in CI:
+
+```bash
+overload run --collection api.json --config overload.config.yaml --junit results.xml
+```
+
+**GitHub Actions example:**
+
+```yaml
+- name: Run load test
+  run: |
+    pip install overload-cli
+    overload run --collection tests/api.json \
+      --config overload.config.yaml \
+      --junit results.xml
+
+- name: Publish test results
+  uses: dorny/test-reporter@v1
+  if: always()
+  with:
+    name: Load Test
+    path: results.xml
+    reporter: java-junit
+```
+
+**Available assertion metrics:** `p50_latency_ms`, `p95_latency_ms`, `p99_latency_ms`, `max_latency_ms`, `mean_latency_ms`, `error_rate_pct`, `success_rate_pct`, `avg_rps`, `total_requests`, `rate_limited_count`
+
+**Operators:** `<`, `<=`, `>`, `>=`, `==`
+
+---
+
+## Quick Reference
+
+```
+# See results in browser (recommended)
+overload
+
+# See results in terminal
+overload run --collection my_api.json --pattern burst --requests 100
+
+# Debug mode (verbose logging)
+overload --debug
+# or
+OVERLOAD_DEBUG=1 overload
+```
+
+---
+
+## Working Directory
+
+When you launch `overload` from a directory that contains Postman JSON files, the UI auto-detects and lists them. Start from your project folder:
+
+```bash
+cd path/to/my-api-tests/
+overload
+```
+
+The HTML report is also saved to the working directory after each test.

overload_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+overload/__init__.py,sha256=C52JK4KMjf9MnPZNJ_yYBD0f49c1qgMV5818fiDNO7Y,58
+overload/__main__.py,sha256=0k15wwwnGTPqVP2hHL3TpawUo1tJ9nkkZVBgaikDTog,74
+overload/cli.py,sha256=6CfuV41Xl4D_ZCxx8l66AikpfD4X2CFxAmIHUIwjpXY,15140
+overload/config_file.py,sha256=dnE_FoJrf-jo1wPTL8ca1Xf6mz5O-5uhbSetd91fjXo,1831
+overload/collection/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+overload/collection/environment.py,sha256=Z-Z-v8T4w0uc51V89QKTKJET8_a9PC-swB0xCqGFsE4,640
+overload/collection/models.py,sha256=WVcPGUpCcYGCoJTTGUcwHOrlVyiCwWdaHLVDlDX2D9k,2265
+overload/collection/parser.py,sha256=D-Jewn7sJ9Q-iD2j-yczZ3Ww-S_sbgQT3qUdUrB1T7A,6370
+overload/collection/variables.py,sha256=_bZrxSIachcOTnf1W1Vl6hWZ5mM4JwHifxXeoxL98Lk,2714
+overload/engine/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+overload/engine/assertions.py,sha256=FL7Hp_vsmPC7wdr6EFGh3QJ54_q7cY-tO4rEyD9d7n8,5162
+overload/engine/auth.py,sha256=QpU-rWk_S0fwlKHcbvZ2FJnW8bW2ppV6Sm_AQmrEW0w,2571
+overload/engine/events.py,sha256=PTuYKtgK46UJzRMjyJsu4mFwJcrCyVmCnfTcFUVXU2Y,1695
+overload/engine/http_client.py,sha256=yZPbZ42glvZb-BeSguWhLb4AZyHVjK9IM0IY7-ygh1c,9533
+overload/engine/load_patterns.py,sha256=83ANLbFETZCcuopwNEnKXyxpq8eSahjpp9Y67NdClqE,25774
+overload/engine/models.py,sha256=mjZy8Q8fprMC3HeQl-sV6a5Qg1uxHxXJvTzxunP_1ag,7103
+overload/engine/rate_limiter.py,sha256=iJjgV9QgvYnjHM-c4v72GYBGwZrh0qRGF-rd-uTd6u8,4115
+overload/engine/runner.py,sha256=98e7sBXrMmQkYq3BpZ_Bx2o3HlVaqJv3qQi3Py4edVk,2865
+overload/report/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+overload/report/exporters.py,sha256=OWzbVqIpvqMyuB24oJY99ic-LXZiCio5cQFY8_H8lLw,2122
+overload/report/generator.py,sha256=UBd50SHXXtUXcbJ5y1fzm7vxnHEqqYeP_Qi4QHyNGa8,1809
+overload/report/templates/report.html,sha256=gOX4-VUz-sJZq_e6FOIjNj-vakp5SHGP6ipmfZs2HaI,21252
+overload/utils/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+overload/utils/naming.py,sha256=wiQCDp689e7R4FrwtZtJwOvrcAPv8THG1isd2sQ0bac,737
+overload/web/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+overload/web/app.py,sha256=Be5oXDl4DQLbWJBTd6RbZMwUMQKLeDu_0lAQijs42h8,1013
+overload/web/routes/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+overload/web/routes/api.py,sha256=3RUuM-gb-gnd6YXFXMoy54eeXY3gNWVxz-s1D4jYI9Q,17497
+overload/web/routes/ws.py,sha256=4HAgg1uwL86zkP_A87xFe3XYYb6VVzBBS6-ZAbhCXbQ,2220
+overload/web/static/css/app.css,sha256=CrsIpJIHzBgZVgTk273TWhjRwsr9LDG6Zd-JHmtI7KA,16446
+overload/web/static/js/app.js,sha256=2YLK1Oeb5ukHln7hcf-3pvgmqq3n5wItlQSmM4SyA3E,11004
+overload/web/static/js/charts.js,sha256=QHWcTHETa7s1UFw4UMXU8Hrb0fAjakRpcf59XWaLBaw,15190
+overload/web/static/js/collection.js,sha256=z-QjOW883hlrhHhfITRNrbe58it223GUtufTvDP2U2Q,13722
+overload/web/static/js/runner.js,sha256=Ew6SDfnmFtW-sOGWwo0CnhAvQhR19Oylodl8Ri7w9Xo,30973
+overload/web/templates/index.html,sha256=qHlCwLfMJrDrc6BjtJndiNINGAwAM5lO63eBgn7SU1c,818
+overload_cli-0.1.0.dist-info/METADATA,sha256=mZ73AMY18HUCDv3HluZeGT2378lqE7rfTKBsWkgXwTo,8795
+overload_cli-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+overload_cli-0.1.0.dist-info/entry_points.txt,sha256=K2d6azt_baOwO_SOXzWpXxx552FcIivHdjOyAGVtqlE,47
+overload_cli-0.1.0.dist-info/licenses/LICENSE,sha256=D4j7SEEdlPgLDOYn1MfcIu9_0pfCVLUnX3h58tAFSlc,1069
+overload_cli-0.1.0.dist-info/RECORD,,

overload_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

overload_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+overload = overload.cli:main

overload_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Devi Prakash
+
+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.