[Distutils] PEP 345 - 3 new fields

Tarek Ziadé ziade.tarek at gmail.com
Mon Nov 30 10:20:56 CET 2009

On Sun, Nov 29, 2009 at 10:32 PM, Ben Finney <ben+python at benfinney.id.au> wrote:
> Tarek Ziadé <ziade.tarek at gmail.com> writes:
>> On Sun, Nov 29, 2009 at 3:05 PM, Ben Finney <ben+python at benfinney.id.au> wrote:
>> > Stick to a simple standard of “this file contains the changelog”,
>> > which will let people simply move their existing changelog of
>> > whatever format into that file. Having it in a predictable location
>> > would be a big step forward, and an easy one to enforce.
>> That doesn't differ from what we have today with long_description:
> That ignores what 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,
like long_description is.

Here's an example of what could be done in your setup.py:


   with open('README.txt') as f:
       README = f.read()

   with open('CHANGELOG') as f:
       CHANGELOG = f.read()

   setup(name='foo', ..., long_description=README, changelog=CHANGELOG)



More information about the Distutils-SIG mailing list