Repository navigation
should the project/package name be prometheus-client rather than prometheus_client #1092
Description
Activity
As mentioned in Names and normalization:
This means that the following names are all equivalent:
friendly-bard(normalized form)Friendly-BardFRIENDLY-BARDfriendly.bardfriendly_bardfriendly--bardFrIeNdLy-._.-bArD(a terrible way to write a name, but it is valid)
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.Yes, but since it's anyway normalised and since the recommendation is to use
-, I figured maybe it should be changed for clarity. :-)Reacted by EthansYeah, 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.
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?
Hey.
I stumbled over the question what to use when one specifies the Prometheus Client as a
dependency=inpyproject.toml?prometheus_client(underscore)https://github.com/prometheus/client_python/blob/46eae7bae88f76951f7246d9f359f2dd5eeff110/pyproject.toml#L6C9-L6C26
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:
that the name should be with hypen.
So maybe that should be changed in
pyproject.tomland many other places like e.g.:client_python/README.md
Line 8 in 46eae7b
client_python/pyproject.toml
Line 49 in 46eae7b
client_python/README.md
Line 20 in 46eae7b
and perhaps more in
tox.iniandmypy.ini?Cheers,
Chris.