-
Notifications
You must be signed in to change notification settings - Fork 224
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
Exclude dvc related files from source distribution #1086
Comments
As you mentioned in #999 (comment)_:
I think we should move towards trimming the size of the PyPI sdist (.tar.gz) and bdist (.whl) down to less than 1MB. This would mean that
Yep, we should update the MANIFEST.in file to exclude these |
Matplotlib includes all baseline images in their source tarballs (~40 MB) (https://pypi.org/project/matplotlib/#files), but not in wheels (~10 MB). They recommend users to download the source tarball and extract the test codes and baseline images before doing tests (https://matplotlib.org/stable/users/installing.html#test-data).
Perhaps it's simpler to just upload the baseline images as GitHub release assets. |
These images are included in the source distribution because of the following line: Line 21 in 74c9366
|
Here are the rules about which files are included in the source distributions:
In the "Publish to PyPI" workflow, we don't run the In the "Tests" workflow, we run the So, the only thing we need to do is adding After we finish the migration of all baseline images, the source distribution will only contain the Ideally, we should also exclude |
The new workflow in #1036 adds more files into the git repository and some files are included in the source distribution by default.
Run
make package
and check the files in the tarballdist/pygmt-X.Y.Z.tar.gz
.I see some new files in the source distribution:
.dvc
.dvcignore
pygmt/tests/baseline/*.dvc
Some DVC images (e.g.,
pygmt/tests/baseline/test_logo.png
) are also included in the tarball although they should be ignored by git and excluded from the source distribution by default.A related question is: do we want to include the baseline images in the source distribution?
The text was updated successfully, but these errors were encountered: