Packaging and distributing projects¶
The guidance previously provided here is now covered by the following resources.
Configuring your project¶
Packaging Python Projects walks through creating, building, and publishing a Python project.
Writing your pyproject.toml explains how to configure project metadata, dependencies, and the build backend.
Making a PyPI-friendly README explains how to display your README on PyPI.
Versioning covers choosing a versioning scheme.
Setuptools configuration¶
For configuration specific to Setuptools, see its documentation:
For existing projects, see How to modernize a setup.py based project? and Is setup.py deprecated?.
Editable installs¶
See Install packages in a virtual environment using pip and venv for installing a local project in editable mode, and Development Mode for details specific to setuptools.
Building and publishing¶
Packaging Python Projects explains how to build source distributions and wheels, and upload them to PyPI.
Packaging binary extensions covers projects with compiled extensions.
Publishing package distribution releases using GitHub Actions CI/CD workflows covers publishing releases with GitHub Actions.