Quick Installation Guide

This is a quick guide to getting up and running with the appian-locust library. You will need Python 3.10 installed on your machine before proceeding.


  1. Install appian-locust using pip, for more comprehensive projects we recommend using pipenv.

pip install appian-locust

If using pipenv, simply start from the following Pipfile:

appian-locust = {version = "*"}

python_version = "3.10"

allow_prereleases = true
  1. Download the sample test example_locustfile.py from the Appian Locust repo and run it.

locust -f example_locustfile.py

If everything is set up correctly, you should see a link to the Locust web interface, which you can use to start test runs and view results.

Build from source

Clone the repository:

git clone -o prod git@gitlab.com:appian-oss/appian-locust.git

Install the library globally:

pip install -e appian-locust

If you’re using a virtualenv or a dependency management tool (e.g. pipenv), you can do the same type of install, but you will want to be in the context of the virtualenv (i.e. source the virtualenv), and you’ll need to pass the path to the repository you cloned.

Note: It’s highly recommended that you use a virtual environment when installing python artifacts. You can follow the instructions here to install virtualenv and pip.

If you have issues installing, make sure you have the proper prerequisites installed for Locust and its dependencies. If you’re having trouble on Windows, check here


  • Do not have permissions to clone appian-locust

    • Ensure you have added you ssh key to your profile. See here for how to do this.

  • “locust is not available”

    • Verify that you ran pip install -e appian-locust

  • “Failed to establish a new connection: [Errno 8] nodename nor servname provided, or not known”

    • check that host_address is specified correctly in your locust test file.

  • “Login unsuccessful, no multipart cookie found…make sure credentials are correct”

    • check that auth specifies a valid username and password combination for the site you’re testing on in your locust test file.

  • “General request and response debugging”

    • Add self.client.record_mode = True to your HttpUser subclass. Files will be placed in /record_responses where the runner is executed.