Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.09 KB

File metadata and controls

33 lines (22 loc) · 1.09 KB

Python Package Distribution Guide

A brief guides to creating Python distributions.

Core Concepts

Terminology

  • Package: A directory containing Python modules (.py files) and an __init__.py file. Can include sub-packages.
    Naming: lowercase_with_underscores
  • Module: A single Python file containing functions, classes, or variables.
    Naming: lowercase_with_underscores.py
  • Library: A collection of packages/modules designed to be imported and reused.
    Naming: Use suffixes like utils, lib, or tools
  • Application: A standalone program with entry points (CLI, GUI, etc.).
    Naming: Distribution uses hyphens (my-tool), package uses underscores (my_tool)
  • Distribution: The packaged, installable version of a project.
    Naming: lowercase-with-hyphens (used in pip install <name>)

Guides