neuroinformatics-unit / python-cookiecutter

Utility to create a basic Python project structure with tests, CI etc.
BSD 3-Clause "New" or "Revised" License
20 stars 3 forks source link

MANIFEST.in may not be needed with setuptools_scm #32

Closed niksirbi closed 9 months ago

niksirbi commented 1 year ago

I have stumbled upon some information that MANIFEST.in is no longer needed when using setuptools_scm. This is because setuptools_scm, by default includes all version-controlled files in the sdist. To learn more about this see the following:

Thought @adamltyson ? Getting rid of MANIFEST.in would mean that all git-tracked files (and only those) are included in the sdist. Is that a sensible thing to do?

If we don't get rid of it, I am not sure we still get the behaviour we want, due to how this interacts with setuptools_scm (see the linked issue)

adamltyson commented 1 year ago

I think we need to look into this, because there's lots of stuff that's in the repo that's shouldn't be in the sdist (test data in particular). I read the blog that states everything in the repo should be in sdist, but I don't agree. The sdist isn't used for development, it's used for installation when there's no wheel available.

I think we'll always need to tool to determine what gets packaged and what doesn't.