How To Set Project Links in PyPI

user_2961550 0
Viewed 1195

How do I add links under the Project Links section of my PyPI project?

python-packaging pypi setup.py setuptools
2 Answers

This question has been answered before but was a bit difficult to find, so hopefully this one is a bit easier.

PyPI pulls these links from the project_urls metadata.

In your setup.py file, call setuptools.setup() with the project_urls argument as a dictionary of title-url pairs.

import setuptools

project_urls = {
  'Link 1': 'https://mygreatsite.com',
  'Link 2': 'https://anothersite.com'
}

setuptools.setup( other_arguments, project_urls = project_urls )
user_29615500

If you want to know for which URL identifier which icon is used on PyPI,e.g. if you write

project_urls = {
  'Twitter': 'https://twitter.com/PyScaffold',
}

you will see the Twitter bird on PyPI, e.g. https://pypi.org/project/PyScaffold/.

In order to see the available icons and when there are set, just check out this file(/warehouse/templates/packaging/detail.html) from the PyPI source code.

user_43344710
Related