python-poetry / python-poetry/poetry

Use `poetry.toml` everywhere instead of `config.toml` in some places and `poetry.toml` in other

Open
#8,847 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/feature status/triage
Dominant language
Python
Stars
34.3k
Forks
2.5k
Avg merge
2d 19h
Merged PRs (30d)
30

Description

I encountered some confusion while reading the documentation for Poetry's configuration (https://python-poetry.org/docs/configuration/). The documentation states:

Poetry can be configured via the config command (see more about its usage here) or directly in the config.toml file that will be automatically created when you first run that command.

Initially, I interpreted this to mean that a config.toml file was required in my project repository for local configuration. However, I noticed that running poetry config with the --local flag actually generates a poetry.toml file, not a config.toml.

While this discrepancy might not significantly impact the usage of global configuration, which is often accessed programmatically rather than manually, it can lead to confusion due to the inconsistency in file naming conventions for different configuration scopes.

I propose standardizing the configuration file name to poetry.toml for local and global configurations. My reasons for this preference are:

  • File Sorting: poetry.toml aligns alphabetically with poetry.lock, facilitating file organization.
  • Explicit Naming: poetry.toml is clearly associated with Poetry, reducing potential conflicts with other tools that might also use a generic config.toml.

This standardization could enhance clarity and consistency in Poetry's configuration process.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the configuration documentation and CLI config documentation linked in the issue, then compare the documented config.toml behavior with the file generated by poetry config --local. Check the existing configuration handling and documentation references for both names; done means the naming is consistent across the relevant behavior and documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.