fix deprecated parts in pyproject example in README#10479
Merged
radoering merged 4 commits intopython-poetry:mainfrom Aug 2, 2025
Merged
fix deprecated parts in pyproject example in README#10479radoering merged 4 commits intopython-poetry:mainfrom
radoering merged 4 commits intopython-poetry:mainfrom
Conversation
Reviewer's GuideThe README’s pyproject.toml example has been refactored to replace deprecated Poetry-specific syntax with a PEP 621–compliant [project] table, migrating core metadata, dependencies, and auxiliary sections to align with current Poetry documentation. Entity relationship diagram for pyproject.toml sections after the updateerDiagram
PROJECT ||--o{ PROJECT_URLS : has
PROJECT ||--o{ PROJECT_SCRIPTS : has
PROJECT ||--o{ PROJECT_OPTIONAL_DEPENDENCIES : has
PROJECT ||--o{ PROJECT_DEPENDENCIES : has
PROJECT {
string name
string version
string description
dict license
list authors
string readme
string requires-python
list keywords
}
PROJECT_URLS {
string repository
string homepage
}
PROJECT_SCRIPTS {
string my_package_cli
}
PROJECT_OPTIONAL_DEPENDENCIES {
string my-extra
}
PROJECT_DEPENDENCIES {
string aiohttp
string requests
string tomli
string cleo
}
Class diagram for pyproject.toml metadata structure before and after the updateclassDiagram
class ToolPoetry {
<<deprecated>>
name: str
version: str
description: str
license: str
authors: list
readme: list
keywords: list
dependencies: dict
scripts: dict
}
class Project {
name: str
version: str
description: str
license: dict
authors: list
readme: str
requires-python: str
keywords: list
dependencies: list
urls: dict
scripts: dict
optional-dependencies: dict
}
ToolPoetry <|-- Project : migrated to
class ToolPoetryDependencies {
python: str
aiohttp: str
requests: dict
tomli: dict
cleo: dict
pendulum: dict
}
class ProjectDependencies {
python: str
aiohttp: str
requests: str
tomli: dict
cleo: str
pendulum: str
}
ToolPoetry --> ToolPoetryDependencies : dependencies
Project --> ProjectDependencies : dependencies
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @KUHLwasStolen - I've reviewed your changes - here's some feedback:
- The dependencies section still uses [tool.poetry.dependencies]—consider switching it to the PEP 621 [project.dependencies] table to keep the example fully spec-compliant.
- The docs dependencies are defined under Poetry’s group syntax; you may want to migrate them to PEP 621’s [project.optional-dependencies] instead of using [tool.poetry.group.docs.dependencies].
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The dependencies section still uses [tool.poetry.dependencies]—consider switching it to the PEP 621 [project.dependencies] table to keep the example fully spec-compliant.
- The docs dependencies are defined under Poetry’s group syntax; you may want to migrate them to PEP 621’s [project.optional-dependencies] instead of using [tool.poetry.group.docs.dependencies].Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Hey @KUHLwasStolen - I've reviewed your changes and they look great!
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
radoering
requested changes
Aug 2, 2025
…ion recommendations
Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com>
bff3d25 to
85c24e9
Compare
radoering
approved these changes
Aug 2, 2025
radoering
pushed a commit
that referenced
this pull request
Aug 4, 2025
(cherry picked from commit 66cd777)
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
pyproject.tomlexample in the README as it was largely deprecated according to this section of the documentation.A more detailed list of affected fields can be found in issue #10477
The new example should basically be equivalent to the old example, but sticks closer to the documentation's recommendations.
Pull Request Check List
Resolves: #10477
poetry checkSummary by Sourcery
Revise the pyproject.toml example in the README to remove deprecated tool.poetry sections and adopt the PEP 621–compliant [project] table with updated metadata and dependency syntax.
Documentation: