compose-to-quadlet

Convert Docker / Podman Compose to Podman Quadlet units.

Table of Contents

• Synopsis
• Install
• Usage
• Running Tests
• Examples
• CI/CD
• License
• Credits & Open Source Notices
• Contributing

Synopsis

compose-to-quadlet converts Docker/Podman Compose YAML into Podman Quadlet units (.container, .network, .volume) using concise, typed Python models.

Install

pipx install compose-to-quadlet
# or
poetry add compose-to-quadlet

Usage

compose-to-quadlet --help
compose-to-quadlet convert examples/docker-compose.min.yml -o ./quadlets
# or, if using poetry
poetry run compose-to-quadlet convert examples/docker-compose.min.yml -o ./quadlets

Running Tests

To run the unit tests and check code coverage, use the following command:

poetry run pytest

Examples

A minimal Docker Compose example is provided in examples/docker-compose.min.yml.

CI/CD

This project ships a GitHub Actions workflow that lints, tests, builds, publishes to PyPI on tag push (vX.Y.Z), creates a GitHub Release with ZIP artifact, and deploys pdoc docs to GitHub Pages. Tags with suffixes like -alpha, -beta, -rc are treated as pre-releases.

Documentation and Compliance

• International English, modern Python, strong typing, Pydantic validation.
• References:
  • Podman Quadlet documentation: https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html
  • Quadlet container units: https://docs.podman.io/en/latest/markdown/quadlet-container.5.html
  • Docker/Podman Compose reference: https://docs.docker.com/compose/compose-file/

Sponsored by The 17711 Frame

Credits & Open Source Notices

• click, pydantic, pyyaml, anyio, aiofiles, pytest, coverage, black, ruff, mypy, pdoc

Contributing

See CONTRIBUTING.md.

License

MIT © The 17711 Frame — https://17711.org