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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pypus-2.2.1.tar.gz.
File metadata
- Download URL: pypus-2.2.1.tar.gz
- Upload date:
- Size: 18.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.14.4 Linux/5.14.0-687.25.1.el9_8.x86_64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c281f328c3596b7126cc3b416fc954875abac5a939ab101bd653039dda44b447
|
|
| MD5 |
ca32437965e911a32b1bbb75c329d83e
|
|
| BLAKE2b-256 |
f5992204485337373a1f6ded8cef79491f3ba8af7110f860fc3ecdf516b61300
|
File details
Details for the file pypus-2.2.1-py3-none-any.whl.
File metadata
- Download URL: pypus-2.2.1-py3-none-any.whl
- Upload date:
- Size: 20.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.14.4 Linux/5.14.0-687.25.1.el9_8.x86_64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
af8b7eddfe8abe20d52cc194dce4a9c6ec2e87ee9ddf28994cf6568f58294d51
|
|
| MD5 |
bd72c9f91b463767faf0f1f6075eeb1c
|
|
| BLAKE2b-256 |
ef78a993dcc1270078e246e4b52fb2b362552d41b8d794a71bc6d0aa44c4644a
|
