poetry icon indicating copy to clipboard operation
poetry copied to clipboard

doc(faq): add entry for PEP 621 migration

Open abn opened this issue 11 months ago • 2 comments

Summary by Sourcery

Documentation:

  • Add a new FAQ entry detailing the migration process from the tools.poetry section to the project section in pyproject.toml as per PEP 621.

abn avatar Jan 08 '25 15:01 abn

Reviewer's Guide by Sourcery

This pull request adds a comprehensive FAQ entry in the documentation to guide users on migrating their Poetry projects from the 'tools.poetry' section to the new 'project' section as outlined in PEP 621. It includes examples and notes on handling dynamic and static dependencies.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new FAQ entry for migrating an existing Poetry project to use the new 'project' section as per PEP 621.
  • Introduced a new FAQ section explaining the migration process from 'tools.poetry' to 'project' section.
  • Provided a detailed example of the original 'pyproject.toml' configuration using 'tools.poetry'.
  • Included examples of 'pyproject.toml' configurations using dynamic and static dependencies under the 'project' section.
  • Added notes explaining the dynamic properties for 'classifiers' and 'dependencies', and the replacement of 'python' dependency with 'project.requires-python'.
  • Highlighted the addition of 'requires-poetry' in the 'tools.poetry' section.
docs/faq.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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a 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. You can also use this command to specify where the summary should be inserted.

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

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Jan 08 '25 15:01 sourcery-ai[bot]

Deploy preview for website ready!

✅ Preview https://website-gxvawal8c-python-poetry.vercel.app

Built with commit 03006eb40c163c03c8d8f44b1079cf7efe1087d7. This pull request is being automatically deployed with vercel-action

github-actions[bot] avatar Jan 08 '25 15:01 github-actions[bot]

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.

github-actions[bot] avatar Feb 09 '25 00:02 github-actions[bot]