[Distutils] Data files with setuptools

Adeel Ahmad Khan adeel2 at umbc.edu
Mon Jul 27 18:29:59 CEST 2009


> The README is not "package data" because it's not inside a package.  You
> can't install package data in a project that only includes modules.  In any
> case, there's no point in shipping documentation inside an egg, because only
> your project's *code* will be able to read it, not humans.  Human-readable
> documentation only belongs in a source distribution.

I'm writing a command-line program and I was using the README to print
help.  Should I just copy the README into my module then or is there a
better way?

> Note that, in general, you do not need to distribute eggs for your project.
>  The egg format is intended for plugins and other situations that require
> pre-built, ready-to-execute binaries.

I'm not distributing eggs myself but they're generated by distutils /
setuptools when I do python setup.py install or easy_install.  I'm new
to packaging and pretty confused so I'm possibly doing it wrong.
Here's my project on github, if you'd be willing to take a look:
<http://github.com/adeel/timed/tree/master>.

Thanks.


More information about the Distutils-SIG mailing list