Skip to main content

A simple, lightweight Python orchestrator for Docker Compose stacks

Project description

Orche

CI

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

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

orche-0.5.0.tar.gz (104.6 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.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

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

Hashes for orche-0.5.0.tar.gz
Algorithm Hash digest
SHA256 0766a88559d3f86666f6e149b455fc1df89e285b72917eb0765866de448ff276
MD5 e7e6505203f8962cd5ad9b2aab66fff0
BLAKE2b-256 0a6047f56b06b828e34cc399b1a791c842d2109c13d54726dc0d545cfc25bf35

See more details on using hashes here.

Provenance

The following attestation bundles were made for orche-0.5.0.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.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

Hashes for orche-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d82d6dd8b8ac74ca8d110f7e928b8bd8cb78366ee5886842bba4fb89d0228645
MD5 26f8f51df60a7ac3879277738ecb3283
BLAKE2b-256 5327aebbe050e9002f109fa6e550ac9074b2e983b0118aea9977cbb894f7fd55

See more details on using hashes here.

Provenance

The following attestation bundles were made for orche-0.5.0-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