python-poetry / python-poetry/poetry
Use `poetry.toml` everywhere instead of `config.toml` in some places and `poetry.toml` in other
Nobody has claimed this yet.
- 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.tomlfile 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.tomlaligns alphabetically with poetry.lock, facilitating file organization. - Explicit Naming:
poetry.tomlis clearly associated with Poetry, reducing potential conflicts with other tools that might also use a genericconfig.toml.
This standardization could enhance clarity and consistency in Poetry's configuration process.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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