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

packaging: include tox.ini in source distribution (sdist) #3269

Merged
merged 2 commits into from
Aug 13, 2024

Conversation

pajod
Copy link
Contributor

@pajod pajod commented Aug 12, 2024

Argument from authority: See what setuptools does & documents: https://github.com/pypa/setuptools/blob/1d2fd37368fc2381e21cd5466aeb222fc11db2db/MANIFEST.in

Confirmation:

$ python -m build
$ tar -tf dist/gunicorn-*.tar.gz | grep tox
gunicorn-23.0.0/tox.ini
  • note: if ever using setuptools-scm: .gitattributes / MANIFEST.in precedence could undo this change
  • cost is minimal, as the files are tiny and most people will download the wheel package instead.

tox testing works without full git repo, so no obvious harm in
aiding people running it from source distribution

based on setuptools itself doing it, and suggesting so in an example in
docs:
https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html#controlling-files-in-the-distribution
pypa/setuptools@551eb7f

beware of .gitattributes / MANIFEST.in precedence when using setuptools-scm
undo when .pylintrc is moved into pyproject.toml (which is only
supported since pylint 2.5.3+ @ 2020-06-8)
@benoitc benoitc merged commit 903792f into benoitc:master Aug 13, 2024
24 checks passed
@jayaddison

This comment was marked as resolved.

@jayaddison

This comment was marked as resolved.

@pajod pajod changed the title packaging: include tox.ini in sdist packaging: include tox.ini in source distribution (sdist) Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

sdist is missing tox.ini
3 participants