Skip to content

Commit 892ec0e

Browse files
authored
docs: add README badges matching org convention (#10)
Add the org-standard 11-badge header (PyPI, pyversions, downloads, coverage, CI, license, stars, Context7, uv, ruff, ty). Defer the brand lockup: compose2pod has no glyph in the .github brand MANIFEST yet (tracked in planning/deferred.md).
1 parent 7e7f733 commit 892ec0e

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# compose2pod
22

3+
[![PyPI version](https://img.shields.io/pypi/v/compose2pod.svg)](https://pypi.org/project/compose2pod/)
4+
[![Supported Python versions](https://img.shields.io/pypi/pyversions/compose2pod.svg)](https://pypi.org/project/compose2pod/)
5+
[![Downloads](https://static.pepy.tech/badge/compose2pod/month)](https://pepy.tech/projects/compose2pod)
6+
[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/modern-python/compose2pod/actions/workflows/ci.yml)
7+
[![CI](https://github.com/modern-python/compose2pod/actions/workflows/ci.yml/badge.svg)](https://github.com/modern-python/compose2pod/actions/workflows/ci.yml)
8+
[![License](https://img.shields.io/github/license/modern-python/compose2pod.svg)](https://github.com/modern-python/compose2pod/blob/main/LICENSE)
9+
[![GitHub stars](https://img.shields.io/github/stars/modern-python/compose2pod)](https://github.com/modern-python/compose2pod/stargazers)
10+
[![Context7](https://img.shields.io/badge/Context7-docs-blue)](https://context7.com/modern-python/compose2pod)
11+
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
12+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
13+
[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
14+
315
Convert a Docker Compose file into a POSIX `sh` script that runs its services as a **single Podman pod**.
416

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

planning/deferred.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
Real-but-unscheduled items, each with a revisit trigger.
44

5+
## Add the compose2pod brand lockup to the README header
6+
7+
Sibling org repos (`db-retry`, `eof-fixer`, `semvertag`, …) open their README
8+
with a centered brand lockup (`<picture>``modern-python/.github`
9+
`brand/projects/<name>/lockup-{dark,light}.svg` + `lockup.png`) above the badge
10+
row. compose2pod's README carries the badges but no lockup: the `.github`
11+
repo's `brand/build/projects.py` `MANIFEST` has no `compose2pod` entry, so no
12+
glyph or lockup asset is generated for it. Adding one requires designing a
13+
distinctive gold inner symbol (a `sym.compose2pod(...)` in the brand build),
14+
regenerating assets, and shipping that in a `.github` PR — brand design that
15+
needs the org owner's sign-off.
16+
17+
**Revisit trigger:** the org owner approves a compose2pod brand glyph, or a
18+
`.github` PR adds `compose2pod` to the brand `MANIFEST` and regenerates the
19+
lockup assets. Then wire the `<picture>` block above the badges (dropping the
20+
`# compose2pod` H1) to match siblings.
21+
522
## Harden the pod-cleanup trap's nested `shlex.quote` for the `emit_script` library path
623

724
`emit.py`'s `EXIT` trap quotes the pod name with a nested `shlex.quote` inside

0 commit comments

Comments
 (0)