python-poetry / python-poetry/poetry
Document Poetry dependency schema
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 34.3k
- Forks
- 2.5k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 30
Description
- I have searched the issues of this repo and believe that this is not a duplicate.
Issue
Hi! I can't seem to find documentation on the all the available options for a Poetry dependency. It'd be great to have a schema somewhere in the documentation.
For example, platform (added in https://github.com/python-poetry/poetry/commit/20c87bc0e32d26f406576b9819b4078e80ab79d9) is not included in the dependency specification page and is not PEP-0508 compliant so users and consumers (e.g. https://github.com/pdm-project/pdm/issues/1384) do not know what fields can be used.
https://python-poetry.org/docs/dependency-specification seems like the relevant page to add this information
Related to https://github.com/python-poetry/poetry/issues/738, https://github.com/python-poetry/poetry/pull/1207
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 dependency specification page linked in the issue and compare its documented options with the available Poetry dependency fields, including platform. Review the related issue and pull request for prior context. Done means the documentation provides a complete, clear schema of supported dependency options and their usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100