python-packaging-101

Naming Conventions

Distribution Package Name

name='sample',

This is the name of your project, determining how your project is listed on PyPI. Per PEP 508, valid project names must:

• Consist only of ASCII letters, digits, underscores (_), hyphens (-), and/or periods (.), and
• Start & end with an ASCII letter or digit.

Comparison of project names is case insensitive and treats arbitrarily-long runs of underscores, hyphens, and/or periods as equal. For example, if you register a project named cool-stuff, users will be able to download it or declare a dependency on it using any of the following spellings:

Cool-Stuff
cool.stuff
COOL_STUFF
CoOl__-.-__sTuFF

Source: https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#name

Package and Module Names

Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

When an extension module written in C or C++ has an accompanying Python module that provides a higher level (e.g. more object oriented) interface, the C/C++ module has a leading underscore (e.g. _socket).

Source: https://peps.python.org/pep-0008/#package-and-module-names

mypy

How imports are found

When mypy encounters an import statement or receives module names from the command line via the --module or --package flags, mypy tries to find the module on the file system similar to the way Python finds it. However, there are some differences.

First, mypy has its own search path. This is computed from the following items:

• The MYPYPATH environment variable (a list of directories, colon-separated on UNIX systems, semicolon-separated on Windows).
• The mypy_path config file option.
• The directories containing the sources given on the command line (see Mapping file paths to modules).
• The installed packages marked as safe for type checking (see PEP 561 support).
• The relevant directories of the typeshed repo.

Source: https://mypy.readthedocs.io/en/stable/running_mypy.html#how-imports-are-found