# rampa

> Async Python load testing, inspired by k6.

## Documentation

- [Getting Started](https://rampa.git-pull.com/getting-started/): Write and run your first load test in 60 seconds.
- [CLI](https://rampa.git-pull.com/cli/): The rampa CLI runs load tests from the terminal and produces structured output for scripts and CI.
- [Library](https://rampa.git-pull.com/library/): Use rampa as a Python library to build, configure, and run load tests programmatically.
- [pytest Plugin](https://rampa.git-pull.com/pytest/): Run load tests inside your existing test suite.
- [MCP Server](https://rampa.git-pull.com/mcp/): The rampa-mcp server lets AI agents start, stop, and query load tests via the Model Context Protocol.
- [Development](https://rampa.git-pull.com/dev/): Contributing to rampa and understanding its internals.
- [Changelog](https://rampa.git-pull.com/history/): Notes on the upcoming release will go here.

## Documentation

- [ADR 001: Pure Python/Rust Accelerator Module Compatibility Requirements](https://rampa.git-pull.com/adrs/001-pure-python-rust-accelerator-module-compatibility-requirements/): Status: Accepted Date: 2026-05-28
- [Architecture Decision Records](https://rampa.git-pull.com/adrs/): Significant design decisions and their rationale.
- [rampa check](https://rampa.git-pull.com/cli/check/): Validate a test script without running it. Discovers scenarios, validates executor configurations, and reports a summary.
- [rampa doctor](https://rampa.git-pull.com/cli/doctor/): Report the runtime environment — Python version, rampa version, platform, and optional dependency availability.
- [CLI Reference](https://rampa.git-pull.com/cli/reference/): Auto-generated reference for all rampa commands.
- [rampa run](https://rampa.git-pull.com/cli/run/): Execute a load test script.
- [Benchmarks](https://rampa.git-pull.com/dev/benchmark/): Four benchmark scripts measure different layers of the framework. All produce JSON output for CI regression tracking.
- [CI integration](https://rampa.git-pull.com/library/ci/): rampa integrates with CI pipelines for automated benchmarking and performance regression detection.
- [Distributed execution](https://rampa.git-pull.com/library/distributed/): rampa supports splitting load tests across multiple machines for higher throughput. The coordinator manages workers and aggregates metrics centrally.
- [Executors](https://rampa.git-pull.com/library/executors/): Executors control how iterations are scheduled — how many virtual users run, for how long, and at what rate. rampa provides six executor types matching k6’s scheduling vocabulary.
- [Metrics](https://rampa.git-pull.com/library/metrics/): rampa automatically collects metrics for every iteration and HTTP request. You can also emit custom metrics from your scenario code.
- [Output backends](https://rampa.git-pull.com/library/outputs/): rampa ships metric samples to output backends during and after a test run. Use --output to send results to multiple destinations simultaneously.
- [Protocol clients](https://rampa.git-pull.com/library/protocols/): rampa provides protocol-specific clients that auto-emit metrics. Each client is lazily initialized via a Worker property.
- [API Reference](https://rampa.git-pull.com/library/reference/): User-facing configuration models for rampa.
- [Thresholds](https://rampa.git-pull.com/library/thresholds/): Thresholds define pass/fail criteria for your load test. When any threshold breaches, rampa run exits with code 1.
- [TUI dashboard](https://rampa.git-pull.com/library/tui/): rampa includes a live terminal dashboard for real-time monitoring during load tests.
- [Tutorial](https://rampa.git-pull.com/library/tutorial/): Build a load test step by step — from a minimal scenario to a complete test with checks, thresholds, and structured output.
- [API Reference](https://rampa.git-pull.com/mcp/reference/): FastMCP server factory, run registry, event models, and configuration types used by the MCP tools and resources.
- [Resources](https://rampa.git-pull.com/mcp/resources/): MCP resources expose passive read-only data at rampa:// URIs. Clients read them with resources/read.
- [Tools](https://rampa.git-pull.com/mcp/tools/): The rampa MCP server provides six tools for load test lifecycle management, metric retrieval, and threshold evaluation.
- [API Reference](https://rampa.git-pull.com/pytest/reference/)