subcompose 1.0.0

A command line utility to manage subsets of services in compose.yaml files.

🐳 subcompose

A command line utility to manage subsets of services in compose.yaml files.

Features

• Manage and run subsets of services from a Docker Compose file
• Group services for flexible orchestration
• Validate and preview Compose configurations
• Delete containers and images by group
• CLI and Python API usage
• Example Compose file included

Overview

SubCompose helps you orchestrate, validate, and manage complex Docker Compose setups by grouping services and providing advanced CLI operations.

Quick Installation

You can install SubCompose directly from the GitHub releases or from PyPI.

Install from GitHub releases

pip install https://github.com/doraemoncito/subcompose/archive/refs/tags/vX.Y.Z.tar.gz

Replace vX.Y.Z with the desired release version.

Install from PyPI

pip install subcompose

After installation, you can run SubCompose as a command:

subcompose --help

---

Developer Instructions: The following section is for contributors and developers who want to install from source or run tests.

Local Installation from Source

1. Install poetry if you don't have it already. The officially recommended approach is via the installer script which uses Python itself and works on macOS, Linux, and Windows:

   python3 -m pip install --user pipx
   python3 -m pipx ensurepath
   pipx install poetry
   

   This method has several advantages:

   • Isolated install (no dependency conflicts)
   • Uses your system Python
   • Easy upgrades

   Upgrade later with:

   pipx upgrade poetry
   

2. Install subcompose using Poetry:

   poetry install
   

Usage

To see available commands:

subcompose --help

Example Compose File

An example Compose file is provided at examples/compose.yaml. You can use this as a template for your own projects.

License

This project is licensed under the GPL v3. See the LICENSE file for details.