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

[Barry Warsaw]

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

On Jul 26, 2007, at 3:44 PM, Phillip J. Eby wrote:

> At 02:55 PM 7/26/2007 -0400, Barry Warsaw wrote:
>
>> 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.
>
> No - it's also a place for metadata that doesn't live under a  
> specific package directory.
>
>> Recommending that things get put there means it should get version
>> controlled.
>
> Yep.
>
>
>>   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).
>
> Really?  I'd consider that to be a bug.  Could you perhaps be more  
> specific?

Now that I know that, I'll investigate further next time I see  
something 'weird'.  I'll keep you posted.

> Note that if you are using a revision control system, and  
> setuptools deletes a file from there, it might get restored by your  
> revision control, and that could potentially be a problem unless  
> you also manually delete the file.

When does setuptools delete a file there?

- -Barry

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

iQCVAwUBRqj/BXEjvBPtnXfVAQICXQP9F4Iv3ew0BufrhfZt1WYUCnqNF08DiXCK
xSvX2KrCc3vV6Z67kFNHJsdAZnJzQR8N0x2n82TXo/q0/36Jcpyt8rp7dIdvD93I
mDZtyyk2cFxuRW78xOtYw3lpUL75e1YbVMzSyhjwaXMdnKNYTfqRyfHkaR/dBz0H
hKbHNuroUWg=
=/4VX
-----END PGP SIGNATURE-----