classification
Title: Perform the same checks as PyPI for Description field
Type: behavior Stage: needs patch
Components: Distutils Versions: Python 3.5
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: alexis, chris.jerdonek, eric.araujo, loewis, nanjekyejoannah, tarek, vstinner, wichert
Priority: normal Keywords:

Created on 2012-07-06 22:41 by chris.jerdonek, last changed 2019-08-12 13:29 by potomak.

Messages (10)
msg164759 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-07-06 22:41
There should be an easy way to check a reST long_description on one's local machine before uploading to PyPI.  The check should use the same rules that PyPI uses, so that passing the check locally ensures that PyPI will convert the description to HTML successfully.

Issue 15231 is related and focuses on the current documentation.  See that issue for some background and ideas.

Also see the corresponding issue filed on the PyPI tracker:

http://sourceforge.net/tracker/?func=detail&aid=3539253&group_id=66150&atid=513503
msg164761 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-07-06 23:02
This easy way exists: “pysetup run check” checks the rst syntax; retitling.

Basically it’s a matter of using the same settings (no file inclusion, etc.) as PyPI and checking the URI schemes.

One maintenance issue is the possible discrepancy between PyPI’s checks and distutils2’s; if the PyPI maintainers agree to announce all changes to catalog-sig it could work (just like for classifiers).
msg164776 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-07-07 02:54
With regard to the maintenance issue, what about the idea of aiming for PyPI to include that logic in a separately packaged module?  Then there would be no need to cut and paste -- just include the right version.

If that were done, depending on how the pysetup change is done, users might be able to use PyPI's latest version even if pysetup was out of synch and hadn't been updated yet.
msg164933 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2012-07-07 20:26
> One maintenance issue is the possible discrepancy between PyPI’s  
> checks and distutils2’s; if the PyPI maintainers agree to announce  
> all changes to catalog-sig it could work (just like for classifiers).

We can certainly try to remember, but I expect this is prone to fail:
the next change may well be five years from now, at which point nobody
remembers that distutils2 also has such a check.
msg213236 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-03-12 10:09
Reclassifying as distutils feature request.
msg222971 - (view) Author: Wichert Akkerman (wichert) Date: 2014-07-13 20:20
Éric is not quite correct: I currently have a package where "python setup.py check" does not show any error, but PyPI still refuses to format my long description. Likewise "python setup.py --long-description | rst2html-2.7.py > /dev/null" also does not reveal any errors or warnings, so I am at a completely loss as to why PyPI refuses to format my documentation.
msg348616 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2019-07-29 11:31
This issue is 7 years old: it's far from being "newcomer friendly", I remove the "Easy" label.
msg348964 - (view) Author: Giovanni Cappellotto (potomak) * Date: 2019-08-03 15:19
Hi Victor,

This is the 3rd issue in a row I found in the "Easy issues" list where you added a comment saying

> I remove the "Easy" label

Why are can I still find these issues in the "Easy issues" list?

Do you mean that you already removed the "Easy" label or that you plan to remove it?
msg348994 - (view) Author: Joannah Nanjekye (nanjekyejoannah) * (Python committer) Date: 2019-08-04 18:19
@Giovanni ,

If you look closely, the issue still has the easy issue label that is why you still see it in the "Easy issues" list. Which means he has not removed the label yet.
msg349470 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2019-08-12 13:18
> Why are can I still find these issues in the "Easy issues" list?

My bad... I only added a comment but forgot to remove the easy keyword. It's now removed ;-)
History
Date User Action Args
2019-08-12 13:29:04potomaksetnosy: - potomak
2019-08-12 13:19:30vstinnersetkeywords: - easy
2019-08-12 13:18:49vstinnersetmessages: + msg349470
2019-08-04 18:19:40nanjekyejoannahsetnosy: + nanjekyejoannah
messages: + msg348994
2019-08-03 15:19:59potomaksetnosy: + potomak
messages: + msg348964
2019-07-29 11:31:06vstinnersetnosy: + vstinner
messages: + msg348616
2014-07-13 20:20:15wichertsetnosy: + wichert
messages: + msg222971
2014-03-12 10:09:30eric.araujosetassignee: eric.araujo ->
messages: + msg213236
components: + Distutils, - Distutils2
versions: + Python 3.5, - 3rd party
2012-07-07 20:26:44loewissetmessages: + msg164933
2012-07-07 02:54:23chris.jerdoneksetmessages: + msg164776
2012-07-06 23:02:26eric.araujosetversions: + 3rd party
title: Provide an easy way to check a reST long_description for PyPI -> Perform the same checks as PyPI for Description field
messages: + msg164761

keywords: + easy
type: behavior
stage: needs patch
2012-07-06 22:41:28chris.jerdonekcreate