-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Closed
Labels
Needs ImplementationIssues that are ready to be implemented.Issues that are ready to be implemented.documentationgood first issuehelp wantedminor
Description
There is currently no documentation for setuptools.build_meta!
We need to cover:
- What it is - see this three part series for more background on python packaging and PEP 517
- How to use it - you need to add a
pyproject.tomlto your source root with the following configuration (implementer - please confirm the right versions to pin):
[build-system]
requires = ["setuptools >= 40.6.0", "wheel"]
build-backend = "setuptools.build-meta"- How the semantics of a
setuptools.build_metadiffer from directly invokingsetup.py; at the moment, the only deliberate difference is that withsetuptools.build_meta, the source root is not onsys.pathwhen you invoke it, meaning that you should either stop importing things from the local path, or addsys.path.insert(0, os.dirname(__file__))to the top of yoursetup.pyfile. - The fact that, if you are a
setup.cfg-only project, when usingpyproject.tomlsetup.pyis now optional!
We can cover setuptools.build_meta:__legacy__ in this ticket or in a separate one.
jd, CaselIT, cpburnz, dgelessus, EpicWink and 25 more
Metadata
Metadata
Assignees
Labels
Needs ImplementationIssues that are ready to be implemented.Issues that are ready to be implemented.documentationgood first issuehelp wantedminor