pkginfo does not pick up a project description correctly
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pkginfo |
Fix Released
|
Undecided
|
Tres Seaver |
Bug Description
According to the Python packaging specifications, the description of a package can either be in the Description field (header) of the metadata, or in the body.
However, pkginfo appears to be only looking in the body, irrespective of the metadata version. This seems to be incorrect, since the presence of the description in the body is a recent addition to the metadata specifications - earlier metadata versions had the description in the description field.
See here for more information:
https:/
The bug was originally reported against PyPI, but the developers there have narrowed it down to a problem with pkginfo not reading the description from the Description field when looking at wheels.
$ pkginfo ./distlib-0.3.1.zip | grep description
description: Low-level components of distutils2/
but
$ pkginfo ./distlib-
description:
The description is there in the METADATA file:
Metadata-Version: 1.1
Name: distlib
Version: 0.3.1
Summary: Distribution utilities
Description: Low-level components of distutils2/
Home-page: https:/
Author: Vinay Sajip
Author-email: <email address hidden>
License: Python license
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Python Software Foundation License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Download-URL: https:/
Changed in pkginfo: | |
status: | Confirmed → Fix Committed |
Changed in pkginfo: | |
status: | Fix Committed → Fix Released |
Thanks for the report. I can confirm that pkginfo does display that behavior with the the 'distlib' wheel.