Skip to main content

Developer friendly load testing framework

Project description

Locust

PyPI PyPI Build Status license GitHub contributors Support Ukraine Badge

Locust is an easy to use, scriptable and scalable performance testing tool. You define your load test in regular Python code, instead of being constrained by a UI or domain specific language that only pretends to be real code. This makes Locust infinitely expandable and very developer friendly.

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.18.5.dev32.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

locust-2.18.5.dev32-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file locust-2.18.5.dev32.tar.gz.

File metadata

  • Download URL: locust-2.18.5.dev32.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for locust-2.18.5.dev32.tar.gz
Algorithm Hash digest
SHA256 eed9c9ef244913f3178363c7f6880187bc3797404ca53d40962f686901e259c9
MD5 8a293ec1bc2365fbcf4bf74d9c9aaf71
BLAKE2b-256 e363e4c97050273235dd3fb25d4a7034c22cc65aa66c97ae2a86df91d5869ae4

See more details on using hashes here.

Provenance

File details

Details for the file locust-2.18.5.dev32-py3-none-any.whl.

File metadata

File hashes

Hashes for locust-2.18.5.dev32-py3-none-any.whl
Algorithm Hash digest
SHA256 05e396ed1b3849c9fa2ebd5e787b0b99e13006993bfc9cee7c1cad7dc32b7371
MD5 e9b42b22e7d860f2c63a878a2a2a365c
BLAKE2b-256 95cc0eb901daf37192576b8ef30e248617290a13e0674e2234c8de7d5602d95d

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