Links
- User guide
- Quickstart
- Supported Interfaces
- Package Discovery and Namespace Packages
- Dependencies Management in Setuptools
- Development Mode (a.k.a. “Editable Installs”)
- Entry Points
- Data Files Support
- Building Extension Modules
- Specifying Your Project’s Version
- Controlling files in the distribution
- Caching and Troubleshooting
- Extending or Customizing Setuptools
- Configuring setuptools using
setup.cfgfiles - Configuring setuptools using
pyproject.tomlfiles
- Build System Support
- Package Discovery and Resource Access using
pkg_resources - Keywords
- Building and Distributing Packages with Setuptools
Project
- Roadmap
- Development guide
- Backward compatibility & deprecated practice
- New and Changed
setup()Keywords - Specifying dependencies that aren’t in PyPI via
dependency_links - The Internal Structure of Python Eggs
- Easy Install
- Understanding the
zip_safeflag - Automatic Resource Extraction
- Distributing Python Modules (Legacy version)
- Porting from Distutils
- “Eggsecutable” Scripts
- Running
setuptoolscommands
- New and Changed
- History
- Credits
- Artwork
Building and Distributing Packages with Setuptools¶
The first step towards sharing a Python library or program is to build adistribution package[1]. This includes adding a set ofadditional files containing metadata and configuration to not only instructsetuptools on how the distribution should be built but alsoto help installer (such aspip) during the installation process.
This document contains information to help Python developers through thisprocess. Please check theQuickstart for an overview ofthe workflow.
Also note thatsetuptools is what is known in the community asbuildbackend, user facing interfaces are provided by toolssuch aspip andbuild. To usesetuptools, one mustexplicitly create apyproject.toml file as describedBuild System Support.
Contents¶
- Quickstart
- Supported Interfaces
- Package Discovery and Namespace Packages
- Dependencies Management in Setuptools
- Development Mode (a.k.a. “Editable Installs”)
- Entry Points
- Data Files Support
- Building Extension Modules
- Specifying Your Project’s Version
- Controlling files in the distribution
- Caching and Troubleshooting
- Extending or Customizing Setuptools
- Configuring setuptools using
setup.cfgfiles - Configuring setuptools using
pyproject.tomlfiles
—
Notes
[1]ADistribution Package is also referred in the Python community simply as “package”Unfortunately, this jargon might be a bit confusing for new users because the term packagecan also to refer anydirectory (or sub directory) used to organizemodules and auxiliary files.