Repository navigation
should the project/package name be prometheus-client rather than prometheus_client #1092
Description
Hey.
I stumbled over the question what to use when one specifies the Prometheus Client as a dependency= in pyproject.toml?
- you guys seem to use
prometheus_client(underscore)
https://github.com/prometheus/client_python/blob/46eae7bae88f76951f7246d9f359f2dd5eeff110/pyproject.toml#L6C9-L6C26 - PyPi seems to use
prometheus-client(i.e. when one enters the URL with underscore, it forwards to the one with hyphen)
The actual package build/installation seems to work with both names.
For me the whole Python packaging standard are like big mess ^^... but, if I understand correctly the following possibly means:
The name should be lowercased with all runs of the characters
.,-, or_replaced with a single-character.
that the name should be with hypen.
So maybe that should be changed in pyproject.toml and many other places like e.g.:
and perhaps more in tox.ini and mypy.ini?
Cheers,
Chris.
Activity
ethanschen commentedon Mar 1, 2025
As mentioned in Names and normalization:
Whether the project name is
prometheus_clientor evenPrOmEtHeUs-._.-ClIeNt(a terrible way to write a name, but it is valid), it will be normalized asprometheus-clientwhen built into a pypi package.calestyo commentedon Mar 1, 2025
Yes, but since it's anyway normalised and since the recommendation is to use
-, I figured maybe it should be changed for clarity. :-)csmarchbanks commentedon Mar 3, 2025
Yeah, as mentioned they are equivalent. I would be ok with updating pyproject.toml and other locations to use the normalized form if that helps reduce any confusion.
Heisenbrick commentedon Sep 30, 2026
Hi maintainers! I'd like to work on this issue. I'll update pyproject.toml to use the normalized name = prometheus-client and update the PyPI references in README.md to match. Could you please assign this to me?