Skip to main content

Developer friendly load testing framework

Project description

Locust

Support Ukraine Badge PyPI PyPI Build Status codecov license GitHub contributors

Locust is an easy to use, scriptable and scalable performance testing tool. You define the behaviour of your users 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. If you want to send reporting data to that database & graphing system you like, wrap calls to a REST API to handle the particulars of your system or run a totally custom load pattern, there is nothing stopping you!

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.13.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

locust-2.13.0-py3-none-any.whl (823.8 kB view details)

Uploaded Python 3

File details

Details for the file locust-2.13.0.tar.gz.

File metadata

  • Download URL: locust-2.13.0.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for locust-2.13.0.tar.gz
Algorithm Hash digest
SHA256 f603752ab9d4f7d6034c5896c71e6069be49060a5868d6eb4d6c7d32b1c031ae
MD5 cf095b169a0253c89d76df54e1b25697
BLAKE2b-256 8cc62cf4835c1f8838773b0019c4926eceebd88e96e04b520ceb3ea0705dcb0b

See more details on using hashes here.

Provenance

File details

Details for the file locust-2.13.0-py3-none-any.whl.

File metadata

  • Download URL: locust-2.13.0-py3-none-any.whl
  • Upload date:
  • Size: 823.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for locust-2.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d747fb1be59d9e3f19e11fb90b8a50ad92b9615243ead67fc14e1e7421e5794e
MD5 0b7ef86012e721662aa43fca846d3a74
BLAKE2b-256 bc3199d7a0eb38f870cf0da3833f75251beffa41cb3b0ab3630e1e7a980016fa

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