[Distutils] Best practices on distributing documentation and examples with eggs?

Barry Warsaw barry at python.org
Thu Jul 26 20:55:29 CEST 2007


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Jul 26, 2007, at 11:52 AM, Phillip J. Eby wrote:

> There are a few different ways you could do this.  The easiest would
> be to put a docs subdirectory either inside one of your packages or
> inside your .egg-info directory, then use the pkg_resources resource
> or metadata APIs to list and extract them.  One advantage to using
> something like .egg-info/docs would be that this could perhaps be
> recognized by some sort of "standard" tools in the future.

I always thought .egg-info was just an artifact of the build.   
Recommending that things get put there means it should get version  
controlled.  But I've found that occasionally I have to blow  
away .egg-info files to get 'setup.py develop' to work properly (i.e.  
like a 'make clean' step).

- -Barry

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.7 (Darwin)

iQCVAwUBRqjuInEjvBPtnXfVAQJLrAP/S/q2EFM7gnokBTsdgoEjXXn1LXtEWwkP
OJaPu4a0jymVy7+R0o9eGXSorOaAO0vN/ay7LGXvkllWTv0pOLa6aQ01cQlEuuhk
GLdw+eLVOKmTWnhv4448YhgD/r74ywBWJ9rYD+Ygg93bNHbyTZU/zaoCc2SLpzYq
CrVpeK4ArBM=
=KfaK
-----END PGP SIGNATURE-----


More information about the Distutils-SIG mailing list