prometheus / prometheus/client_python

should the project/package name be `prometheus-client` rather than `prometheus_client`

Open
#1,092 3 comments 0 reactions 0 assignees View on GitHub

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?

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.