Skip to content

docs: add tag and PyPI badges to the README - #49

Merged
uniqueg merged 1 commit into
devfrom
docs/readme-tag-pypi-badges
Nov 1, 2026
Merged

uniqueg merged 1 commit into
devfrom
docs/readme-tag-pypi-badges

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

Summary

Adds the tag and PyPI badges to the README, as in FOCA's (same labels, colour and order before the DOI badge):

  • tag: latest meta package tag, filtered with foca-plugins-v* (the plugins have their own tags); links to the releases;
  • PyPI: the meta package foca-plugins.

Closes #48

Lane

Feather lane (requested by the maintainer): README badges only, no code.

Verification

  • Both shields render: tag: foca-plugins-v0.1.0, pypi: v0.1.0.
  • CI: see checks.

🤖 Generated with Claude Code

Summary by Sourcery

Add release and package status badges to the README.

Enhancements:

  • Add GitHub tag and PyPI release badges to the README, linking to project releases and the foca-plugins package.

Documentation:

  • Update README badge displays and references for the latest filtered project tag and PyPI version.

Show the latest meta package tag (foca-plugins-v*) and the PyPI
release of foca-plugins, as in the FOCA README.

Closes #48

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@uniqueg
uniqueg marked this pull request as ready for review November 1, 2026 14:00
@sourcery-ai

sourcery-ai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates README.md with GitHub tag and PyPI release badges for the meta package, using the requested labels, color, ordering, filtering, and release/package links.

File-Level Changes

Change Details Files
Add release and package-version badges to the README badge set.
  • Add a GitHub tag badge filtered to foca-plugins-v*, linking to project releases.
  • Add a PyPI version badge for the foca-plugins package, linking to its PyPI page.
  • Define the new badge image and destination references while preserving the requested order before the DOI badge.
README.md

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Linked issues

#48 docs: add tag and PyPI badges to the README · 2 of 2 met

# Requirement Status Notes
1 Add a GitHub_tag badge for the meta package tag, filtered to foca-plugins-v* and using the same colour as FOCA. ✅ Met The README badge URL filters for foca-plugins-v* and sets the colour to C39BD3; the badge links to the project releases.
2 Add a PyPI_release badge for the foca-plugins package, using the same colour as FOCA. ✅ Met The README uses the foca-plugins PyPI badge URL with colour C39BD3 and links to the package page.

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@uniqueg
uniqueg merged commit c0dd2f3 into dev Nov 1, 2026
25 checks passed
@uniqueg
uniqueg deleted the docs/readme-tag-pypi-badges branch November 1, 2026 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add tag and PyPI badges to the README

1 participant