[Django] #29373: Provide a description for PyPI
Django
---------------------------------------------+------------------------
Reporter: Florian Apolloner | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 2.0
Severity: Release blocker | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
---------------------------------------------+------------------------
Currently https://pypi.org/project/Django/#description looks pretty empty;
a few sentences there would be nice.
Setting as release blocker so we tackle it before the next release.
--
Ticket URL: <https://code.djangoproject.com/ticket/29373>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Florian Apolloner | Owner: nobody
Cleanup/optimization |
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Florian Apolloner):
* component: Uncategorized => Packaging
* type: Uncategorized => Cleanup/optimization
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:1>
Django
Reporter: Florian Apolloner | Owner: nobody
Cleanup/optimization |
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Claude Paroz):
Shouldn't the description be extracted from setup.py? Or are we talking
about another description here?
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:2>
Django
Reporter: Florian Apolloner | Owner: nobody
Cleanup/optimization |
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Florian Apolloner):
Yes, but we do not set any ''long_description''
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:3>
Django
Reporter: Florian Apolloner | Owner: nobody
Cleanup/optimization |
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Claude Paroz):
Ah yes, thanks. Looks like many projects are using their README content to
fill `long_description`.
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:4>
Django
Reporter: Florian Apolloner | Owner: nobody
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Claude Paroz):
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:5>
Django
Reporter: Florian Apolloner | Owner: nobody
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Claude Paroz):
Could be as easy as:
{{{
diff --git a/setup.py b/setup.py
index 32dfc9d291..0a6ee89ea0 100644
--- a/setup.py
+++ b/setup.py
@@ -1,6 +1,7 @@
import os
import sys
from distutils.sysconfig import get_python_lib
+from pathlib import Path
from setuptools import find_packages, setup
@@ -70,6 +71,7 @@ setup(
author_email='found...@djangoproject.com',
description=('A high-level Python Web framework that encourages '
'rapid development and clean, pragmatic design.'),
+ long_description=Path('README.rst').read_text(),
license='BSD',
packages=find_packages(exclude=EXCLUDE_FROM_PACKAGES),
include_package_data=True,
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:6>
Django
Reporter: Florian Apolloner | Owner: nobody
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Florian Apolloner):
Jupp certainly better than nothing; could you do an upload to
https://test.pypi.org/ so we can see if it renders correctly (you might
need another package name though, Django seems to be claimed already)
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:7>
Django
Reporter: Florian Apolloner | Owner: nobody
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tim Graham):
I don't think we can use `pathlib` if we want `setup.py` to remain Python
2.7 compatible as discussed in 32ade4d73b50aed77efdb9dd7371c17f89061afc
(#28878).
[https://pythonhosted.org/an_example_pypi_project/setuptools.html
pythonhosted.org] suggests:
{{{
def read(fname):
return open(os.path.join(os.path.dirname(__file__), fname)).read()
...
long_description=read('README.rst'),
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:8>
Django
Reporter: Florian Apolloner | Owner: nobody
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* has_patch: 0 => 1
Comment:
[https://github.com/django/django/pull/9918 PR]
On TestPyPI for preview here: https://test.pypi.org/project/Django-
TestPyPI-Upload/
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:9>
Django
Reporter: Florian Apolloner | Owner: nobody
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by GitHub <noreply@…>):
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"2e1f674897e89bbc69a389696773aebfec601916" 2e1f674]:
{{{
#!CommitTicketReference repository=""
revision="2e1f674897e89bbc69a389696773aebfec601916"
Fixed #29373 -- Added long_description in setup.py.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:10>
Django
Reporter: Florian Apolloner | Owner: nobody
Component: Packaging | Version: 2.0
Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"2b0da16d431f3bff8de25d7ead7719caa7708453" 2b0da16]:
{{{
#!CommitTicketReference repository=""
revision="2b0da16d431f3bff8de25d7ead7719caa7708453"
[2.0.x] Fixed #29373 -- Added long_description in setup.py.
Backport of 2e1f674897e89bbc69a389696773aebfec601916 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29373#comment:11>