Skip to content

Comments

Improve example in README.md#10731

Merged
radoering merged 4 commits intopython-poetry:mainfrom
mwtoews:better-readme
Feb 14, 2026
Merged

Improve example in README.md#10731
radoering merged 4 commits intopython-poetry:mainfrom
mwtoews:better-readme

Conversation

@mwtoews
Copy link
Contributor

@mwtoews mwtoews commented Feb 13, 2026

This PR improves the example in the main README.md page:

  • Add build-system to the top. This was missing before, but is increasingly important to specify with modern Python ecosystems.
  • Update license and add license-files, as documented here

Summary by Sourcery

Update the README’s pyproject.toml example to reflect current recommended Poetry configuration.

Documentation:

  • Document the required Poetry build-system section in the example pyproject.toml.
  • Clarify license configuration in the example by switching to the string form and adding license-files.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 13, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README’s pyproject.toml example to reflect modern Poetry/PEP 517 metadata, adding an explicit build-system section and adjusting license-related fields to match current Poetry documentation.

Flow diagram for updated pyproject_toml structure in README example

flowchart TB
    A[pyproject_toml] --> B[build_system]
    B --> B1[requires
poetry_core>=1.0.0]
    B --> B2[build_backend
poetry.core.masonry.api]

    A --> C[project]
    C --> C1[name
my-package]
    C --> C2[version
0.1.0]
    C --> C3[description]
    C --> C4[readme
README.md]
    C --> C5[license
MIT]
    C --> C6["license_files
[LICENSE]"]
    C --> C7[requires_python
>=3.9]
Loading

File-Level Changes

Change Details Files
Modernize the pyproject.toml example in the README to include build-system metadata and updated license fields.
  • Add a [build-system] table specifying poetry-core as the build backend and requirement.
  • Replace the inline license text table with a simple license string field.
  • Add a license-files field pointing to the LICENSE file.
  • Keep the rest of the project metadata example (name, version, description, readme, requires-python) unchanged.
README.md

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

Copy link

@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 found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `README.md:32` </location>
<code_context>
+license = "MIT"
+license-files = ["LICENSE"]
+
 # No python upper bound for package metadata
 requires-python = ">=3.9"

</code_context>

<issue_to_address>
**nitpick (typo):** Consider capitalizing "Python" in this comment.

Change `python` to `Python` in the comment for consistency with the rest of the documentation.

```suggestion
# No Python upper bound for package metadata
```
</issue_to_address>

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.

mwtoews and others added 3 commits February 14, 2026 13:26
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@radoering radoering merged commit 295a7a0 into python-poetry:main Feb 14, 2026
54 checks passed
@mwtoews mwtoews deleted the better-readme branch February 14, 2026 17: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