Hi, Is it possible to create a documentation in the section with “Project Links” on the page describing a release on PyPI.org <http://pypi.org/>? That is, can I add some metadata to an sdist or wheel that would add an entry to that list, and if so how? I’m using setuptools to create the distribution artefacts. The reason I ask is that I currently use an index.html on pythonhosted.org that redirects to the real documentation because that adds a link to the documentation when looking at the release on pypi.python.org. That doesn’t work pypi.org. Ronald
You can add a URL in the long_description (e.g. to https://read-the-docs.readthedocs.org/ ) It'd be useful to mention that here: https://packaging.python.org/tutorials/distributing-packages/ It would sure be great to be able to express with structured data that a project has [Sphinx] docs at a particular URL. It'd then be possible to discover and search docs for each project automatically. http://markmail.org/search/?q=project-url+documentation+list%3Aorg.python.di... "[Distutils] Provide separate development and documentation URLs in PyPI metadata?" http://markmail.org/search/?q=project-url+documentation+list%3Aorg.python.di... On Sunday, August 27, 2017, Ronald Oussoren <ronaldoussoren@mac.com> wrote:
Hi,
Is it possible to create a documentation in the section with “Project Links” on the page describing a release on PyPI.org? That is, can I add some metadata to an sdist or wheel that would add an entry to that list, and if so how? I’m using setuptools to create the distribution artefacts.
The reason I ask is that I currently use an index.html on pythonhosted.org that redirects to the real documentation because that adds a link to the documentation when looking at the release on pypi.python.org. That doesn’t work pypi.org.
Ronald
On 27 Aug 2017, at 17:33, Wes Turner <wes.turner@gmail.com> wrote:
You can add a URL in the long_description (e.g. to https://read-the-docs.readthedocs.org/ <https://read-the-docs.readthedocs.org/> )
I know, but that adds the URL to the project description and not the sidebar. PEP 345 appears to specify metadata that could be used for this, and warehouse seems to contain to make use of this (or at least a database model that allows for specifying more links than just the default one). Adding links to the sidebar would be nicer with the new design on PyPI.org <http://pypi.org/>, but there doesn’t seem to be a clean way to add “Project-URL” metadata as described in PEP 345 to a wheel file. I could tweak my setup.py files to add Project-URL metadata, but before I do that I’d like to confirm that (a) that metadata is actually used by warehouse and (b) there is no cleaner way to add this metadata using setuptools. Ronald
If you search the archive of this mailing list you will notice I asked this exact question about a month or 2 ago (I think). The answer I got was it is used on PyPI.org, but I don't know how to set it with setuptools (flit will probably add support after PEP 517). On Sun, Aug 27, 2017, 13:01 Ronald Oussoren <ronaldoussoren@mac.com> wrote:
On 27 Aug 2017, at 17:33, Wes Turner <wes.turner@gmail.com> wrote:
You can add a URL in the long_description (e.g. to https://read-the-docs.readthedocs.org/ )
I know, but that adds the URL to the project description and not the sidebar. PEP 345 appears to specify metadata that could be used for this, and warehouse seems to contain to make use of this (or at least a database model that allows for specifying more links than just the default one).
Adding links to the sidebar would be nicer with the new design on PyPI.org, but there doesn’t seem to be a clean way to add “Project-URL” metadata as described in PEP 345 to a wheel file. I could tweak my setup.py files to add Project-URL metadata, but before I do that I’d like to confirm that (a) that metadata is actually used by warehouse and (b) there is no cleaner way to add this metadata using setuptools.
Ronald _______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
On 28 Aug 2017, at 00:12, Brett Cannon <brett@python.org> wrote:
If you search the archive of this mailing list you will notice I asked this exact question about a month or 2 ago (I think). The answer I got was it is used on PyPI.org, but I don't know how to set it with setuptools (flit will probably add support after PEP 517).
To get back to this: I’m probably doing something wrong, but I haven’t managed yet to make anything show up on PyPI.org <http://pypi.org/> when I use “Project-URL” in metadata. There’s a pyobjc-core 4.0.1b1 wheel on PyPI.org <http://pypi.org/> that includes two Project-URL lines in its metadata, but that doesn’t add anything to the sidebar. I’ve manually verified that the metadata is present in the wheel file (as I’m using a replacement egg_info command in my setup.py file to generate this part of the metadata). Ronald P.S. I tried to upload to test.pypi.org <http://test.pypi.org/>, but that didn’t work due to an SSL error: $ twine upload -r testpypi dist/pyobjc_core-4.0.1b1-cp27-cp27m-macosx_10_6_intel.whl Uploading distributions to https://test.pypi.org/legacy/ Uploading pyobjc_core-4.0.1b1-cp27-cp27m-macosx_10_6_intel.whl SSLError: HTTPSConnectionPool(host='test.pypi.org', port=443): Max retries exceeded with url: /legacy/ (Caused by SSLError(SSLError(1, u'[SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:661)'),))
On Sun, Aug 27, 2017, 13:01 Ronald Oussoren <ronaldoussoren@mac.com <mailto:ronaldoussoren@mac.com>> wrote:
On 27 Aug 2017, at 17:33, Wes Turner <wes.turner@gmail.com <mailto:wes.turner@gmail.com>> wrote:
You can add a URL in the long_description (e.g. to https://read-the-docs.readthedocs.org/ <https://read-the-docs.readthedocs.org/> )
I know, but that adds the URL to the project description and not the sidebar. PEP 345 appears to specify metadata that could be used for this, and warehouse seems to contain to make use of this (or at least a database model that allows for specifying more links than just the default one).
Adding links to the sidebar would be nicer with the new design on PyPI.org <http://pypi.org/>, but there doesn’t seem to be a clean way to add “Project-URL” metadata as described in PEP 345 to a wheel file. I could tweak my setup.py files to add Project-URL metadata, but before I do that I’d like to confirm that (a) that metadata is actually used by warehouse and (b) there is no cleaner way to add this metadata using setuptools.
Ronald _______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org <mailto:Distutils-SIG@python.org> https://mail.python.org/mailman/listinfo/distutils-sig <https://mail.python.org/mailman/listinfo/distutils-sig>
On Friday, October 20, 2017, Ronald Oussoren <ronaldoussoren@mac.com> wrote:
On 28 Aug 2017, at 00:12, Brett Cannon <brett@python.org <javascript:_e(%7B%7D,'cvml','brett@python.org');>> wrote:
If you search the archive of this mailing list you will notice I asked this exact question about a month or 2 ago (I think). The answer I got was it is used on PyPI.org, but I don't know how to set it with setuptools (flit will probably add support after PEP 517).
To get back to this: I’m probably doing something wrong, but I haven’t managed yet to make anything show up on PyPI.org when I use “Project-URL” in metadata.
There’s a pyobjc-core 4.0.1b1 wheel on PyPI.org that includes two Project-URL lines in its metadata, but that doesn’t add anything to the sidebar. I’ve manually verified that the metadata is present in the wheel file (as I’m using a replacement egg_info command in my setup.py file to generate this part of the metadata).
https://github.com/pypa/warehouse/search?utf8=✓&q="project-url"&type=Issues https://github.com/pypa/warehouse/search?q="Project-Url"&type=Commits&utf8=✓
Ronald
P.S. I tried to upload to test.pypi.org, but that didn’t work due to an SSL error:
$ twine upload -r testpypi dist/pyobjc_core-4.0.1b1-cp27- cp27m-macosx_10_6_intel.whl Uploading distributions to https://test.pypi.org/legacy/ Uploading pyobjc_core-4.0.1b1-cp27-cp27m-macosx_10_6_intel.whl SSLError: HTTPSConnectionPool(host='test.pypi.org', port=443): Max retries exceeded with url: /legacy/ (Caused by SSLError(SSLError(1, u'[SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:661)'),))
https://www.google.com/search?q=TLSV1_ALERT_PROTOCOL_VERSION Looks like TLSv1 (TLS 1.0) is deprecated. https://www.google.com/search?q=TLSV1_ALERT_PROTOCOL_VERSION+twine https://github.com/pypa/twine/issues/273
On Sun, Aug 27, 2017, 13:01 Ronald Oussoren <ronaldoussoren@mac.com <javascript:_e(%7B%7D,'cvml','ronaldoussoren@mac.com');>> wrote:
On 27 Aug 2017, at 17:33, Wes Turner <wes.turner@gmail.com <javascript:_e(%7B%7D,'cvml','wes.turner@gmail.com');>> wrote:
You can add a URL in the long_description (e.g. to https://read-the-docs. readthedocs.org/ )
I know, but that adds the URL to the project description and not the sidebar. PEP 345 appears to specify metadata that could be used for this, and warehouse seems to contain to make use of this (or at least a database model that allows for specifying more links than just the default one).
Adding links to the sidebar would be nicer with the new design on PyPI.org <http://pypi.org/>, but there doesn’t seem to be a clean way to add “Project-URL” metadata as described in PEP 345 to a wheel file. I could tweak my setup.py files to add Project-URL metadata, but before I do that I’d like to confirm that (a) that metadata is actually used by warehouse and (b) there is no cleaner way to add this metadata using setuptools.
Ronald _______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org <javascript:_e(%7B%7D,'cvml','Distutils-SIG@python.org');> https://mail.python.org/mailman/listinfo/distutils-sig
On 20 Oct 2017, at 17:51, Wes Turner <wes.turner@gmail.com> wrote:
On Friday, October 20, 2017, Ronald Oussoren <ronaldoussoren@mac.com <mailto:ronaldoussoren@mac.com>> wrote:
On 28 Aug 2017, at 00:12, Brett Cannon <brett@python.org <javascript:_e(%7B%7D,'cvml','brett@python.org');>> wrote:
If you search the archive of this mailing list you will notice I asked this exact question about a month or 2 ago (I think). The answer I got was it is used on PyPI.org <http://pypi.org/>, but I don't know how to set it with setuptools (flit will probably add support after PEP 517).
To get back to this: I’m probably doing something wrong, but I haven’t managed yet to make anything show up on PyPI.org <http://pypi.org/> when I use “Project-URL” in metadata.
There’s a pyobjc-core 4.0.1b1 wheel on PyPI.org <http://pypi.org/> that includes two Project-URL lines in its metadata, but that doesn’t add anything to the sidebar. I’ve manually verified that the metadata is present in the wheel file (as I’m using a replacement egg_info command in my setup.py file to generate this part of the metadata).
https://github.com/pypa/warehouse/search?utf8=✓&q= <https://github.com/pypa/warehouse/search?utf8=%E2%9C%93&q=>"project-url"&type=Issues
https://github.com/pypa/warehouse/search?q= <https://github.com/pypa/warehouse/search?q=>"Project-Url"&type=Commits&utf8=✓
I’m note sure what you’re trying to say here, but <https://github.com/pypa/warehouse/pull/878/files <https://github.com/pypa/warehouse/pull/878/files>> suggests that Project-URL is supported in the PyPI.org <http://pypi.org/> UI (assuming that it is running a version of the software from after merging this pull request). But for some reason this doesn’t work for me, and I don’t know why. Either I’m doing something wrong, or the code receiving wheel files does not yet store project-urls information in the database.
Ronald
P.S. I tried to upload to test.pypi.org <http://test.pypi.org/>, but that didn’t work due to an SSL error:
$ twine upload -r testpypi dist/pyobjc_core-4.0.1b1-cp27-cp27m-macosx_10_6_intel.whl Uploading distributions to https://test.pypi.org/legacy/ <https://test.pypi.org/legacy/> Uploading pyobjc_core-4.0.1b1-cp27-cp27m-macosx_10_6_intel.whl SSLError: HTTPSConnectionPool(host='test.pypi.org <http://test.pypi.org/>', port=443): Max retries exceeded with url: /legacy/ (Caused by SSLError(SSLError(1, u'[SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:661)'),))
https://www.google.com/search?q=TLSV1_ALERT_PROTOCOL_VERSION <https://www.google.com/search?q=TLSV1_ALERT_PROTOCOL_VERSION>
Looks like TLSv1 (TLS 1.0) is deprecated.
https://www.google.com/search?q=TLSV1_ALERT_PROTOCOL_VERSION+twine <https://www.google.com/search?q=TLSV1_ALERT_PROTOCOL_VERSION+twine>
https://github.com/pypa/twine/issues/273 <https://github.com/pypa/twine/issues/273>
Hmm… that issue means I should be slightly worried, the VM I’m using for uploading releases might stop working for this some time in the future. Hopefully upgrading the python installation on that will avoid that. Ronald
participants (3)
-
Brett Cannon -
Ronald Oussoren -
Wes Turner