asciitree icon indicating copy to clipboard operation
asciitree copied to clipboard

Include docs, tests, and example.py in PyPI tarball.

Open ralphbean opened this issue 7 years ago • 2 comments

Hi!

This would be nice for downstream re-packagers of this (awesome) lib, like Linux distros. We like to pull down the tarball from PyPI just like everybody else, but then it's nice to be able to re-run your test suite before we push the "go" button on a new package update.

Cheers!

ralphbean avatar Sep 13 '16 20:09 ralphbean

Heya,

this is a bit weird but my current practice for all of my packages is to not include docs and tests inside the PyPI release tarball, but publish docs on PythonHosted.org (i.e. PyPI) and leave tests for the devs.

In general that is to avoid headaches - Python packaging is very bad (though in all fairness, many more languages have it way worse) and the less I have to include in the hacky mess that is setuptools, the better.

If you can make a compelling case that this is a good idea and common practice, I will gladly change my way of releasing software though; at the cost of writing a few extra lints for unleash. =)

mbr avatar Sep 13 '16 20:09 mbr

No compelling case from me. It would only add convenience for Linux packagers in Debian, Fedora, etc..

We can pull down upstream tests from git, but it means an extra headache on our side. (We have to identify and encode the place from which to pull the official tarball and then also have to identify and encode the separate place from which to pull tests).

In my mind, it is all simpler if all the bits go with the software everywhere it goes, but ultimately its your project, your preferences. :) No hard feelings if this gets closed without merging.

ralphbean avatar Sep 14 '16 13:09 ralphbean