hyperlight-hyperscale 0.5.1

Performance testing at scale.

Hyperscale

Package	Hyperscale
Version	0.5.1
Download	https://pypi.org/project/hyperscale/
Source	https://github.com/hyper-light/hyperscale
Keywords	performance, testing, async, distributed, graph, DAG, workflow

Hyperscale is a Python performance and scalable unit/integration testing framework that makes creating and running complex test workflows easy.

Write and orchestrate workflows as Python classes and decorator-wrapped async methods (called actions) using clients from Playwright and HTTP3 to GRPC and DTLS-UDP concurrently, connect to over thirty one different reporting options, and execute your tests the same locally and distributed via an intuitive CLI. Test execution statistics and performance are displayed via an intuitive terminal UI allowing for real-time feedback.

---

Why Hyperscale?

Understanding how your application performs under load provides valuable insights, from catching issues with latency and memory usage to finding race condititions and infrastructure misconfiguration. However, performance test tools are often difficult to use and lack the ability to simulate complex user scenarios. As a simulation framework Hyperscale is different, built from the ground up to facilitate multi-client workflow-driven testing without sacrificing developer experience, speed, or effciency. The Hyperscale project follows these tenants:

Speed and efficiency by default

Whether running on your personal laptop or distributed across a cluster, Hyperscale is fast, capable of generating millions of requests or interactions per minute and without consuming excessive memory such that running in modern cloud environments becomes difficult.

Run with ease anywhere

Hyperscale just works, requiring no additional setup beyond a supported Python distribution. Options (like ready made containers) to make running Hyperscale in more challenging environments easy are readily provided and maintained, but never required. Test code requires no changes whether running locally or distributed, and CLI option or configuration tweaks are kept as few as possible. Hyperscale embraces carefully selected modern developer experience features like starter templates generation, includes useful debugging tools like one-off request/response checking and IP lookup, and enforced a minimal but flexible API. This means developers and engineers spend less time learning the framework and more time making their applications the best they can.

Flexibility and and painless extensibility

Hyperscale ships with support for HTTP, HTTP2, HTTP3, SMTP, TCP, UDP, and Websockets out of the box. GraphQL, GraphQL-HTTP2, GRPC, and Playwright are available as optional extras that can be installed via:

pip install "hyperscale[<extra_here>]"

You can use any installed and supported client concurrently in the same or an independent Workflow, allowing you to exercise each part of your application's stack to the fullest. Performing non-test work to accomplish setup is easy and only requires writing a workflow where no actions specify a client response return type.

Hyperscale offers JSON and CSV results reporting by default, with 29 additional reporters readily available as extra install options. All additional reporting options utilize the same config API and require no additional boilerplate. Specifying custom metrics only entails specifying the Metric[T] return type, and all reporters support customer metrics just like the default metrics Hyperscale provides. Writing your own reporter or client is as easy as defining a class with a hadful of methods and specifying a few return types.

---

Requirements and Getting Started

Hyperscale makes use of the latest and greatest Python features, and requires Python 3.11+. We also recommend installing the latest LTS version of OpenSSL if you wish to perform DTLS UDP testing or run tests over SSL encrypted connections.

Installing

To install Hyperscale run:

pip install hyperscale

Verify the installation was was successful by running the command:

hyperscale --help

which should output

[!TIP] Hyperscale has been tested using and fully supports both poetry and uv package managers. We strongly recommend uv for its speed and ease of use.

Running your first test

Get started by running Hyperscale's:

# Note: test.py can also be any other file
hyperscale new test.py

which will output the following:

and generate the the test below in the specified test.py file:

from hyperscale.graph import Workflow, step
from hyperscale.testing import URL, HTTPResponse


class Test(Workflow):
    vus = 1000
    duration = "1m"

    @step()
    async def login(
        self,
        url: URL = "https://httpbin.org/get",
    ) -> HTTPResponse:
        return await self.client.http.get(
            url,
        )

Before running our test let's do two things. First, if on a Unix system, set the maximum number of open files above its current limit. This can be done by running:

ulimit -n 256000

[!IMPORTANT] You can provide any number when setting the file limit, but it must be more than the maximum number of vus specified in your Workflow.

Next, let's verify that httpbin.org/get can actually be reached by running:

hyperscale ping http https://httpbin.org/get

which should output:

Awesome! Now let's run the test by executing:

hyperscale run test.py

which will output:

Hyperscale runs a independent "worker" server on each CPU core and uses all available CPUs by default, so it may take a few seconds while the worker servers connect. During this few seconds, Hyperscale will let you know how many workers have successfully connected thusfar:

Once the servers have connected your test will start, during which you will see both static test-wide and real-time updating run statstics:

Live-updated statistics include actions-per-second (i.e. APS - how many individual actions Hyperscale completed, error or otherwise, per second), a scatter plot showing actions-per-second over time, total completed requests, total workflow duration, and per-action total/success/error stats. If multiple Workflows are present in the same Test file and executing concrrently, live statistics for each workflow will display for five-seconds and will cycle between all concurrent workflows.

