setuptools
Setuptools is Python’s original and most established build backend, providing tools for building, distributing, and installing Python packages. It serves as the foundation for much of Python’s packaging ecosystem and supports a wide range of packaging use cases.
Note
Core Features
Build System
- Package Creation: Builds both source distributions (sdists) and wheel distributions
- Extension Module Support: Handles compilation of C extensions and Cython code
- Entry Points: Manages console scripts and plugin registration
- Resource Management: Handles package data files and non-code resources
- Command Customization: Supports custom build steps and commands
Configuration Options
In the past, setuptools projects required a
setup.py script to be present in the
project root. However, this is no longer the case. setuptools configurations can be defined in pyproject.toml.Setuptools can be configured through pyproject.toml or the legacy setup.py file:
# Modern configuration (pyproject.toml)
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
[project]
name = "example"
version = "0.1.0"
description = "Example package"
requires-python = ">=3.8"
dependencies = ["requests>=2.25.0"]# Legacy configuration (setup.py)
from setuptools import setup
setup(
name="example",
version="0.1.0",
description="Example package",
python_requires=">=3.8",
install_requires=["requests>=2.25.0"],
)Building with Setuptools
# Build distributions
python -m build
# Or with uv
uv buildBoth commands invoke setuptools as the build backend when pyproject.toml declares setuptools.build_meta in the [build-system] table.
Advantages
- Well-established with decades of development and broad platform support
- Handles complex packaging scenarios including C extensions and custom build steps
- Compatible with modern Python packaging standards (PEP 621)
- Comprehensive documentation available
Limitations
- Legacy API carries historical design choices that can be confusing
- No built-in dependency locking; requires additional tools for lockfiles
- Less frequent updates and slower development cycle than newer alternatives
- More configuration options create a steeper learning curve
Learn More
- pyproject.toml
- Setuptools Documentation
- PEP 621 Support
- Packaging Python Projects Guide
- Setuptools with pyproject.toml Example
- Setuptools with setup.py Example
Also Mentioned In
- How Python's RFC Process Paved the Way for uv, Ruff, and Ty
- Why isn't Python packaging part of core development?
- The uv build backend is now stable
- build
- hatch
- pyproject.toml
- What is a Python package?
- What is PEP 517/518 compatibility?
- What is PEP 609?
- What is PEP 621 compatibility?
- What is PEP 660?
- What is PyPA (Python Packaging Authority)?
- Wheel
- Why are there so many Python packaging tools?
- Why You Should Try uv if You Use Python
Last updated on