summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Stanley <fungi@yuggoth.org>2017-11-20 20:43:36 +0000
committerJeremy Stanley <fungi@yuggoth.org>2017-12-04 19:46:41 +0000
commit538d2c21a1e2c816aa4ec2b20550c1278707456a (patch)
treecae85280d6e132f415ec921d2c930dd6a7908cac
parent73cc4189caa8b8eb73855025529e5f820fb76a30 (diff)
Support Description-Content-Type metadata
As of setuptools 36.4.0, support for Description-Content-Type metadata was added via the long_description_content_type variable. Add a metadata.description-content-type option for setup.cfg so it can be provided through PBR. This makes it possible to instruct PyPI and potentially other frontends to know an explicit RFC 1341 content type, along with character set and variant, for the accompanying long description. Change-Id: I852f603d9ca4e4cd469eab4cae9933ef2581e3af
Notes
Notes (review): Code-Review+2: Ian Wienand <iwienand@redhat.com> Code-Review+2: ChangBo Guo(gcb) <glongwave@gmail.com> Workflow+1: ChangBo Guo(gcb) <glongwave@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 05 Dec 2017 07:51:44 +0000 Reviewed-on: https://review.openstack.org/521658 Project: openstack-dev/pbr Branch: refs/heads/master
-rw-r--r--doc/source/user/using.rst3
-rw-r--r--pbr/tests/testpackage/setup.cfg1
-rw-r--r--pbr/util.py1
-rw-r--r--setup.cfg1
4 files changed, 5 insertions, 1 deletions
diff --git a/doc/source/user/using.rst b/doc/source/user/using.rst
index 4b08ec4..0b91141 100644
--- a/doc/source/user/using.rst
+++ b/doc/source/user/using.rst
@@ -50,7 +50,8 @@ itself):
50 author = OpenStack Foundation 50 author = OpenStack Foundation
51 author-email = openstack-dev@lists.openstack.org 51 author-email = openstack-dev@lists.openstack.org
52 summary = OpenStack's setup automation in a reusable form 52 summary = OpenStack's setup automation in a reusable form
53 description-file = README 53 description-file = README.rst
54 description-content-type = text/x-rst; charset=UTF-8
54 home-page = https://launchpad.net/pbr 55 home-page = https://launchpad.net/pbr
55 license = Apache-2 56 license = Apache-2
56 classifier = 57 classifier =
diff --git a/pbr/tests/testpackage/setup.cfg b/pbr/tests/testpackage/setup.cfg
index d10a87e..5af1514 100644
--- a/pbr/tests/testpackage/setup.cfg
+++ b/pbr/tests/testpackage/setup.cfg
@@ -10,6 +10,7 @@ summary = Test package for testing pbr
10description-file = 10description-file =
11 README.txt 11 README.txt
12 CHANGES.txt 12 CHANGES.txt
13description-content-type = text/plain; charset=UTF-8
13requires-python = >=2.5 14requires-python = >=2.5
14 15
15requires-dist = 16requires-dist =
diff --git a/pbr/util.py b/pbr/util.py
index dc8995e..ef4deb0 100644
--- a/pbr/util.py
+++ b/pbr/util.py
@@ -104,6 +104,7 @@ D1_D2_SETUP_ARGS = {
104 "description": ("metadata", "summary"), 104 "description": ("metadata", "summary"),
105 "keywords": ("metadata",), 105 "keywords": ("metadata",),
106 "long_description": ("metadata", "description"), 106 "long_description": ("metadata", "description"),
107 "long_description_content_type": ("metadata", "description_content_type"),
107 "download_url": ("metadata",), 108 "download_url": ("metadata",),
108 "classifiers": ("metadata", "classifier"), 109 "classifiers": ("metadata", "classifier"),
109 "platforms": ("metadata", "platform"), # ** 110 "platforms": ("metadata", "platform"), # **
diff --git a/setup.cfg b/setup.cfg
index 35f0d72..d2d8526 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -5,6 +5,7 @@ author-email = openstack-dev@lists.openstack.org
5summary = Python Build Reasonableness 5summary = Python Build Reasonableness
6description-file = 6description-file =
7 README.rst 7 README.rst
8description-content-type = text/x-rst; charset=UTF-8
8home-page = https://docs.openstack.org/pbr/latest/ 9home-page = https://docs.openstack.org/pbr/latest/
9requires-python = >=2.6 10requires-python = >=2.6
10classifier = 11classifier =