Repository navigation
docs: correct what the build tools page says about setuptools defaults - #835
Open
simonvanlierde wants to merge 1 commit into
Open
simonvanlierde wants to merge 1 commit into
simonvanlierde wants to merge 1 commit into
Conversation
- setuptools errors when [project] lacks a name or version; only a project with no metadata at all builds as <package>-0.0.0 - the sdist holds a short default file list; setuptools-scm is what adds every tracked file, so say that and how to check an sdist Fixes pyOpenSci#67
✅ Deploy Preview for python-package-guide ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Collaborator
|
Hi @simonvanlierde, Thank you for all of the PRs. I will try to get through them early next week. @shaunagm @lwasser It may make sense to do a virtual hour sprint online in the upcoming weeks to focus on updates to the guide (especially in light of the security fun of this week). Shauna, it might be fun to do an OpenHatch style before and after impact blog post of the update. I've been thinking about how to empower virtual sprints and collect some evidence re: onboarding, impact, etc. We can start simple. Maybe using the community call slot as a recurring triage/contribution sprint (when it isn't being used for the community call). |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi!
This fixes #67. The "Challenges using setuptools" bullets say setuptools builds without a name or version unless the metadata is in
pyproject.toml, and puts every file in the repo into the sdist unlessMANIFEST.inexcludes it. Neither holds today, so I rewrote them along the lines of @abravalheri's answer in the issue.[project]table, setuptools stops with an error when either is missing. Only a project with no metadata at all still builds, as<package>-0.0.0.docs/or.github/. setuptools-scm is what adds every tracked file, which is likely what @lwasser saw. The bullet now says so, and how to check an sdist withtar tzf.Tests:
nox -s docs-testpasses, and so do the translated builds. I checked each claim by building small projects in a container with setuptools 84.2.1 and setuptools-scm 10.3.4.Best,
Simon