Skip to content

org-profile.md

Latest commit

 

History

History
51 lines (43 loc) · 2.61 KB

org-profile.md

File metadata and controls

51 lines (43 loc) · 2.61 KB
Raw

Org profile README

profile/README.md is the org landing page shown on github.com/modern-python. Living prose, no frontmatter; dated by git.

Structure (top to bottom)

  1. Wordmark banner — centered <picture> (light/dark) referencing brand/org/wordmark[-dark].svg by absolute raw.githubusercontent.com URL.
  2. Tagline — one paragraph: what the org builds.
  3. Org-standards badge strip — uv, Ruff, ty (Astral endpoint badges, live) and a static coverage 100% badge. The coverage claim holds org-wide because every repo's CI enforces a 100%-coverage guard; it renders unlinked (there is no org-level coverage URL).
  4. Four category tables, in order: Project templates, Dependency injection, Microservices, HTTP & messaging, Utilities. The What it is column carries the canonical ≤120-char one-liner (one of the three metadata surfaces kept consistent across GitHub description, pyproject description, and this blurb). The three published-library tables (DI, microservices, utilities) share the shape Project | What it is | Stars | Downloads; the templates table is Project | What it is | Stars.

Row ordering

Within the Dependency injection table, integrations sort alphabetically, with two fixed anchors: modern-di (the core) stays first and that-depends (the earlier framework) stays last. The same order holds across the docs-site DI list and projects.py::MANIFEST. A new integration therefore slots into its alphabetical position with no insertion-point decision to make.

Badge rules

  • Published libraries get a Stars shield → stargazers, and a monthly Downloads shield (static.pepy.tech/badge/<pkg>/month) → the pepy project page.
  • A repo may be listed before its package reaches PyPI. Its Downloads badge 404s until the package is published and pepy indexes it; the Stars badge and repo link resolve meanwhile. This lag is self-healing — note it, don't block the listing on it.
  • Templates (*-sqlalchemy-template, not on PyPI) get a Stars shield only — they have no Downloads column, and their table stops after Stars rather than carrying a filler chip.
  • All badges use flat (default) style so row heights align. Downloads use the pepy baked SVG, not the flaky shields pypi/dm endpoint. Every number is a live shield (no hand-typed stats that could go stale).
  • PyPI distribution name equals the repo name for every package.

When a repo is added, removed, renamed, or unpublished, update the matching table row here and in profile/README.md in the same PR.