Skip to main content

A simple, lightweight Python orchestrator for Docker Compose stacks

Project description

Orche

CI PyPI Python License

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:

Requirements

  • Python >= 3.10
  • Docker and Docker Compose installed on the system

Development

Orche uses uv for dependency management.

uv sync --extra dev
uv run pytest
uv run mypy orche
uv run 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

orche-0.5.1.tar.gz (104.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orche-0.5.1-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file orche-0.5.1.tar.gz.

File metadata

  • Download URL: orche-0.5.1.tar.gz
  • Upload date:
  • Size: 104.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for orche-0.5.1.tar.gz
Algorithm Hash digest
SHA256 59ac04a4e103358627e7923de34e6eb3cd88d17b3a5df4cb7585c02e4a617ab8
MD5 7be06d381886a61f1148dcd3265b0278
BLAKE2b-256 b65d6ff27b6d80510af91912ecbeaf6a54c74de485a4211cad2157c6274dd974

See more details on using hashes here.

Provenance

The following attestation bundles were made for orche-0.5.1.tar.gz:

Publisher: release.yml on pietroagazzi/orche

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file orche-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: orche-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for orche-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d7fd62da7041a4e92d7dbb5dd7208d591adb9716afb5de6b0a5453451dbb38b8
MD5 b37627f15960d8520e85318adc6dc471
BLAKE2b-256 477c90275f0c1c0476136463da05f8171e41bebac5e1dcd3f00583722cb79780

See more details on using hashes here.

Provenance

The following attestation bundles were made for orche-0.5.1-py3-none-any.whl:

Publisher: release.yml on pietroagazzi/orche

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page