[Distutils] README(.txt)?

[Jim Fulton]

On Jun 28, 2006, at 4:56 PM, Phillip J. Eby wrote:

> At 04:37 PM 6/28/2006 -0400, Jim Fulton wrote:
>
>> If I don't have a README or README.txt file next to my setup.py file
>> when I create an edd, I'll get the warning:
>>
>>    warning: manifest_maker: standard file not found: should have one
>> of README, README.txt
>>
>> I don't like warnings.  So I create a REAME,txt file and then
>> generate an
>> egg and, guess what?  It's not included.
>>
>> Bug or feature?
>
> The warning comes from the distutils, in a method that I call to  
> create a source manifest.  I don't know of any way to suppress it,  
> although I'll look again.  In normal distutils usage, you would  
> only see it when doing an "sdist", as it wants a README for the  
> source distribution.

Is the right thing to do to suppress the warning? Or to include the  
README
in the egg?

I'm not clear on what the README is for.  If it contains installation  
instructions for a source distribution, then obviously, it shouldn't  
be included.

FWIW, this is most annoying to me when doing setup.py develop.

Jim

--
Jim Fulton			mailto:jim at zope.com		Python Powered!
CTO 				(540) 361-1714			http://www.python.org
Zope Corporation	http://www.zope.com		http://www.zope.org