Re: [Distutils] README file format and pypi.python.org
I added the use of README to catch all the github users who weren't filling in their long_description (but also weren't using Markdown - I just didn't find the time to also add something to detect Markdown and render it). On 23 September 2013 08:01, Chris Jerdonek wrote: > On Sun, Sep 22, 2013 at 2:15 PM, PJ Eby wrote: > > On Sun, Sep 22, 2013 at 9:01 AM, Paul G. > wrote: > >> 1. What format should I use in my README.txt file for my package's > content > >> to be displayed on its package page? > > > > It's not the README file; it's the package's "long_description" > > keyword, as specified in your setup.py setup() call. And the format > > is reStructuredText > > For the record, the Python documentation covers this aspect of PyPI: > > http://docs.python.org/distutils/packageindex.html#pypi-package-display > > It also includes some troubleshooting info. However, it doesn't > include anything about PyPI reading README.rst, etc if > long_description isn't available (which maybe should be added). > > --Chris > ___ > Distutils-SIG maillist - Distutils-SIG@python.org > https://mail.python.org/mailman/listinfo/distutils-sig > ___ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
Re: [Distutils] README file format and pypi.python.org
On Sun, Sep 22, 2013 at 2:15 PM, PJ Eby wrote: > On Sun, Sep 22, 2013 at 9:01 AM, Paul G. wrote: >> 1. What format should I use in my README.txt file for my package's content >> to be displayed on its package page? > > It's not the README file; it's the package's "long_description" > keyword, as specified in your setup.py setup() call. And the format > is reStructuredText For the record, the Python documentation covers this aspect of PyPI: http://docs.python.org/distutils/packageindex.html#pypi-package-display It also includes some troubleshooting info. However, it doesn't include anything about PyPI reading README.rst, etc if long_description isn't available (which maybe should be added). --Chris ___ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
Re: [Distutils] README file format and pypi.python.org
On Sep 22, 2013, at 5:15 PM, PJ Eby wrote: > On Sun, Sep 22, 2013 at 9:01 AM, Paul G. wrote: >> 1. What format should I use in my README.txt file for my package's content >> to be displayed on its package page? > > It's not the README file; it's the package's "long_description" > keyword, as specified in your setup.py setup() call. And the format > is reStructuredText > >> 2. Do I have to use a different extension for the README? > > It doesn't matter, since the README is not read by PyPI. (You can put > code in your setup.py to read the file into the long_description > field, though. Take a look at other packages' setup.py files to see > how they do it.) > ___ > Distutils-SIG maillist - Distutils-SIG@python.org > https://mail.python.org/mailman/listinfo/distutils-sig Oops, I missed this, in some cases PyPI will read a README.rst (maybe a .txt too), typically if a long_description is not available. - Donald Stufft PGP: 0x6E3CBCE93372DCFA // 7C6B 7C5D 5E2B 6356 A926 F04F 6E3C BCE9 3372 DCFA signature.asc Description: Message signed with OpenPGP using GPGMail ___ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
Re: [Distutils] README file format and pypi.python.org
On Sun, Sep 22, 2013 at 9:01 AM, Paul G. wrote: > 1. What format should I use in my README.txt file for my package's content > to be displayed on its package page? It's not the README file; it's the package's "long_description" keyword, as specified in your setup.py setup() call. And the format is reStructuredText > 2. Do I have to use a different extension for the README? It doesn't matter, since the README is not read by PyPI. (You can put code in your setup.py to read the file into the long_description field, though. Take a look at other packages' setup.py files to see how they do it.) ___ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
[Distutils] README file format and pypi.python.org
Hi everyone, While playing around with packaging using Distutils2-py3, I created a package called PyIdGen https://pypi.python.org/pypi/PyIdGen and added README.txt file. I have seen that some packages have their documentation embedded into the packages' corresponding package pages @ pypi.python.org. For example, the 'py-postgresql 1.1.0' module @ 'https://pypi.python.org/pypi/py-postgresql/1.1.0' has its documentation on its package page. A few questions: 1. What format should I use in my README.txt file for my package's content to be displayed on its package page? 2. Do I have to use a different extension for the README? Regards, Paul G.___ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
