prometheus / prometheus/client_python
should the project/package name be `prometheus-client` rather than `prometheus_client`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 4.4k
- Forks
- 876
- Ø Merge
- 8 T. 4 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den referenzierten Einträgen in pyproject.toml und README.md und suche anschließend in tox.ini, mypy.ini und im Repository nach Verweisen auf project-name. Prüfe die Richtlinien zur Namensnormalisierung beim Python packaging, bevor du entscheidest, welche Schreibweise kanonisch sein soll. Erledigt ist die Aufgabe, wenn der ausgewählte Name konsistent verwendet wird und das Paket weiterhin erfolgreich gebaut und installiert werden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- build-system, documentation
- Issue-Typ
- Refactoring
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100