Skip to main content

Developer-friendly load testing framework

Project description

Locust

PyPI Python Version from PEP 621 TOML Downloads Build Status GitHub contributors Support Ukraine Badge

Locust is an open source performance/load testing tool for HTTP and other protocols. Its developer-friendly approach lets you define your tests in regular Python code.

Locust tests can be run from command line or using its web-based UI. Throughput, response times and errors can be viewed in real time and/or exported for later analysis.

You can import regular Python libraries into your tests, and with Locust's pluggable architecture it is infinitely expandable. Unlike when using most other tools, your test design will never be limited by a GUI or domain-specific language.

To get started right away, head over to the documentation.

Features

Write user test scenarios in plain old Python

If you want your users to loop, perform some conditional behaviour or do some calculations, you just use the regular programming constructs provided by Python. Locust runs every user inside its own greenlet (a lightweight process/coroutine). This enables you to write your tests like normal (blocking) Python code instead of having to use callbacks or some other mechanism. Because your scenarios are “just python” you can use your regular IDE, and version control your tests as regular code (as opposed to some other tools that use XML or binary formats)

from locust import HttpUser, task, between

class QuickstartUser(HttpUser):
    wait_time = between(1, 2)

    def on_start(self):
        self.client.post("/login", json={"username":"foo", "password":"bar"})

    @task
    def hello_world(self):
        self.client.get("/hello")
        self.client.get("/world")

    @task(3)
    def view_item(self):
        for item_id in range(10):
            self.client.get(f"/item?id={item_id}", name="/item")

Distributed & Scalable - supports hundreds of thousands of users

Locust makes it easy to run load tests distributed over multiple machines. It is event-based (using gevent), which makes it possible for a single process to handle many thousands concurrent users. While there may be other tools that are capable of doing more requests per second on a given hardware, the low overhead of each Locust user makes it very suitable for testing highly concurrent workloads.

Web-based UI

Locust has a user friendly web interface that shows the progress of your test in real-time. You can even change the load while the test is running. It can also be run without the UI, making it easy to use for CI/CD testing.

Locust UI charts Locust UI stats Locust UI workers Locust UI start test

Can test any system

Even though Locust primarily works with web sites/services, it can be used to test almost any system or protocol. Just write a client for what you want to test, or explore some created by the community.

Hackable

Locust's code base is intentionally kept small and doesn't solve everything out of the box. Instead, we try to make it easy to adapt to any situation you may come across, using regular Python code. There is nothing stopping you from:

Links

Authors

License

Open source licensed under the MIT license (see LICENSE file for details).

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

locust-2.28.1.dev16.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

locust-2.28.1.dev16-py3-none-any.whl (748.2 kB view details)

Uploaded Python 3

File details

Details for the file locust-2.28.1.dev16.tar.gz.

File metadata

  • Download URL: locust-2.28.1.dev16.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for locust-2.28.1.dev16.tar.gz
Algorithm Hash digest
SHA256 77edac365d9f81d3f2fcb0e4b87e54b7adaac5588c7548280c76faac1bc6dfdd
MD5 a22222ffae76983b6b99188dfda35b10
BLAKE2b-256 265a9ea90702ffc3d8dfe1ab1ff70780a7d783eee85d0d48d425ac3a28ac077f

See more details on using hashes here.

Provenance

File details

Details for the file locust-2.28.1.dev16-py3-none-any.whl.

File metadata

File hashes

Hashes for locust-2.28.1.dev16-py3-none-any.whl
Algorithm Hash digest
SHA256 7f6480da3ab0904f1f6a87dca4981f8d73a3c5eb76d36aa19e17e496f87f4178
MD5 b762daa297c6e4792dccb629d2493d6f
BLAKE2b-256 b88503f280859eca23396fedf4272de9f5bfce97aa0d17c2f2278faf85f3d86f

See more details on using hashes here.

Provenance

Supported by

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