prometheus / prometheus/client_python
should the project/package name be `prometheus-client` rather than `prometheus_client`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.4k
- Forks
- 876
- Avg merge
- 8d 4h
- Merged PRs (30d)
- 1
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.:
- https://github.com/prometheus/client_python/blob/46eae7bae88f76951f7246d9f359f2dd5eeff110/README.md?plain=1#L8
- https://github.com/prometheus/client_python/blob/46eae7bae88f76951f7246d9f359f2dd5eeff110/pyproject.toml#L49
- https://github.com/prometheus/client_python/blob/46eae7bae88f76951f7246d9f359f2dd5eeff110/README.md?plain=1#L20
and perhaps more in tox.ini and mypy.ini?
Cheers,
Chris.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the referenced entries in pyproject.toml and README.md, then search tox.ini, mypy.ini, and the repository for project-name references. Check the Python packaging name-normalization guidance before deciding which spelling should be canonical. Done means the chosen name is used consistently and the package still builds and installs successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100