Skip to content
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

Unnecessary files in the source distribution? #904

Closed
seisman opened this issue Feb 15, 2021 · 2 comments · Fixed by #999
Closed

Unnecessary files in the source distribution? #904

seisman opened this issue Feb 15, 2021 · 2 comments · Fixed by #999
Labels
help wanted Helping hands are appreciated maintenance Boring but important stuff for the core devs
Milestone

Comments

@seisman
Copy link
Member

seisman commented Feb 15, 2021

Running python setup.py sdist will build a PyGMT source distribution in the dist directory (e.g., dist/pygmt-0.3.0.tar.gz.

The tarball contains the PyGMT source codes. Below is the list of top-level files and directories:

.codecov.yml
.github
.gitignore
.pylintrc
AUTHORS.md
AUTHORSHIP.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.txt
MAINTENANCE.md
MANIFEST.in
Makefile
PKG-INFO
README.rst
doc
environment.yml
examples
package.json
pygmt
pygmt.egg-info
pyproject.toml
requirements-dev.txt
requirements.txt
setup.cfg
setup.py
vercel.json

I'm not familiar with Python source distributions, but some files seem unnecessary (e.g., vercel.json, package.json, .github).

Reading the Python package guide, I thought most plaintext files won't be added into the source distribution, unless explicitly specified in the MANIFEST.in file. Perhaps my understanding is wrong.

@seisman seisman added the question Further information is requested label Feb 15, 2021
@weiji14
Copy link
Member

weiji14 commented Feb 16, 2021

Yeah we should fix this by the next release (v0.3.1). Not that we'll reach it anytime soon, but PyPI has a 10GB total project size limit, and a 100 MB project upload limit (i.e. per release/version).

image

@weiji14 weiji14 added this to the 0.3.1 milestone Feb 16, 2021
@weiji14 weiji14 added help wanted Helping hands are appreciated maintenance Boring but important stuff for the core devs and removed question Further information is requested labels Feb 16, 2021
@seisman
Copy link
Member Author

seisman commented Mar 2, 2021

So setuptools_scm includes all files in the source distribution by default.

See https://github.com/pypa/setuptools_scm#file-finders-hook-makes-most-of-manifestin-unnecessary and pypa/setuptools_scm#516.

I think we need to explicitly exclude unnecessary files in the MANIFEST.in file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Helping hands are appreciated maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants