Skip to content

Conversation

@avendesora
Copy link
Owner

@avendesora avendesora commented Dec 31, 2025

Description

Updated pythonbible package README.md to be a copy of the main project README.md (for now) so that it displays in PyPI correctly.

Checklist:

  • I have read the CONTRIBUTING document.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have run pre-commit locally prior to submission and fixed any errors/warnings.
  • I have run tests locally prior to submission and they are passing.
  • I have added necessary documentation (if appropriate).
  • I have updated the README (if appropriate).
  • I have updated the CHANGELOG (if appropriate).
  • I have updated the version number (if appropriate).
  • I have updated the requirements (if appropriate).

Summary by Sourcery

Update the pythonbible package metadata and documentation for a new patch release.

Bug Fixes:

  • Ensure the package-level README mirrors the main project README so it renders correctly on PyPI.

Enhancements:

  • Bump project version to 0.15.2 across packaging and documentation metadata.
  • Update changelog links and entries for the 0.15.2 release.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 31, 2025

Reviewer's Guide

Synchronizes the pythonbible package README with the main project README so it renders correctly on PyPI, and performs the corresponding version and changelog updates for a 0.15.2 patch release.

File-Level Changes

Change Details Files
Add a full README for the pythonbible package so that the PyPI project page renders correctly.
  • Create/populate the package-level README with the same content as the main project README, including feature overview, examples, and badges.
  • Ensure markdown/HTML constructs (tables, code blocks, badges) are compatible with PyPI rendering.
pythonbible/README.md
Introduce a 0.15.2 patch release entry and update changelog comparison links.
  • Add a 0.15.2 section under Unreleased describing the README packaging fix.
  • Update the [unreleased] comparison link to start from v0.15.2.
  • Add a new [0.15.2] comparison link and adjust nearby version comparison references (worth double-checking for correct tag ranges).
CHANGELOG.md
Bump the project version to 0.15.2 across config and docs and refresh lockfile metadata.
  • Update the Sphinx docs configuration to report release 0.15.2.
  • Update the pyproject project.version field to 0.15.2 so the published package carries the new version.
  • Adjust package initialization/metadata as needed for the new version (exact change not shown in diff).
  • Regenerate or update the uv.lock file to reflect the new project state.
docs/source/conf.py
pythonbible/pyproject.toml
pythonbible/pythonbible/__init__.py
pythonbible/uv.lock

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

@codacy-production
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% 100.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (0ad56f0) 2085 2085 100.00%
Head commit (c6be7f2) 2085 (+0) 2085 (+0) 100.00% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#227) 1 1 100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

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!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@avendesora avendesora merged commit 6a1b18d into main Dec 31, 2025
8 of 9 checks passed
@avendesora avendesora deleted the fix-pythonbible-package-readme branch December 31, 2025 22:51
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.

2 participants