Skip to content

Badge Catalog

docs/badges.md is the single source of truth for shared badge templates across the repository README surfaces. Update the named templates here, then run make sync-badges so the root README, the docs landing page, and every public package README publish the same badge contract.

Do not hand-edit badge blocks inside README files. Those files consume the templates below through generated badge sections.

If a README surface needs package links outside the managed badge section, use plain markdown links instead of inline badge markdown.

Generated badge sections always render in this order:

  1. surface summary badges
  2. one line of PyPI badges for the canonical owner packages in the family
  3. one line of GHCR badges for the canonical owner packages in the family
  4. one line of Documentation badges for the canonical owner packages in the family

Alias package README surfaces still prioritize their own distribution badge first, then show the canonical family owner badges so the forwarding target stays visible.

Link policy for GHCR badges is fixed here as part of the contract:

  • the repository-wide GHCR summary badge links to https://github.com/bijux?tab=packages&repo_name=bijux-proteomics
  • per-package GHCR badges link to the package-specific https://github.com/bijux/bijux-proteomics/pkgs/container/... page

Repository Summary

Python 3.11+ License: Apache-2.0 Verify Release PyPI Release GHCR Release GitHub Docs Release GHCR packages Published packages

Package Summary

Python 3.11+ Typing: typed License: Apache-2.0 CI Status GitHub Repository

Family PyPI Badge

{{ distribution_name }}

Family GHCR Badge

{{ distribution_name }}

Family Docs Badge

{{ docs_badge_alt }}