Skip to main content

Python SDK for in-process load execution, traffic correlation, and reporting.

Project description

LoadStrike SDK for Python

LoadStrike is a developer-first load testing SDK for Python services, jobs, and automated test suites. Use it to describe real workflows in Python, execute them in-process, and collect structured reports from the same codebase that owns the system under test.

What This SDK Is For

  • Author scenario-based load tests in Python.
  • Generate safe starter scenarios from captured HAR, OpenTelemetry trace JSON, browser recordings, or message pairs with Trace-to-test Autopilot.
  • Model transaction flows across HTTP and event-driven systems.
  • Apply load simulations, thresholds, and custom metrics during execution.
  • Generate local reports and, on Business and Enterprise, forward results to supported reporting sinks.

Built-in transport coverage includes HTTP, Kafka, RabbitMQ, NATS, Redis Streams, Azure Event Hubs, Push Diffusion, and delegate-based custom streams. Local report output supports HTML, Markdown, TXT, and CSV, and Business and Enterprise can publish to InfluxDB, TimescaleDB, Grafana Loki, Datadog, Splunk HEC, and OpenTelemetry Collector.

Requirements

  • Python 3.9 or later

Install

pip install loadstrike

Quick Start

from loadstrike_sdk import (
    LoadStrikeResponse,
    LoadStrikeRunner,
    LoadStrikeScenario,
    LoadStrikeSimulation,
    LoadStrikeStep,
)


def run_orders(context):
    return LoadStrikeStep.run(
        "publish-order",
        context,
        lambda: LoadStrikeResponse.ok("200"),
    ).as_reply()


scenario = (
    LoadStrikeScenario.create("orders", run_orders)
    .with_load_simulations(LoadStrikeSimulation.inject(10, 1, 20))
)

result = (
    LoadStrikeRunner.register_scenarios(scenario)
    .with_runner_key("rkl_your_runner_key")
    .run()
)

run() returns the detailed run result, including generated report files, scenario statistics, metrics, and sink status.

Trace-To-Test Autopilot

Use LoadStrikeAutopilot.generate(...) to infer a starter plan from a captured artifact. Set RunnerKey on the Autopilot options so generation can validate the Trace-To-Test Autopilot entitlement. Check result.Readiness and result.ReadinessFailures first; call result.build_scenario() only when it is LoadStrikeAutopilotReadiness.Ready, then execute the scenario through the normal runner with a valid RunnerKey.

Use SecretBindings to map redaction locations such as header:Authorization or body:$.client_secret to environment variables, TrackingSelector when the selector cannot be inferred, and EndpointBindings, AllowedReplayHosts, or BaseUrlRewrite when a replay target must be bound. Secret values are resolved when the generated scenario runs; they are not written into the generated plan. Any gate satisfied by user setup is omitted from ReadinessFailures.

Runner Keys

Runnable workloads require a RunnerKey. Supply it with .with_runner_key(...) or through your application configuration before calling run().

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

loadstrike-1.0.23601.tar.gz (584.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

loadstrike-1.0.23601-py3-none-any.whl (588.7 kB view details)

Uploaded Python 3

File details

Details for the file loadstrike-1.0.23601.tar.gz.

File metadata

  • Download URL: loadstrike-1.0.23601.tar.gz
  • Upload date:
  • Size: 584.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for loadstrike-1.0.23601.tar.gz
Algorithm Hash digest
SHA256 db2a34fa5f9701daa1d58b9244e8b11c277d88e9cf0f15b59802fea4d9c760cf
MD5 b5d13383e390a327d05dec8d122817c8
BLAKE2b-256 eafd82e6edf96379edc437702dd64cca563c5bf5e1b8e65a7994fb16c3ad5880

See more details on using hashes here.

Provenance

The following attestation bundles were made for loadstrike-1.0.23601.tar.gz:

Publisher: main-delivery.yml on Meticulis/LoadStrike

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file loadstrike-1.0.23601-py3-none-any.whl.

File metadata

  • Download URL: loadstrike-1.0.23601-py3-none-any.whl
  • Upload date:
  • Size: 588.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for loadstrike-1.0.23601-py3-none-any.whl
Algorithm Hash digest
SHA256 00dbe47a467a1c3845fa7b4a0a950c4343b4d7ce4801c614b8b12b196bad3dab
MD5 667484993fcb5d5ec4b4cb51f07f9b2a
BLAKE2b-256 8f11c2b2af0c285d7de0b9210d14d03a2d5cfd2b8a940700597a2242b134c0e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for loadstrike-1.0.23601-py3-none-any.whl:

Publisher: main-delivery.yml on Meticulis/LoadStrike

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page