What it is `long_description` is generally, most applicably, what gets put on the project's pypi page.
Sometimes this is exactly the same thing as what you want on your project's general "read me" text, sometimes not. For example, the two are different for flask, virtualenv, setuptools, sopel, numpy But as for django there are also many examples where the two are the same - pip, tornado, etc, etc. I have trouble finding an objective reasoning that one method is to be objectively preferred over the other. I think it can vary a lot given the size and scale of the project, its nature, application vs library, etc. Sometimes someone might prefer their README as a plain txt file, or maybe in markdown. However a `long_description` is always parsed as rst, at least for the present. So there is at least one possible reason. It's possible maybe the text in DESCRIPTION.rst could be changed to indicate the possibilities better. We always want to balance this with keeping `sampleproject` as simple as possible to make it practical and immediately useful, rather than overly technical. Cheers, Matt Matt Iversen // matt at notevencode.com PGP: 0xc046e8a874522973 // 2F04 3DCC D6E6 D5AC D262 2E0B C046 E8A8 7452 2973 On 27/09/2015 8:20 PM, Thomas Güttler wrote: > 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 > https://github.com/pypa/sampleproject/blob/master/setup.py > > 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? > > Regards, > Thomas Güttler > > > > >
signature.asc
Description: OpenPGP digital signature
_______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
