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
Porting from Distutils¶
Setuptools and the PyPA have astated goal to make Setuptools the reference API for distutils.
Since the 60.0.0 release, Setuptools includes a local, vendored copy of distutils (from late copies of CPython) that is enabled by default. To disable the use of this copy of distutils when invoking setuptools, set the environment variable:
SETUPTOOLS_USE_DISTUTILS=stdlib
Warning
Please note that this also affects howdistutils.cfg files inside stdlib’sdistutilspackage directory are processed.UnlessSETUPTOOLS_USE_DISTUTILS=stdlib, they will have no effect on the build process.
You can still use a global user config file,~/.pydistutils.cfg (POSIX) or%USERPROFILE%/pydistutils.cfg (Windows),or use the environment variableDIST_EXTRA_CONFIG to point to anothersupplementary configuration file.
Prefer Setuptools¶
As Distutils is deprecated, any usage of functions or objects from distutils is similarly discouraged, and Setuptools aims to replace or deprecate all such uses. This section describes the recommended replacements.
distutils.core.setup →setuptools.setup
distutils.cmd.Command ordistutils.core.Command →setuptools.Command
distutils.command.{build_clib,build_ext,build_py,sdist} →setuptools.command.*
distutils.dep_util →setuptools.modified
distutils.log →logging (standard library)
distutils.version.* →packaging.version.*
distutils.errors.* →setuptools.errors.*[1]
Migration advice is also provided byPEP 632.
If a project relies on uses ofdistutils that do not have a suitable replacement above, please search theSetuptools issue tracker and file a request, describing the use-case so that Setuptools’ maintainers can investigate. Please provide enough detail to help the maintainers understand how distutils is used, what value it provides, and why that behavior should be supported.
Please notice errors related to the command line usage ofsetup.py, such asDistutilsArgError, are intentionally not exposedby setuptools, since this is considered a deprecated practice.