strobengine 0.4.0__tar.gz → 0.5.0__tar.gz

{strobengine-0.4.0 → strobengine-0.5.0}/.gitignore

@@ -248,3 +248,6 @@ __marimo__/
 
 # Streamlit
 .streamlit/secrets.toml
+
+# strobengine reports
+.strobengine/

{strobengine-0.4.0 → strobengine-0.5.0}/CHANGELOG.md

@@ -4,6 +4,91 @@ All notable changes to `strobengine` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2026-08-30
+
+### Documentation
+
+- Convert README links to absolute GitHub URLs
+- *(cli)* Add --sse/--no-sse and --sse-max-events to option tables
+- *(examples)* Add SSE streaming load test examples
+- Add SSE load testing reference guide
+- Add SSE to README, quickstart, and table of contents
+- Mark HTML report generator as complete in roadmap
+- Mark baseline comparison as complete in roadmap
+- Add reporting and visualizations reference guide
+- Add Reporting & Visualizations to documentation indexes
+- Add Advanced Metrics & Observability epic to roadmap
+- Mark Export Formats as complete in roadmap
+
+### Features
+
+- *(config)* Add sse_enabled, sse_max_events to TestConfig
+- *(metrics)* Add sse_events_received, sse_first_event_us, sse_event_interval_us to RequestMetric
+- *(sse)* Implement SSE frame parser and SseEngine
+- *(sse)* Wire SSE engine into protocol detection and config routing
+- *(sse)* Centralize protocol routing and add URL normalization
+- *(deps)* Add serde with derive feature for report serialization
+- *(report)* Add ReportArtifact schema with serde serialization
+- *(config)* Add output_dir and no_save to TestConfig
+- *(python)* Wire report persistence through CLI and engine
+- *(report)* Add ReportArtifact::from_summary_and_config converter
+- *(report)* Add save_report_json with atomic writes and latest.json
+- *(report)* Invoke save_report_json on benchmark completion
+- *(reporting)* Add standalone HTML report generator with Chart.js
+- *(cli)* Add --html flag for standalone HTML report generation
+- *(reporting)* Add baseline artifact loading and delta comparison
+- *(reporting)* Add Historical Comparison section to HTML report
+- *(cli)* Add --compare-to flag for baseline comparison
+- *(reporting)* Inline Chart.js from local asset for 100% offline reports
+- *(reporting)* Add CLI terminal comparison and extend compute_comparison
+- *(engine)* Add get_config() convenience method to StrobEngine
+- *(reporting)* Add Markdown, JUnit XML, and CSV export generators
+- *(cli)* Add --markdown, --junit, --csv export flags
+- *(reporting)* Add generate_markdown_summary for GitHub Actions / PR comments
+- *(reporting)* Add generate_junit_report and generate_csv_report
+
+### Miscellaneous Tasks
+
+- *(pyproject)* Simplify readme config and update documentation URL
+- *(scripts)* Run uv lock during release version bump
+
+### Styling
+
+- *(tests)* Reorder imports in test_reporting.py for ruff isort compliance
+
+### Testing
+
+- *(config)* Update TestConfig::new calls with SSE parameters
+- *(e2e)* Add SSE streaming endpoint to mock server
+- *(e2e)* Add SSE integration tests for error paths and streaming
+- *(e2e)* Add persistence E2E tests for report artifact disk writing
+- *(reporting)* Add unit tests for Markdown summary generator
+- *(reporting)* Add JUnit XML and CSV export unit tests
+## [0.4.1] - 2026-08-26
+
+### Bug Fixes
+
+- *(pypi)* Configure readme base-url for relative link resolution
+- *(cli)* Validate ws_mode with StrEnum to reject invalid strings
+- *(cli)* URL-decode form values before passing to Rust
+- *(websocket)* Count actual Pong payload size and fix PingPong status code
+- *(reporter)* Handle GB and TB in _format_bytes
+
+### Documentation
+
+- Add dependencies and installation guides
+- Add quick start guide and CLI reference
+- Update table of contents with new pages
+- Slim README and link to documentation pages
+- Add multi-target, reporting, SSE, messaging, and caching epics to roadmap
+
+### Miscellaneous Tasks
+
+- *(release)* Bump version to 0.4.1
+
+### Testing
+
+- *(e2e)* Remove bytes_received assertion from PingPong mode test
 ## [0.4.0] - 2026-08-23
 
 ### Bug Fixes
