What is Appian Locust?
Appian Locust is a wrapper library around Locust for load testing Appian. This library is intended to be used as an alternative to tools such as Jmeter and Load Runner.
Appian Locust capabilities
Logging in and logging out
Form interactions (filling/submitting)
Finding and interacting with basic components on a SAIL interface
Navigating to records/reports/sites
For full documentation, visit the docs page.
Disclaimer: This library is continuously evolving. Currently the main focus is supporting essential use-cases. We are happy to accept contributions to further extend functionality, address bug fixes and improve usability. Please see the Contributing section and feel free to reach out.
Quick Installation Guide
This guide helps you get up and running with the appian-locust library quickly.
We strongly recommend using pipenv and pyenv to automatically manage Python versions and environments. This ensures a clean and reproducible setup for running and developing tests with Locust.
Manual Setup
Install appian-locust using pip, for more comprehensive projects we recommend using pipenv.
pip install appian-locustIf using pipenv, simply start from the following Pipfile:
[packages]
appian-locust = {version = "*"}
[requires]
python_version = "3.13"Build from source
Clone the repository:
git clone -o prod git@gitlab.com:appian-oss/appian-locust.git2a. Install the library globally:
pip install -e appian-locust2b. Or within a virtual environment:
pipenv install -e appian-locustNote: 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
Automatic Setup
To simplify the setup process and avoid installing Python manually, use the provided setup.sh script. It will:
Install pyenv and pipenv if they are missing.
Install the correct Python version from the Pipfile.
Create a virtual environment.
Install all dependencies.
Clone the repository:
git clone -o prod git@gitlab.com:appian-oss/appian-locust.gitNavigate to appian-locust directory and make the script setup.sh executable:
cd appian-locust/
chmod +x setup.shRun the setup:
./setup.shAfter setup, activate the virtual environment:
pipenv shellTest environment setup
Download the sample test example_locustfile.py from the Appian Locust repo and run it.
locust -f example_locustfile.pyIf 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.
For more information about how to build the workflow for your locust test, see the How to Write a Locust Test section.
appian-locust should now be ready to run your Locust performance tests!
Troubleshooting
Installation Issues
Permissions issue when cloning appian-locust
Ensure you have added your SSH key to your GitLab profile. See here for instructions.
Alternatively, download the ZIP bundle.
“locust is not available” or “command not found”
Verify you ran pip install appian-locust
If using a virtual environment, ensure it’s activated: pipenv shell
Check your PATH includes the Python or Pyenv directory
echo $PATH | grep -e "python" -e "pyenv"Python version compatibility errors
Appian Locust requires Python 3.13+. Check your version: python --version
Consider using pyenv to manage multiple Python versions
Connection & Authentication Issues
“Failed to establish a new connection: [Errno 8] nodename nor servname provided, or not known”
Verify host_address in your config.json is correct (without https://)
If behind a corporate firewall, check any network security tools like ZScaler or any outbound proxy settings.
“Login unsuccessful, no multipart cookie found”
Verify username and password in auth are correct for your Appian site
Verify the user has appropriate permissions to access the site, try in a browser
SSL/Certificate errors
For self-signed certificates you may need to disable SSL verification, but make sure you actually trust the host you are testing against.
class UserActor(HttpUser): def on_start(self): self.client.verify = False
Runtime Issues
Tests run but no interactions complete
Verify that your Appian site is accessible in a browser
Ensure your test users have access to the interfaces you’re testing
Need More Help?
For detailed debugging techniques, request recording, and advanced troubleshooting, see the Debugging Guide
1 maintainer
Metadata
1 maintainer
Release files for appian-locust 2.27.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| appian_locust-2.27.10.tar.gz | 151.1 kB | Without provenance | Details for appian_locust-2.27.10.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| appian_locust-2.27.10-py3-none-any.whl | Python 3 | none | any | Details for appian_locust-2.27.10-py3-none-any.whl |
Total release size: 271.6 kB
Release files / appian_locust-2.27.10.tar.gz
| Download URL | appian_locust-2.27.10.tar.gz |
|---|---|
| Size | 151.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b78c2021afa400a7c01b5d0193353ea209d2e09cfa0f7bdd6b6a4a3eecd30280
|
|
BLAKE2b-256 checksum How to use checksums |
f85f681eb13d26db6266e19dcdcf4697d92354983299bd3d20a2c551e4407786
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.13
|
Release files / appian_locust-2.27.10-py3-none-any.whl
| Download URL | appian_locust-2.27.10-py3-none-any.whl |
|---|---|
| Size | 120.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6a8e8c986ce8604ae422b7db1e01161699f14cdbb32a6a44d2f20b47eadb4142
|
|
BLAKE2b-256 checksum How to use checksums |
3d5c2ee379efe5ca1a3feff07c1765d038b394dc328eed32b7de33df582b4229
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.13
|
Security for appian-locust 2.27.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
