How to publish a package to PyPI

We can use either declarative config file (pyproject.toml or older setup.cfg) or setup.py to configure the package. But it’s recommended to use declarative method to avoid executing arbitrary scripts and boilerplate code.

It is also recommended to maintain the project folder in src-layout, i.e., keep everything in a independent src folder, to avoid some unexpected errors.


project_root_directory
├── LICENSE
├── README.md
├── pyproject.toml
├── setup.py
└── src/
    └── your_package_name/
        ├── __init__.py
        │── ...
				├── module.py
		    ├── subpkg1/
		    │   ├── __init__.py
		    │   ├── ...
				└── subpkg2/
				        ├── __init__.py
				        ├── ...
				        └── module2.py

instead of flat-layout


project_root_directory
├── pyproject.toml  # AND/OR setup.cfg, setup.py
├── ...
└── your_package_name/
    ├── __init__.py
    ├── ...
    ├── module.py
    ├── subpkg1/
    │   ├── __init__.py
    │   ├── ...
    │   └── module1.py
    └── subpkg2/
        ├── __init__.py
        ├── ...
        └── module2.py


[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "StreamDiffusionIO"
version = "0.0.1"
authors = [
    {name = "Yihao (Ethan) Wang", email = "yihao.w@nyu.edu"},
]
description = "A light weight pipeline using StreamDiffusion, aimming to support streaming IO operations."
readme = "README.md"
keywords = ["diffusion", "stream"]
license = {file = "LICENSE"}
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
]
requires-python = ">=3.10"
dependencies = [
    "torch >= 2.2.0",
    "diffusers >= 0.26.3",
    "transformers >= 4.38.1",
]

[project.optional-dependencies]
xformers = ["xformers >= 0.0.24"]

[project.urls]
Repository = "https://github.com/AgainstEntropy/StreamDiffusionIO.git"

[tool.setuptools]
package-dir = {"" = "src"}

[tool.setuptools.packages.find]
where = ["src"]
include = ["StreamDiffusionIO*"]
namespaces = false

pyproject.toml


pip install -U build twine

cd /path/to/your/project
python -m build
python -m twine upload --repository testpypi dist/*

python -m twine upload [-r pypi] dist/*

References

Building and Publishing - Python Packaging User Guide

https://packaging.python.org/en/latest/guides/section-build-and-publish/

Quickstart - setuptools 69.1.1.post20240223 documentation

Instead, when creating new Python packages, it is recommended to use a command line tool called build. This tool will automatically download setuptools and any other build-time dependencies that your project might have. You just need to specify them in a pyproject.toml file at the root of your package, as indicated in the following section.

https://setuptools.pypa.io/en/latest/userguide/quickstart.html