orche 0.4.2

A simple, lightweight Python orchestrator for Docker Compose stacks

Orche

A simple, lightweight Python orchestrator for Docker Compose stacks.

Installation

pip install -e .

CLI Reference

The orche command executes your orchefile.py file with the specified command and services.

orche [command] [services...]

Commands

• orche up [services] - Start services (executes orchefile.py with 'up' command)
• orche build [services] - Build services (executes orchefile.py with 'build' command)
• orche down [services] - Stop services (executes orchefile.py with 'down' command)

Options

• -f, --file FILE - Path to orche file (default: orchefile.py)
• -v, --verbose - Enable verbose logging
• --version - Show version and exit
• --help - Show help and exit

Examples

# Execute orchefile.py with up command
orche up

# Build specific services
orche build api web

# Start specific services
orche up postgres redis

# Use custom orche file
orche -f custom.py up

Examples

Basic Usage

from orche import Stack

stack = Stack(compose_files=["docker-compose.yml"])
stack.build().up()

With Project Name

from orche import Stack

stack = Stack(
    compose_files=["docker-compose.yml"],
    name="myapp",
    path="/path/to/project"
)

stack.build().up(wait=True)

Specific Services

from orche import Stack

stack = Stack(compose_files=["docker-compose.yml"])

# Build specific services
stack.build(["api", "web"])

# Start specific services
stack.up(["postgres", "redis"])

If your compose files live under another directory, pass path and keep compose_files relative to that directory.

Requirements

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

Development

Install development dependencies:

pip install -e ".[dev]"

Run tests:

pytest

Type checking:

mypy orche

Linting:

ruff check orche