[Distutils] PEP 345 - 3 new fields

[Tarek Ziadé]

On Mon, Nov 30, 2009 at 1:20 PM, Ben Finney <ben+python at benfinney.id.au> wrote:
> Tarek Ziadé <ziade.tarek at gmail.com> writes:
>
>> On Sun, Nov 29, 2009 at 10:32 PM, Ben Finney <ben+python at benfinney.id.au> wrote:
>> > […] I thought we'd just agreed in this thread: that the changelog
>> > should be *in a separate file*. Putting it into one field among many
>> > ignores the fact that it's often long, and growing every release.
>>
>> It can be a file of course in your distribution, but at the end, it
>> has to be a field in the metadata,
>
> I don't understand the distinction you're making here. What is the
> difference between “in your distribution” versus “in the end”?

You have to make a distinction between the "long_description" option
in setup.py, and the "Description" metadata field, that lands in the
PKG-INFO file (==PEP 345 fields)

The PKG-INFO file, that contains all the metadata, is built by a call
to "python setup.py sdist" for example , is shipped within your
distribution, and read for instance by PyPI.

IOW, if we are going to add a distinct field for "Changelog", this
will not be a file path, but an URL *or* a raw text exactly like the
"Description" field.

Having a file for your changelog, that you are reading and using to
fill a metadata field is just a implementation detail.


Regards
Tarek