-
Notifications
You must be signed in to change notification settings - Fork 954
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
feat: add PEP 621 config only #1031
Conversation
LGTM, but I don't manage this site. 😁 |
Maybe it was harder to notice because of the draft status? I took the draft off, maybe that would help. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that we need to wait for the setuptools PR to be complete. Also, I feel like there may be links on the internet pointing to this document in the context of setuptools that may become misleading. Not sure what we can do about that, though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Echoing other comments here and in #1030, I appreciate the effort, but I think we should wait for pypa/setuptools#2671. With that in mind, I'm wondering if someone could open a PR that updates this tutorial as if setuptools had support for PEP 621. In addition to being proactive instead of reactive, it might serve as an additional validation of the work in setuptools.
I think having the tabs (with setuptools emphasized as the first tab) is probably fine - this is meant to be a general packaging tutorial, and for many users, Flit is likely a great way to get started, it's light and much faster than setuptools, and isn't struggling with the distutils drop like setuptools 60+ currently is. Having tabs indicates that this is a general tutorial rather than a specific, one tool only thing, and seems to be the direction we are moving. If we really can do the tutorial identically for each of at least setuptools and Flit (optionally PDM too), then I think that would be helpful for setuptools as well - it would provide motivation to make sure that custom |
I've added setuptools, and tried to bundle any discussion about backends into the tabs. Someone reading the tutorial would just see setuptools unless they try to select a different tab. PEP 621 configuration is now shown in the Scikit-HEP developer docs, BTW. No tabs there since we don't have those set up. https://scikit-hep.org/developer/pep621. The "regular" page there will become a binary (probably scikit-build) packing guide eventually. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for continuing to chip away at this, in spite of naysayers like myself. It's helpful to have something concrete to react to, and I'm optimistic that some collaboration will lead to a polished final version.
acf5f85
to
e7bd320
Compare
194584f
to
a9ffb47
Compare
a9ffb47
to
114abec
Compare
114abec
to
2feeafa
Compare
Co-authored-by: Brett Cannon <brett@python.org>
I've matched the package name and module name. I've also standardized on using |
Guessing the build is broken by pypa/pip@347e724 . |
This ensures that they don't show up in the table of contents sidebar, which is part of the point of moving this content into dedicated pages.
FWIW, I see on the preview it says:
I'm not sure if the omission was done on purpose, but |
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
This has been fixed. |
2c417f9
to
688b740
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It brings me great pleasure (and relief) to approve this. Further refinements are welcome in future PRs. Thanks @henryiii for pushing this forward, and everyone who contributed to the conversation.
|
||
.. code-block:: toml | ||
:file:`pyproject.toml` tells tools "frontend" build tools like :ref:`pip` and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wording issue: tools frontend build tools
Based on the following discussions: - pypa/packaging.python.org#1031 (comment) - pypa/packaging-problems#604 it seems that people are having a hard time finding information about validation error due to the long traceback and debug info. The idea behind this change is to make the most relevant information to fix the error easier to spot.
This is a simpler, PEP 621 only version of #1030. Might not be ready to go this route, but this would be what I think we could do.
Also, I'd love to move this over to using pipx. That would really simplify the ending commands (building and publishing), and would remove the unix/windows split from everything except the first line, where pipx would be installed.
Update from @bhrutledge:
Merging is currently blocked on changing the example package name to support backend discovery; see discussion in #1031 (comment). Until that's fixed, the tutorial is broken. Further content improvements can be made in future PRs. Closes #1085.