PyPi package

Python packages

Python packages are distributed via PyPI in two main formats:

• Wheel (.whl) – prebuilt, faster installation

• Source distribution (.tar.gz) – contains all source code

Folder structure

.
├── <package-name>
│   │
│   ├── <data_folder1>
│   │   ├── file1.js
│   │   ├── ... 
│   │   └── fileN.js
│   │
│   ├── <data_folder2>
│   │   └── ... 
│   │
│   ├── modules
│   │   ├── module1.py
│   │   ├── module2.py
│   │   ├── ...
│   │   └── moduleN.py
│   │
│   └── <package-name>.py
│   
├── README.md
├── LICENSE
├── .gitignore
├── MANIFEST.in
└── pyproject.toml

<package-name>/<package-name>.py

...

if __name__ == "__main__":
    main()

.gitignore

<package-name>.egg-info/
dist/
...

pyproject.toml

For the wheel creation (dist/*.whl):

[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "<package-name>"
version = "0.1.0"
description = "Description - example"
readme = "README.md"
requires-python = ">=3.8"
license = { file = "LICENSE" }
authors = [
    { name="<author_name>" }
]

dependencies = [
    "<package1>",
    "<package2>",
    ...,
    "<packageN>",
]

[tool.setuptools.packages.find]
include = ["<package-name>", "<package-name>.*"]

[tool.setuptools.package-data]
<package-name> = ["<data_folder1>/*.js", "<data_folder2>/*"]

[project.scripts]
<package-name> = "<package-name>.<package-name>:main"

where:

• <package-name> is the name of the package you created

• [tool.setuptools.package-data] defines which other data folders/files are packaged

• [project.scripts] is used to function to be called when the script runs. This ensures that python -m should not be specified before the name of the script to run it.

MANIFEST.in

For the Source dist creation (dist/*.tar.gz):

include LICENSE
include README.md
recursive-include <package-name> *.py
recursive-include <package-name>/<data_folder1> *.js
recursive-include <package-name>/<data_folder2> *
recursive-exclude * __pycache__ *.pyc

Setup the machine

python3 -m pip install build, twine

Package creation

• Create the package

python3 -m build

Command	Description
python -m build --wheel	Build only a wheel
python -m build --sdist	Build only a source distribution
python -m build --outdir dist/	Change output dir of the build process
python -m build --no-isolation	Disable isolated build environment (not recommended for release)
python -m build --python python3.10	Specify Python executable

Verify the package content

• Unpack the wheel

wheel unpack dist/<package-name>-0.1.0-py3-none-any.whl

• Extract the Source dist

tar -tf dist/<packeage-name>-0.1.0.tar.gz

Install the package

• Install the package locally to test it

python3 -m pip install dist/<package-name>-0.1.0-py3-none-any.whl

• If you need to upgrade it

python3 -m pip install --upgrade dist/<package-name>-0.1.0-py3-none-any.whl

Package upload

twine upload dist/*

Enter your PyPI username + password/token.

Package uninstall

python3 -m pip uninstall <package-name>