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

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.4.4.tar.gz (10.2 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.4.4-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for orche-0.4.4.tar.gz
Algorithm Hash digest
SHA256 af899e8427766c32cc2156b04c0777976848114f15826dbbf75887229279a2de
MD5 3ffefa191d5b63d66a6d96383a15b28c
BLAKE2b-256 d13b7aaa37d0b767c49cccc70a88d46e83919d30f0f55842548204dbe2511c74

See more details on using hashes here.

Provenance

The following attestation bundles were made for orche-0.4.4.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.4.4-py3-none-any.whl.

File metadata

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

File hashes

Hashes for orche-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5dc6f0db7ded54cd87cdac84ad0b7d151a11aa26f0d5b8dc99590d02a4edbf9b
MD5 dc9f8ef0ffc63db3e6b4dc2ffd21e8c7
BLAKE2b-256 098d6e8775e9d3d823c8e46ef7d5630faab0be074fae1baad1632d26d838235b

See more details on using hashes here.

Provenance

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