Pypus

Pypus is a modern, typed CLI tool for Octopus Deploy API tasks — inspecting Spaces, Projects, Environments, and Machines; migrating variables between servers or spaces; searching every variable in a Space by name or value; managing Runbooks; and redeploying current releases to specific targets across a project group.

Built on Typer and Rich, targeting Python 3.13+.

Install

Pypus uses uv to create its virtual environment and Poetry to manage dependencies:

uv venv --python 3.13 .venv
source .venv/bin/activate
poetry install

Alternatively, once published:

pip install pypus

Configure

export OCTOPUS_API_KEY=API-EXAMPLE1234567890
export OCTOPUS_SERVER_URI=https://deploys.example.com/api
pypus check-env

Examples

Display a project's deployment process:

pypus get-process MySpace "My Project"

Redeploy every application in a project group, previewing what would happen first:

pypus redeploy Digital "Image Server Applications" --check
pypus redeploy Digital "Image Server Applications" --environment Production --target web01

Documentation

Full documentation, including the complete CLI reference and API reference, is built with MkDocs + Material:

mkdocs serve

Development

poetry install
pytest              # run the test suite (100% coverage)
ruff check .        # lint
mypy src/pypus       # type-check
mkdocs build --strict