Installation with pipx

How to use pip to install Stoobly

Prerequisite

Install supported Python version

Our official Python support is 3.12, 3.13, and 3.14.

If none of the supported Python versions are available on your system, you will need to install one using pyenv . Otherwise, skip to the next section.

To install a specific Python version, first install pyenv.

1

Install specific Python version

pyenv install 3.13.0
pyenv local 3.13.0

2

Switch Python version

export PATH="$HOME/.pyenv/bin:$PATH"
eval "$(pyenv init --path)"
eval "$(pyenv init -)"

Install pipx

To install pipx, either follow the official installation steps or run the following commands:

macOS

brew install pipx
pipx ensurepath
source ~/.bashrc

Linux

python3 -m pip install --user pipx
python3 -m pipx ensurepath
source ~/.bashrc

Install

To install the agent, run:

pipx install stoobly-agent --python python3

This will use pipx to download the agent from our PyPI Python Package Index.

Update

To update the agent, run:

pipx upgrade stoobly-agent

Verify

stoobly-agent --help

Next Steps

You're all setup! Depending on your use case, you may want to take a look at:

API Mocking

How to Record Requests

E2E Testing

How to Integrate E2E Testing