A simple, lightweight Python orchestrator for Docker Compose stacks
Project description
Orche
A simple, lightweight Python orchestrator for Docker Compose stacks.
Define your stack logic in an orchefile.py, register commands with decorators, and run everything through the orche CLI.
[!IMPORTANT] Orche is a thin orchestration layer on top of Docker Compose. It does not replace Docker — it coordinates what happens around it.
Installation
pip install orche
Quick Start
Create an orchefile.py in your project root:
from orche import Stack
stack = Stack(
name="myapp",
compose_files=["docker-compose.yml"],
)
@stack.commands.up
def up():
stack.build().up()
@stack.commands.down
def down():
stack.down(volumes=True)
Then run:
orche up
orche down
# Chain commands with commas
orche build, up
Documentation
Full documentation is available here:
- Installation
- Quick Start
- CLI Reference
- Guides: Hooks · Services
- API: Stack · Command Registry · Built-in Utilities · Exceptions
Requirements
- Python >= 3.10
- Docker and Docker Compose installed on the system
Development
pip install -e ".[dev]"
pytest
mypy orche
ruff check orche
Project details
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 orche-0.5.0.tar.gz.
File metadata
- Download URL: orche-0.5.0.tar.gz
- Upload date:
- Size: 104.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0766a88559d3f86666f6e149b455fc1df89e285b72917eb0765866de448ff276
|
|
| MD5 |
e7e6505203f8962cd5ad9b2aab66fff0
|
|
| BLAKE2b-256 |
0a6047f56b06b828e34cc399b1a791c842d2109c13d54726dc0d545cfc25bf35
|
Provenance
The following attestation bundles were made for orche-0.5.0.tar.gz:
Publisher:
release.yml on pietroagazzi/orche
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
orche-0.5.0.tar.gz -
Subject digest:
0766a88559d3f86666f6e149b455fc1df89e285b72917eb0765866de448ff276 - Sigstore transparency entry: 1368406067
- Sigstore integration time:
-
Permalink:
pietroagazzi/orche@72f5f8405da3b4ac4abfb1349537d205f570206c -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/pietroagazzi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@72f5f8405da3b4ac4abfb1349537d205f570206c -
Trigger Event:
push
-
Statement type:
File details
Details for the file orche-0.5.0-py3-none-any.whl.
File metadata
- Download URL: orche-0.5.0-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d82d6dd8b8ac74ca8d110f7e928b8bd8cb78366ee5886842bba4fb89d0228645
|
|
| MD5 |
26f8f51df60a7ac3879277738ecb3283
|
|
| BLAKE2b-256 |
5327aebbe050e9002f109fa6e550ac9074b2e983b0118aea9977cbb894f7fd55
|
Provenance
The following attestation bundles were made for orche-0.5.0-py3-none-any.whl:
Publisher:
release.yml on pietroagazzi/orche
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
orche-0.5.0-py3-none-any.whl -
Subject digest:
d82d6dd8b8ac74ca8d110f7e928b8bd8cb78366ee5886842bba4fb89d0228645 - Sigstore transparency entry: 1368406102
- Sigstore integration time:
-
Permalink:
pietroagazzi/orche@72f5f8405da3b4ac4abfb1349537d205f570206c -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/pietroagazzi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@72f5f8405da3b4ac4abfb1349537d205f570206c -
Trigger Event:
push
-
Statement type: