-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document setuptools.build_meta #1698
Comments
@pganssle Hello! I'd like to look into this one. Looks like a good challenge to take on! |
@ErikPohl-Lot49-Projects Sounds great! This is very important. I will be happy to review as soon as you have a draft. |
@pganssle |
@pganssle |
I take it work on this has stalled? (I just tried to find the docs on PEP 517 support in setuptools and came up empty-handed and then found this issue.) |
And a note in the docs that skipping |
Hello! Just a trivial note, the |
I read pypa/setuptools#1698, and a side effect of source root not being in sys.path is mentioned: probably that is related to PyInstaller and other things so I left a commented out thing in setup.py b/c odds seem high that will effect us.
I found this via @brettcannon's blog post re: It looks like there is now some documentation, albeit with room for improvement:
Of course, thanks to everyone who's written about this so far. It's very helpful! |
Also the promise of a list of Resources on Python packaging is a bit of a tease 😅. Would be great if somebody could stick in some links to resources. |
I think a note/warning about the following should be added to the documentation as well: The installation of a PEP517-style package via the TestPyPI infrastructure is likely to fail. Since the failure is unexpected and not present if the package is later installed via real PyPI, I recommend that some note is dropped about this until the issue is fixed otherwise. Newbs (like me) might run quickly into such issues because the use of TestPyPI is advertised in popular packaging tutorials. |
Hi, is this issue still open for work? Currently I am trying to package a Python project with Rust extensions, and I am finding existing documentation to be sorely lacking, in that most tutorials/guides describe the old way of using |
Hi @codeandfire please feel free to submit PRs, documentation improvements are always welcome! I just recomend discussing your ideas first if they are very big or disruptive (e.g. removing/moving documentation pages). |
@abravalheri Sure, I do understand. I don't think I want to remove/move anything at the moment, I'm intending to add to the existing documentation and will submit PRs accordingly. |
I think the original topic in this issue has been covered, and it can be closed? Separately, I opened a discussion proposing moving/removing several pages at #3400 |
There is currently no documentation for
setuptools.build_meta
!We need to cover:
pyproject.toml
to your source root with the following configuration (implementer - please confirm the right versions to pin):setuptools.build_meta
differ from directly invokingsetup.py
; at the moment, the only deliberate difference is that withsetuptools.build_meta
, the source root is not onsys.path
when 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.py
file.setup.cfg
-only project, when usingpyproject.toml
setup.py
is now optional!We can cover
setuptools.build_meta:__legacy__
in this ticket or in a separate one.The text was updated successfully, but these errors were encountered: