Skip to main content

compose2pod

PyPI version Supported Python versions Downloads Coverage CI License GitHub stars Context7 uv Ruff ty

Convert a Docker Compose file into a POSIX sh script that runs its services as a single Podman pod.

Built for CI and test environments where you can't use docker compose or podman kube play:

  • No bridge networking / netavark. Unprivileged CI containers often have a read-only /proc/sys, so netavark fails to create bridge networks. A single pod shares one network namespace with no bridge: services talk over 127.0.0.1, and names resolve via --add-host.
  • No systemd. Podman healthchecks are normally scheduled by systemd timers. compose2pod gates startup by polling podman healthcheck run directly, so depends_on: service_healthy works without systemd.
  • No heavy runtime. The core is stdlib-only — no dependencies, no compiled wheels — so it installs and runs in minimal Python images.

Requirements

Podman >= 6.0.0. Earlier releases have a bug where a container stopping inside a multi-container pod wipes /etc/hosts for every container in that pod, not just the one that stopped — fixed in 6.0.0. compose2pod's generated scripts rely on one shared --add-host-populated /etc/hosts for the whole pod (see architecture/supported-subset.md), so a service_completed_successfully dependency (a container that runs and exits, e.g. a migration step) can wipe name resolution for everything started after it on a pre-6.0.0 Podman.

Install

pip install compose2pod            # core: reads compose as JSON
pip install compose2pod[yaml]      # optional: read YAML directly (adds PyYAML)

Usage

# YAML directly (needs the [yaml] extra)
compose2pod docker-compose.yml --target app --image myimage:ci > run.sh

# Or stay dependency-free by piping JSON (e.g. via yq)
yq -o=json '.' docker-compose.yml | compose2pod --target app --image myimage:ci > run.sh

sh ./run.sh

Supported compose subset

compose2pod supports an honest subset and errors clearly on anything outside it: image/build, command, environment/env_file, short-form bind volumes, healthcheck (CMD/CMD-SHELL), depends_on (all conditions), and network aliases. Compose extension fields (any x--prefixed key) and YAML anchors are accepted as-is, so a top-level x-* anchor block for shared config just works. ${VAR}-style variable interpolation is left live in the generated script, resolved by its shell against the environment present when the script runs (no .env file support). See architecture/supported-subset.md for the full accept/ignore/reject matrix.

Status

Beta. Part of the modern-python family. MIT licensed.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

compose2pod-0.3.0.tar.gz (56.5 kB view details)

Uploaded Source

Built Distribution

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

compose2pod-0.3.0-py3-none-any.whl (64.8 kB view details)

Uploaded Python 3

File details

Details for the file compose2pod-0.3.0.tar.gz.

File metadata

  • Download URL: compose2pod-0.3.0.tar.gz
  • Upload date:
  • Size: 56.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for compose2pod-0.3.0.tar.gz
Algorithm Hash digest
SHA256 62c3f4f31f51403bf82538930eb85c9c62fba9339bb47c5e020773563ff85982
MD5 caa70e31538990bf74078a632e0ee75f
BLAKE2b-256 99cde50294af552ebf6fc33f56fadd0eddb9568ab348f4c4960b48bcbb02bead

See more details on using hashes here.

File details

Details for the file compose2pod-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: compose2pod-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 64.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for compose2pod-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 435929b7605af8dd1fe508db8551761da7ce8336c8f517ac72e963efdd8a5d34
MD5 e93276449bb32100842d241e2daece0d
BLAKE2b-256 802d698bf5d6d01b967ec82a3696c1cb9a1856c0be1565642a287658d0a52d59

See more details on using hashes here.

Supported by

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