prometheus / prometheus/client_python
should the project/package name be `prometheus-client` rather than `prometheus_client`
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 4.4k
- フォーク
- 876
- 平均マージ
- 8日 4時間
- マージ済み PR(30日)
- 1
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず pyproject.toml と README.md の参照されているエントリから始め、次に tox.ini、mypy.ini、およびリポジトリ内で project-name への参照を検索します。どの表記を正規のものにするか決める前に、Python packaging の名前正規化に関するガイダンスを確認してください。選択した名前が一貫して使用され、パッケージのビルドとインストールが引き続き正常に完了すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- build-system, documentation
- issue の種類
- リファクタリング
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100