Skip to content

Conversation

@girdharagrawalbro
Copy link

@girdharagrawalbro girdharagrawalbro commented Oct 16, 2025

Adds documentation for poetry init command.

Examples included:

  • Initialize interactively
  • Initialize with project name
  • Initialize with description
  • Initialize with author
  • Initialize with dependencies
  • Initialize with dev dependencies

#18042

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 16, 2025
@dmmqz dmmqz mentioned this pull request Oct 16, 2025
28 tasks

- Create a `pyproject.toml` file with prefilled values:

`poetry init --name {{package_name}} --author {{"Author Name <email@example.com>"}}`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`poetry init --name {{package_name}} --author {{"Author Name <email@example.com>"}}`
`poetry init --name {{package_name}} --author "{{Author Name <email@example.com>}}"`

https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#placeholder-syntax


- Create a `pyproject.toml` file without interaction (use defaults):

`poetry init --no-interaction`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`poetry init --no-interaction`
`poetry init {{[-n|--no-interaction]}}`

https://python-poetry.org/docs/cli/#global-options

@Managor Managor closed this Oct 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants