[Distutils] README.rst vs DESCRIPTION.rst

Thomas Güttler guettliml at thomas-guettler.de
Sun Sep 27 12:20:51 CEST 2015

Zen of Python:

  There should be one-- and preferably only one --obvious way to do it.

I would like to find a default for the description file of a python package.

The sampleproject uses DESCRIPTION.rst

But I guess it is more common to use README.rst.
For example django uses this file name.

Any good reason to **not** use README.rst but a different
name like DESCRIPTION.rst?

Of course anyone can use the name he wants. I just want an agreement
for the name to make life easier for newcomers.

I will check this mail thread in a week or two and write
a pull request to https://github.com/pypa/sampleproject/blob/master/setup.py
if there is an agreement.

If an agreement was found, which other documents should be updated?

  Thomas Güttler


More information about the Distutils-SIG mailing list