get_project_url

safir.metadata.get_project_url(meta: Message, label: str) → Optional[str]

Get a specific URL from the project_urls key of a package’s metadata.

Parameters:
  • meta (email.message.Message) – The package metadata, as returned by the importlib.metadata.metadata function.
  • label (str) –

    The URL’s label. Consider the follow snippet of a setup.cfg file:

    project_urls =
        Change log = https://safir.lsst.io/changelog.html
        Source code = https://github.com/lsst-sqre/safir
        Issue tracker = https://github.com/lsst-sqre/safir/issues
    

    To get the https://github.com/lsst-sqre/safir URL, the label is Source code.

Returns:

url – The URL. If the label is not found, the function returns None.

Return type:

str or None

Examples

>>> from importlib_metadata import metadata
>>> meta = metadata("safir")
>>> get_project_url(meta, "Source code")
'https://github.com/lsst-sqre/safir'