@@ -105,6 +190,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add rust-toolchain.toml for reproducible builds
 - Remove e2e test from pre commit hooks
 - *(ci)* Pin github actions to full commit SHAs
+- *(release)* Bump version to 0.4.0
+- Bump to 0.4.0 in uv.lock
 
 ### Other
 

{strobengine-0.4.0 → strobengine-0.5.0}/Cargo.lock

@@ -1461,6 +1461,7 @@ dependencies = [
  "base64",
  "bytes",
  "futures-core",
+ "futures-util",
  "h2",
  "http",
  "http-body",
@@ -1479,12 +1480,14 @@ dependencies = [
  "sync_wrapper",
  "tokio",
  "tokio-rustls",
+ "tokio-util",
  "tower",
  "tower-http",
  "tower-service",
  "url",
  "wasm-bindgen",
  "wasm-bindgen-futures",
+ "wasm-streams",
  "web-sys",
 ]
 
@@ -1654,6 +1657,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba"
 dependencies = [
  "serde_core",
+ "serde_derive",
 ]
 
 [[package]]
@@ -1781,7 +1785,7 @@ checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596"
 
 [[package]]
 name = "strobengine"
-version = "0.4.0"
+version = "0.5.0"
 dependencies = [
  "async-trait",
  "base64",
@@ -1801,6 +1805,7 @@ dependencies = [
  "pyo3",
  "quinn",
  "reqwest",
+ "serde",
  "serde_json",
  "tokio",
  "tokio-stream",
@@ -2355,6 +2360,19 @@ dependencies = [
  "unicode-ident",
 ]
 
+[[package]]
+name = "wasm-streams"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9d1ec4f6517c9e11ae630e200b2b65d193279042e28edd4a2cda233e46670bbb"
+dependencies = [
+ "futures-util",
+ "js-sys",
+ "wasm-bindgen",
+ "wasm-bindgen-futures",
+ "web-sys",
+]
+
 [[package]]
 name = "web-sys"
 version = "0.3.103"

{strobengine-0.4.0 → strobengine-0.5.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "strobengine"
-version = "0.4.0"
+version = "0.5.0"
 edition = "2024"
 readme = "README.md"
 
@@ -15,7 +15,7 @@ crate-type = ["cdylib", "rlib"]
 # "abi3-py311" tells pyo3 (and maturin) to build using the stable ABI with
 # minimum Python version 3.11
 pyo3 = { version = "0.29", features = ["extension-module", "abi3-py311"] }
-reqwest = { version = "0.13.4", default-features = false, features = ["rustls", "http2"] }
+reqwest = { version = "0.13.4", default-features = false, features = ["rustls", "http2", "stream"] }
 http = "1"
 bytes = "1"
 tokio = { version = "1.53.0", features = ["sync", "time", "rt", "rt-multi-thread", "macros", "signal"] }
@@ -37,6 +37,7 @@ base64 = "0.22"
 hex = "0.4"
 prost-reflect = { version = "0.16.5", features = ["serde"] }
 protox = "0.9.1"
+serde = { version = "1", features = ["derive"] }
 serde_json = "1.0.151"
 tonic-reflection = { version = "0.14.6", default-features = false }
 quinn = { version = "0.11", default-features = false, features = ["runtime-tokio", "rustls-ring"] }

strobengine-0.5.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: strobengine
+Version: 0.5.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.27.0
+Requires-Dist: jinja2>=3.1
+License-File: LICENSE
+Summary: A load testing framework with a Python UI and a bare-metal Rust engine core.
+Author-email: riccione <28346232+riccione@users.noreply.github.com>
+License-Expression: Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/strobeops/strobengine/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/strobeops/strobengine/blob/main/docs/table_of_contents.md
+Project-URL: Homepage, https://github.com/strobeops/strobengine
+Project-URL: Source, https://github.com/strobeops/strobengine
+
+# strobengine
+
+A high-performance HTTP, WebSocket, gRPC, and SSE load testing engine with a Python API and a bare-metal Rust core.
+
+## Install
+
+```bash
+pip install strobengine
+# or from source
+git clone https://github.com/strobeops/strobengine.git && cd strobengine && uv sync
+```
+
+> See [Installation Guide](https://github.com/strobeops/strobengine/blob/main/docs/install.md) for Docker, PyPI, and development setup.
+
+## Quick Start
+
+```python
+from strobengine import StrobEngine
+from strobengine.reporter import print_summary
+
+engine = StrobEngine(url="http://localhost:8080/api/health", concurrency=50, duration=30)
+summary = engine.run()
+print_summary(summary)
+```
+
+```bash
+strobengine load http://localhost:8080/api/health -c 50 -d 30
+```
+
+> See [Quick Start Guide](https://github.com/strobeops/strobengine/blob/main/docs/quickstart.md) for Python API and CLI examples.
+
+## Documentation
+
+| Section | Description |
+|---------|-------------|
+| [Installation](https://github.com/strobeops/strobengine/blob/main/docs/install.md) | Build from source, Docker, PyPI |
+| [Dependencies](https://github.com/strobeops/strobengine/blob/main/docs/dependencies.md) | System requirements, Rust crates, Python packages |
+| [Quick Start](https://github.com/strobeops/strobengine/blob/main/docs/quickstart.md) | Python API and CLI usage examples |
+| [CLI Reference](https://github.com/strobeops/strobengine/blob/main/docs/cli.md) | All subcommands, flags, and options |
+| [HTTP Methods](https://github.com/strobeops/strobengine/blob/main/docs/http_methods.md) | Supported methods, request bodies, headers |
+| [WebSocket](https://github.com/strobeops/strobengine/blob/main/docs/websockets.md) | WS/WSS modes, pub/sub broadcasting, metrics |
+| [gRPC](https://github.com/strobeops/strobengine/blob/main/docs/grpc.md) | Unary calls, protobuf, deadline, chaos |
+| [HTTP/3](https://github.com/strobeops/strobengine/blob/main/docs/http3.md) | QUIC transport, 0-RTT resumption, loss recovery |
+| [SSE](https://github.com/strobeops/strobengine/blob/main/docs/sse.md) | Server-Sent Events streaming, TTFB, event intervals |
+| [Reporting](https://github.com/strobeops/strobengine/blob/main/docs/reports.md) | JSON persistence, HTML reports, baseline comparison |
+| [Docker](https://github.com/strobeops/strobengine/blob/main/docs/docker.md) | Pulling images, running containers |
+| [Testing](https://github.com/strobeops/strobengine/blob/main/docs/testing.md) | Test structure, e2e, CI/CD |
+| [Roadmap](https://github.com/strobeops/strobengine/blob/main/docs/roadmap.md) | Planned features |
+
+## How to Contribute
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feat/my-feature`)
+3. Install dependencies and set up pre-push Git hooks:
+   ```bash
+   uv sync
+   uv run pre-commit install --hook-type pre-push
+   ```
+4. Run formatting, linting, and tests manually (or let git push run them automatically):
+   ```bash
+   make check
+   ```
+5. Commit your changes following [Conventional Commits](https://www.conventionalcommits.org/)
+6. Push to your branch and open a Pull Request
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See [LICENSE](https://github.com/strobeops/strobengine/blob/main/LICENSE) for the full text.
+

strobengine-0.5.0/README.md

@@ -0,0 +1,68 @@
+# strobengine
+
+A high-performance HTTP, WebSocket, gRPC, and SSE load testing engine with a Python API and a bare-metal Rust core.
+
+## Install
+
+```bash
+pip install strobengine
+# or from source
+git clone https://github.com/strobeops/strobengine.git && cd strobengine && uv sync
+```
+
+> See [Installation Guide](https://github.com/strobeops/strobengine/blob/main/docs/install.md) for Docker, PyPI, and development setup.
+
+## Quick Start
+
+```python
+from strobengine import StrobEngine
+from strobengine.reporter import print_summary
+
+engine = StrobEngine(url="http://localhost:8080/api/health", concurrency=50, duration=30)
+summary = engine.run()
+print_summary(summary)
+```
+
+```bash
+strobengine load http://localhost:8080/api/health -c 50 -d 30
+```
+
+> See [Quick Start Guide](https://github.com/strobeops/strobengine/blob/main/docs/quickstart.md) for Python API and CLI examples.
+
+## Documentation
+
+| Section | Description |
+|---------|-------------|
+| [Installation](https://github.com/strobeops/strobengine/blob/main/docs/install.md) | Build from source, Docker, PyPI |
+| [Dependencies](https://github.com/strobeops/strobengine/blob/main/docs/dependencies.md) | System requirements, Rust crates, Python packages |
+| [Quick Start](https://github.com/strobeops/strobengine/blob/main/docs/quickstart.md) | Python API and CLI usage examples |
+| [CLI Reference](https://github.com/strobeops/strobengine/blob/main/docs/cli.md) | All subcommands, flags, and options |
+| [HTTP Methods](https://github.com/strobeops/strobengine/blob/main/docs/http_methods.md) | Supported methods, request bodies, headers |
+| [WebSocket](https://github.com/strobeops/strobengine/blob/main/docs/websockets.md) | WS/WSS modes, pub/sub broadcasting, metrics |
+| [gRPC](https://github.com/strobeops/strobengine/blob/main/docs/grpc.md) | Unary calls, protobuf, deadline, chaos |
+| [HTTP/3](https://github.com/strobeops/strobengine/blob/main/docs/http3.md) | QUIC transport, 0-RTT resumption, loss recovery |
+| [SSE](https://github.com/strobeops/strobengine/blob/main/docs/sse.md) | Server-Sent Events streaming, TTFB, event intervals |
+| [Reporting](https://github.com/strobeops/strobengine/blob/main/docs/reports.md) | JSON persistence, HTML reports, baseline comparison |
+| [Docker](https://github.com/strobeops/strobengine/blob/main/docs/docker.md) | Pulling images, running containers |
+| [Testing](https://github.com/strobeops/strobengine/blob/main/docs/testing.md) | Test structure, e2e, CI/CD |
+| [Roadmap](https://github.com/strobeops/strobengine/blob/main/docs/roadmap.md) | Planned features |
+
+## How to Contribute
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feat/my-feature`)
+3. Install dependencies and set up pre-push Git hooks:
+   ```bash
+   uv sync
+   uv run pre-commit install --hook-type pre-push
+   ```
+4. Run formatting, linting, and tests manually (or let git push run them automatically):
+   ```bash
+   make check
+   ```
+5. Commit your changes following [Conventional Commits](https://www.conventionalcommits.org/)
+6. Push to your branch and open a Pull Request
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See [LICENSE](https://github.com/strobeops/strobengine/blob/main/LICENSE) for the full text.

strobengine-0.5.0/docs/cli.md

@@ -0,0 +1,153 @@
+# CLI Reference
+
+strobengine provides a CLI for running load tests from the terminal.
+
+## Default Behavior
+
+By default, this spawns **10 concurrent workers** for **10 seconds** with a **10-second request timeout**. Results are displayed as a formatted table with total requests, errors, requests/sec, and latency percentiles (min, avg, p50, p90, p95, p99, max).
+
+## Subcommands
+
+| Subcommand | Description |
+|------------|-------------|
+| `load` | Constant load test (default if no subcommand given) |
+| `stress` | Ramp from starting to target concurrency, then hold |
+| `spike` | Baseline -> peak -> baseline |
+
+## Load Subcommand Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `-c`, `--concurrency` | `10` | Number of concurrent workers |
+| `-d`, `--duration` | `10` | Duration in seconds |
+| `-t`, `--timeout` | `10` | Per-request timeout in seconds |
+| `--method` | `GET` | HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS) |
+| `--body` | none | Request body (raw string) |
+| `--form` | none | Form data body (e.g. key1=val1&key2=val2) |
+| `--header` | none | Custom header key:value (repeatable) |
+| `--chaos` | off | Enable fault injection (~10%% of requests) |
+| `--no-progress` | off | Suppress live progress bar |
+| `-v`, `-vv`, `-vvv` | warn | Increase verbosity (INFO, DEBUG, TRACE) |
+| `-q`, `--quiet` | off | Suppress all output |
+| `--log-file <path>` | none | Write logs to file |
+| `--json` | off | Output raw JSON instead of formatted table |
+| `--ws-mode` | `handshake` | WebSocket mode: `handshake`, `ping_pong`, `stream` |
+| `--ws-payload` | none | WebSocket text payload for stream mode |
+| `--ws-role` | none | WebSocket Pub/Sub role: `publisher`, `subscriber` |
+| `--ws-publish-interval` | none | Publisher send interval in milliseconds |
+| `--ws-subscribers` | none | Number of subscriber workers |
+| `--grpc-service` | none | gRPC service name (e.g. helloworld.Greeter) |
+| `--grpc-method` | none | gRPC method name (e.g. SayHello) |
+| `--grpc-payload` | none | Base64-encoded protobuf payload |
+| `--grpc-deadline-ms` | none | gRPC deadline in milliseconds |
+| `--http3/--no-http3` | off | Enable HTTP/3 over QUIC |
+| `--quic-zero-rtt` | off | Enable QUIC 0-RTT connection testing |
+| `--quic-max-idle-timeout` | none | QUIC max idle timeout in ms |
+| `--sse/--no-sse` | off | Enable SSE streaming mode |
+| `--sse-max-events` | none | Maximum events to receive per connection |
+
+## Stress Subcommand Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--from` | `10` | Starting concurrency |
+| `--to` | `200` | Target concurrency |
+| `--ramp` | `60` | Ramp duration in seconds |
+| `--hold` | `30` | Hold duration at target concurrency |
+| `-t`, `--timeout` | `10` | Per-request timeout in seconds |
+| `--method` | `GET` | HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS) |
+| `--body` | none | Request body (raw string) |
+| `--form` | none | Form data body (e.g. key1=val1&key2=val2) |
+| `--header` | none | Custom header key:value (repeatable) |
+| `--chaos` | off | Enable fault injection (~10%% of requests) |
+| `--no-progress` | off | Suppress live progress bar |
+| `-v`, `-vv`, `-vvv` | warn | Increase verbosity (INFO, DEBUG, TRACE) |
+| `-q`, `--quiet` | off | Suppress all output |
+| `--log-file <path>` | none | Write logs to file |
+| `--json` | off | Output raw JSON |
+| `--ws-mode` | `handshake` | WebSocket mode: `handshake`, `ping_pong`, `stream` |
+| `--ws-payload` | none | WebSocket text payload for stream mode |
+| `--ws-role` | none | WebSocket Pub/Sub role: `publisher`, `subscriber` |
+| `--ws-publish-interval` | none | Publisher send interval in milliseconds |
+| `--ws-subscribers` | none | Number of subscriber workers |
+| `--grpc-service` | none | gRPC service name (e.g. helloworld.Greeter) |
+| `--grpc-method` | none | gRPC method name (e.g. SayHello) |
+| `--grpc-payload` | none | Base64-encoded protobuf payload |
+| `--grpc-deadline-ms` | none | gRPC deadline in milliseconds |
+| `--http3/--no-http3` | off | Enable HTTP/3 over QUIC |
+| `--quic-zero-rtt` | off | Enable QUIC 0-RTT connection testing |
+| `--quic-max-idle-timeout` | none | QUIC max idle timeout in ms |
+| `--sse/--no-sse` | off | Enable SSE streaming mode |
+| `--sse-max-events` | none | Maximum events to receive per connection |
+
+## Spike Subcommand Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--baseline` | `5` | Baseline concurrency |
+| `--peak` | `500` | Peak concurrency |
+| `--pre-spike` | `5` | Pre-spike duration in seconds |
+| `--spike-duration` | `10` | Spike duration in seconds |
+| `--post-spike` | `5` | Post-spike duration in seconds |
+| `-t`, `--timeout` | `10` | Per-request timeout in seconds |
+| `--method` | `GET` | HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS) |
+| `--body` | none | Request body (raw string) |
+| `--form` | none | Form data body (e.g. key1=val1&key2=val2) |
+| `--header` | none | Custom header key:value (repeatable) |
+| `--chaos` | off | Enable fault injection (~10%% of requests) |
+| `--no-progress` | off | Suppress live progress bar |
+| `-v`, `-vv`, `-vvv` | warn | Increase verbosity (INFO, DEBUG, TRACE) |
+| `-q`, `--quiet` | off | Suppress all output |
+| `--log-file <path>` | none | Write logs to file |
+| `--json` | off | Output raw JSON |
+| `--ws-mode` | `handshake` | WebSocket mode: `handshake`, `ping_pong`, `stream` |
+| `--ws-payload` | none | WebSocket text payload for stream mode |
+| `--ws-role` | none | WebSocket Pub/Sub role: `publisher`, `subscriber` |
+| `--ws-publish-interval` | none | Publisher send interval in milliseconds |
+| `--ws-subscribers` | none | Number of subscriber workers |
+| `--grpc-service` | none | gRPC service name (e.g. helloworld.Greeter) |
+| `--grpc-method` | none | gRPC method name (e.g. SayHello) |
+| `--grpc-payload` | none | Base64-encoded protobuf payload |
+| `--grpc-deadline-ms` | none | gRPC deadline in milliseconds |
+| `--http3/--no-http3` | off | Enable HTTP/3 over QUIC |
+| `--quic-zero-rtt` | off | Enable QUIC 0-RTT connection testing |
+| `--quic-max-idle-timeout` | none | QUIC max idle timeout in ms |
+| `--sse/--no-sse` | off | Enable SSE streaming mode |
+| `--sse-max-events` | none | Maximum events to receive per connection |
+
+## Global Options
+
+| Flag | Description |
+|------|-------------|
+| `-V`, `--version` | Show version and exit |
+
+## Verbosity Levels
+
+| Flag | Level | Shows |
+|------|-------|-------|
+| (default) | `warn` | Errors and warnings only |
+| `-v` | `info` | Engine start/stop, test configuration |
+| `-vv` | `debug` | Worker spawn, HTTP errors, connection events |
+| `-vvv` | `trace` | Per-request latency, status codes, chaos injection |
+| `-q` | off | Suppress all log output (progress bar remains) |
+
+Logs stream to **stderr** by default, keeping stdout clean for JSON output piping:
+
+```bash
+strobengine load http://localhost:8080/api/health -vv --json > results.json
+```
+
+## Live Progress Bar
+
+During test execution, a live progress bar displays on stderr with real-time telemetry:
+
+```
+⠋ [00:00:05] [==============>-------------] 40% | 1250 req/s | 20 VUs | 12 err | avg 4.2ms
+```
+
+- **RPS**: Instantaneous requests per second (sampled every 200ms)
+- **VUs**: Active virtual users / concurrent workers
+- **Errors**: Total error count
+- **Avg latency**: Running average across all completed requests
+
+The progress bar auto-detects non-TTY environments (CI/CD, piped output) and suppresses itself. Use `--no-progress` to explicitly disable it on interactive terminals.

strobengine-0.5.0/docs/dependencies.md

@@ -0,0 +1,39 @@
+# Dependencies
+
+## System Requirements
+
+- **Python** >= 3.11
+- **Rust** stable (with `cargo`)
+- **uv** (Python package manager)
+
+## Rust Crates
+
+| Crate | Version | Purpose |
+|-------|---------|---------|
+| pyo3 | 0.29 | Python FFI bindings (stable ABI, abi3-py311) |
+| reqwest | 0.13 | HTTP client with connection pooling |
+| tonic | 0.14 | gRPC framework with TLS support |
+| quinn | 0.11 | QUIC transport for HTTP/3 |
+| h3 | 0.0.8 | HTTP/3 protocol implementation |
+| h3-quinn | 0.0.10 | h3-Quinn bridge |
+| tokio | 1.53 | Multi-threaded async runtime |
+| tokio-util | 0.7 | CancellationToken for graceful worker shutdown |
+| tracing | 0.1 | Structured logging instrumentation |
+| tracing-subscriber | 0.3 | Log formatting and output (stderr/file) |
+| indicatif | 0.17 | Terminal progress bar rendering |
+| fastrand | 2 | Fast random number generation for chaos injection |
+| http | 1 | HTTP method types and header primitives |
+| bytes | 1 | Zero-copy byte buffer for request payloads |
+| tokio-tungstenite | 0.26 | WebSocket client with TLS support |
+| prost / prost-reflect | 0.14 / 0.16 | Protobuf encoding/decoding and reflection |
+| base64 | 0.22 | Base64 payload decoding for gRPC |
+| hex | 0.4 | Hex payload decoding for gRPC |
+
+## Python Dependencies
+
+| Package | Version | Purpose |
+|---------|---------|---------|
+| pytest | >= 8.0 | Test runner |
+| pytest-asyncio | >= 0.24 | Async test support |
+| aiohttp | >= 3.14 | Mock server for E2E tests |
+| ruff | >= 0.15 | Linting and formatting |

strobengine-0.5.0/docs/install.md

@@ -0,0 +1,52 @@
+# Installation
+
+## From Source (Recommended)
+
+```bash
+# Clone the repository
+git clone https://github.com/strobeops/strobengine.git
+cd strobengine
+
+# Build the native extension and install the package
+uv sync
+```
+
+`uv sync` invokes [maturin](https://github.com/PyO3/maturin) under the hood, which compiles the Rust code into a native Python extension module and installs it into your virtual environment.
+
+## From Docker
+
+Pull and run strobengine directly from Docker Hub:
+
+```bash
+# Latest release
+docker pull strobeops/strobengine:latest
+docker run --rm -it strobeops/strobengine load http://host.docker.internal:8080/api/health -c 50 -d 30
+
+# Specific version
+docker pull strobeops/strobengine:0.3.0
+```
+
+> See [Docker documentation](docker.md) for version tags, host networking, and building locally.
+
+## Verify Installation
+
+```bash
+# Check version
+strobengine --version
+
+# Or via Python
+uv run python -c "from strobengine import StrobEngine; print('OK')"
+```
+
+## Development Setup
+
+```bash
+# Install with dev dependencies
+uv sync
+
+# Install pre-commit hooks (optional)
+uv run pre-commit install --hook-type pre-push
+
+# Run the full check suite
+make check
+```