-
Notifications
You must be signed in to change notification settings - Fork 222
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
Explicitly exclude unnecessary files in source distributions #999
Conversation
This file contains 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
weiji14
reviewed
Mar 4, 2021
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
weiji14
approved these changes
Mar 5, 2021
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.
Looks good. Really wish we could leave out the pygmt/tests/baseline
folder full of PNGs to trim down on the package size, but that will come after resolving #963.
FYI, the tarball size can be reduced from 6.2 MB to 600 K if we can remove all baseline images. 😄 |
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
…MappingTools#999) Running `python setup.py sdist` can generate source distributions. When packaging, setuptools_scm includes all files tracked by git. This PR explicitly excludes unnecessary files and directories from the source distributions. Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
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.
Description of proposed changes
In #695, we switched our version manager from versioneer to setuptools-scm.
When building source distributions (sdist), the default behavior was only including files as listed in Python packaging guide. However, setuptools_scm's behavior is to include all files tracked by git (see https://github.com/pypa/setuptools_scm#file-finders-hook-makes-most-of-manifestin-unnecessary), and it seems there is no way to disable it (pypa/setuptools-scm#516).
So, instead of listing files that should be included in the source distributions, now we need to explicitly exclude some files from the source distributions.
Here is the list of files in pygmt v0.2.1 (https://pypi.org/project/pygmt/0.2.1/#files):
Here is the list of files using the
MANIFEST.in
file in this PR:You can run
python setup.py sdist
to build source distributions and check the tarball in thedist
directory.Fixes #904.
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version