Using hyphen/dash in python repository name and package name

by

To answer your 1st point let me rephrase my answer to a different question.

The biggest source of misunderstanding is that the word “package” is heavily overloaded. There are 4 different names in the game — the name of the repository, the name of the directory being used for development (the one that contains setup.py), the name of the directory containing __init__.py and other importable modules, the name of distribution at PyPI. Quite often these 4 are the same or similar but that’s not required.

The names of the repository and development directory can be any, their names don’t play any role. Of course it’s convenient to name them properly but that’s only convenience.

The name of the directory with Python files name the package to be imported. Once the package is named for import the name usually stuck and cannot be changed.

The name of the distribution gives one a page at PyPI and the name of distribution files (source distribution, eggs, wheels). It’s the name one puts in setup(name="distribution") call.

Let me show detailed real example. I’ve been maintaining a templating library called CheetahTemplate. I develop it in the development directory called cheetah3/. The distribution at PyPI is called Cheetah3; this is the name I put into setup(name="Cheetah3"). The top-level module is Cheetah hence one does import Cheetah.Template or from Cheetah import Template; that means that I have a directory cheetah3/Cheetah/.

The answer to 2 is: you can have dashes in repository names and PyPI distribution names but not in package (directories with __init__.py files) names and module (.py files) names because you cannot write in Python import xy-zzy, that would be subtraction and SyntaxError.

Point 3: The site and the repository names are scikit-learn, as well as the distribution name, but the importable package (the top-level directory with __init__.py) is sklearn.

PEP 8 has nothing to do with the question as it doesn’t talk about distribution, only about importable packages and modules.

More Related Contents:

  1. Installing python module within code
  2. “pip install unroll”: “python setup.py egg_info” failed with error code 1
  3. ‘pip install’ fails for every package (“Could not find a version that satisfies the requirement”) [duplicate]
  4. How to install pip with Python 3?
  5. Installing specific package version with pip
  6. Why use pip over easy_install?
  7. Pip install from pypi works, but from testpypi fails (cannot find requirements)
  8. How to run pip of different version of python using python command?
  9. Can’t install new packages for Python (Python 3.9.0, Windows 10)
  10. Find all packages installed with easy_install/pip?
  11. pip install . creates only the dist-info not the package
  12. how to create local own pypi repository index without mirror?
  13. Package (Python PIL/Pillow) installed but I can’t import it
  14. How can I Install a Python module within code?
  15. How to install PyPi packages using anaconda conda command
  16. PyCharm: ImportError no module named X?
  17. Does uninstalling a package with “pip” also remove the dependent packages?
  18. How can I host my own private conda repository?
  19. ModuleNotFoundError: No module named ‘sklearn’
  20. Credentials in pip.conf for private PyPI
  21. pip fails to install packages from requirements.txt
  22. No module named pkg_resources
  23. ValueError: numpy.ndarray size changed, may indicate binary incompatibility. Expected 88 from C header, got 80 from PyObject
  24. “pip install –editable ./” vs “python setup.py develop”
  25. Can I use `pip` instead of `easy_install` for `python setup.py install` dependency resolution?
  26. ubuntu 14.04, pip cannot upgrade matplotllib
  27. ‘pip’ is not recognized [duplicate]
  28. How to uninstall pip on OSX?
  29. How to install Tensorflow on Python 2.7 on Windows?
  30. How to install lxml on Windows

Leave a Comment