Re: Should an sdist/MANIFEST.in include docs and tests?

Bert JW Regeer <[email protected]> Sun, 9 Sep 2018 17:33:07 -0600
Newsgroups	gmane.comp.python.distutils.devel
Message-ID	<[email protected]>
Speaking as a maintainer of various different packages for the Pylons project, we include the following in our sdists:

- source code for the package
- tests for the package
- documentation for the package

and of course the license/history/changelog/everything you'd theoretically need to create a fork (minus .git). Our sdists are pretty big as a result.

In our wheels we ship:

- source code for the package/software

And nothing else, tests are not included in the wheel. Some people do ship tests with their wheel, but we try not to, to keep wheel sizes small.

It comes down to personal preference, we tend to think that source dist means exactly that, a source distribution.

Bert

> On Sep 8, 2018, at 17:08, Segev Finer <[email protected]> wrote:
> 
> What should really be included in an sdist via MANIFEST.in? Besides the obvious files required for a functioning package (Anything not caught by the default rules required for the package to function that is) and obviously LICENSE.txt and similar.
> 
> A package's source tree, more often than not, includes other files such as documentation, tests, examples, a random assortment of other text files, etc. Should docs & tests, in particular, be included in an sdist via MANIFEST.in? Should other files be added too? Or maybe the sdist should be kept to a minimum?
> 
> This is not clearly discussed in the packaging guide: https://packaging.python.org/guides/distributing-packages-using-setuptools/#manifest-in <https://packaging.python.org/guides/distributing-packages-using-setuptools/#manifest-in>. The sampleproject (https://github.com/pypa/sampleproject <https://github.com/pypa/sampleproject>) does seem to include tests (Well a no-op test) and doesn't include them in the sdist.
> --
> Distutils-SIG mailing list -- [email protected]
> To unsubscribe send an email to [email protected]
> https://mail.python.org/mm3/mailman3/lists/distutils-sig.python.org/
> Message archived at https://mail.python.org/mm3/archives/list/[email protected]/message/BJYGZIMYFA6EQD2OGQ6LCR7YFJL3EE74/

--
Distutils-SIG mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mm3/mailman3/lists/distutils-sig.python.org/
Message archived at https://mail.python.org/mm3/archives/list/[email protected]/message/KLW3SIHL6SXB7BESDS7NRU7RV5AF3BY5/
signature.asc (application/pgp-signature, 833 B)