prometheus / prometheus/client_python

installed package name doesnt match

Open
#1,010 2 comments 1 reaction 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

There appears to be some discrepancy between the pip package name and the name of the installed package
Both prometheus_client and prometheus-client appear to be valid names to install the package

python3 -m pip index versions prometheus-client
WARNING: pip index is currently an experimental command. It may be removed/changed in a future release without prior warning.
prometheus-client (0.20.0)
python3 -m pip index versions prometheus_client
WARNING: pip index is currently an experimental command. It may be removed/changed in a future release without prior warning.
prometheus_client (0.20.0)

but the actual installed package is named prometheus_client

prometheus_client      0.20.0

and the files on disk reflect that name

ll /usr/local/lib/python3.8/dist-packages
total 32
 4096 Feb 27 10:26 ./
 4096 Jun 27  2022 ../
 4096 Feb 27 10:26 pip/
 4096 Feb 27 10:26 pip-24.0.dist-info/
 4096 Feb 27 10:26 prometheus_client/
 4096 Feb 27 10:26 prometheus_client-0.20.0.dist-info/

All the documentation suggest using

pip install prometheus-client

but that name doesn't match what is output from pip list
which in my case causes problem for automation scripts as the name in the list of installed packages does not match the name of the package to be installed

which name is the correct one?
why does the package name not match the installed package name on disk or in pip list

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 by comparing the distribution name used by pip with the import/package directory shown in the report. Clarify which name is correct for installation and explain the distinction in the documentation, then verify the automation implication with reproducible pip index and pip list checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.