python-poetry / python-poetry/poetry
Explenation / documentation for tools.poetry.build in pyproject.toml
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
Please add a short documentation to explain the section
[tool.poetry.build]
script = "build.py"
generate-setup-file = true
when building a C Extension.
The braking changes from 1.2 to 1.3 destroyed some of my configurations and repairing them was more anoying that it could have been with a proper documention of this section.
Possibly a short exert out of this?
https://github.com/Lucky-Mano/Poetry_C_Extension_Example/blob/master/pyproject.toml
I really like what you all are doing for the python comunity!
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 by reviewing the [tool.poetry.build] section in pyproject.toml and the linked Poetry_C_Extension_Example pyproject.toml. Document the script and generate-setup-file options in the context of building a C extension, including the relevant 1.2-to-1.3 configuration change; the issue is done when the section is understandable without consulting external examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100