Once the run is complete you should see:

You have officially created and run your first workflow!

---

Running in Docker

Hyperscale offers a Docker image that allows you to create and run tests in any Docker compatible environment. To run the Hyperscale Docker image run:

docker pull hyperlightorg/hyperscale:latest

then execute commands from within the image via:

docker run -e COLUMNS=200 -e LINES=60 -v <TEST_DIR>:/tests hyperscale <ARGS_HERE>

[!IMPORTANT]
The Hyperscale image runs using a non-root user (hyperscale) that has read and write permissions for only the /tests directory. You must mount the directory where you wish to create and run tests to the /tests path

[!TIP] By default the Hyperscale UI is fully enabled when running inside the Docker image. Unfortunately, Docker's default terminal size for running commands in an image causes issues. We recommend passing -e COLUMNS=200 and -e LINES=60 as options to prevent UI issues. Alternatively, you may disable Hyperscale's UI by running hyperscale run -q <TEST_NAME_AND_OTHER_ARGS>.

---

Development

To setup your environment run the following script:

# Clone the repo
git clone https://github.com/hyper-light/hyperscale.git && \
cd hyperscale

# We personally recommend uv
pip install uv

uv venv && \
source .venv/bin/activate

# Install Hyperscale

# NOTE: To install ALL dependencies for ALL reporting and
# client options, uncomment the line below:

# uv pip install -r requirements.txt.dev

uv pip install -e .

---

Clients and Reporters

Below find a tables of Hyperscale's supported client and reporting options, as well as co-requisite dependencies (if any):

Clients

Client	Additional Install Option	Dependencies
HTTP	N/A	N/A
HTTP2	N/A	N/A
HTTP3 (unstable)	pip install hyperscale[http3]	aioquic
SMTP	N/A	N/A
TCP	N/A	N/A
UDP	N/A	N/A
Websocket	N/A	N/A
GRPC	pip install hyperscale[grpc]	protobuf
GraphQL	pip install hyperscale[graphql]	graphql-core
GraphQL-HTTP2	pip install hyperscale[graphql]	graphql-core
Playwright	pip install hyperscale[playwright] && playwright install	playwright

Reporters

Reporter	Additional Install Option	Dependencies
AWS Lambda	pip install hyperscale[aws]	boto3
AWS Timestream	pip install hyperscale[aws]	boto3
Big Query	pip install hyperscale[google]	google-cloud-bigquery
Big Table	pip install hyperscale[google]	google-cloud-bigtable
Cassandra	pip install hyperscale[cassandra]	cassandra-driver
Cloudwatch	pip install hyperscale[aws]	boto3
CosmosDB	pip install hyperscale[azure]	azure-cosmos
CSV	N/A	N/A
Datadog	pip install hyperscale[datadog]	datadog
DogStatsD	pip install hyperscale[statsd]	aio_statsd
Google Cloud Storage	pip install hyperscale[google]	google-cloud-storage
Graphite	pip install hyperscale[statsd]	aio_statsd
Honeycomb	pip install hyperscale[honeycomb]	libhoney
InfluxDB	pip install hyperscale[influxdb]	influxdb_client
JSON	N/A	N/A
Kafka	pip install hyperscale[kafka]	aiokafka
MongoDB	pip install hyperscale[mongodb]	motor
MySQL	pip install hyperscale[sql]	aiomysql, sqlalchemy
NetData	pip install hyperscale[statsd]	aio_statsd
New Relic	pip install hyperscale[newrelic]	newrelic
Postgresql	pip install hyperscale[sql]	aiopg, psycopg2-binary, sqlalchemy
Prometheus	pip install hyperscale[prometheus]	prometheus-client, prometheus-client-api
Redis	pip install hyperscale[redis]	redis, aioredis
S3	pip install hyperscale[aws]	boto3
Snowflake	pip install hyperscale[snowflake]	snowflake-connector-python, sqlalchemy
SQLite3	pip install hyperscale[sql]	sqlalchemy
StatsD	pip install hyperscale[statsd]	aio_statsd
Telegraf	pip install hyperscale[statsd]	aio_statsd
TelegrafStatsD	pip install hyperscale[statsd]	aio_statsd
TimescaleDB	pip install hyperscale[sql]	aiopg, psycopg2-binary, sqlalchemy
XML	pip install hyperscale[xml]	dicttoxml

---

Resources

Hyperscale's official and full documentation is currently being written and will be linked here soon!

---

License

Hyper-Light and the Hyperscale project believe software should be truly open source forever. As such, this software is licensed under the MIT License in perpetuitiy. See the LICENSE file in the top distribution directory for the full license text.

---

Contributing

Hyperscale will be open to general contributions starting Fall, 2025 (once the distributed rewrite and general testing is complete). Until then, feel free to use Hyperscale on your local machine and report any bugs or issues you find!

---

Code of Conduct

Hyperscale has adopted and follows the Contributor Covenant code of conduct. If you observe behavior that violates those rules please report to:

Name	Email	Twitter
Ada Lundhe	[e-mail]	@adalundhe.dev