NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #9 most downloaded on PyPI
Most extensible Python build backend with support for C/C++ extension modules
Last release 1 months ago
08 Aug 2026
Ships unpredictably
gaps range from 9 days to 8 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
10 versions withdrawn
withdrawn after publishing
20 years old
625 releases · first in 2006
Breaking Changes ---------------- * #3505: Removed 'msvccompiler' and 'msvc9compiler' modules from distutils. * #3521: Remove bdist_msi and bdist_wini
#3505: Removed 'msvccompiler' and 'msvc9compiler' modules from distutils.
#3521: Remove bdist_msi and bdist_wininst commands, which have been deprecated since Python 3.9. Use older Setuptools for these behaviors if needed.
#3519: Changed the note in keywords documentation regarding editable installations to specify which setuptools version require a minimal setup.py file or not.
Misc ---- * #3515: Fixed "inline" file copying for editable installations and optional extensions. * #3517: Fixed editable_wheel to ensure other comma
#3515: Fixed "inline" file copying for editable installations and optional extensions.
#3517: Fixed editable_wheel to ensure other commands are finalized before using them. This should prevent errors with plugins trying to use different commands or reinitializing them.
#3517: Augmented filter to prevent transient/temporary source files from being considered package_data or data_files.
One column per quarter.
Misc ---- * #3506: Suppress errors in custom build_py implementations when running editable installs in favor of a warning indicating what is the most
#3506: Suppress errors in custom build_py implementations when running editable installs in favor of a warning indicating what is the most appropriate migration path. This is a transitional measure. Errors might be raised in future versions of setuptools.
#3512: Added capability of handling namespace packages created accidentally/purposefully via discovery configuration during editable installs. This should emulate the behaviour of a non-editable installation.
Some plugins might rely on the fact that the .egg-info directory is produced inside the project dir, which may not be the case in editable installs (t
#3497: Fixed editable_wheel for legacy namespaces.
#3502: Fixed issue with editable install and single module distributions.
#3503: Added filter to ignore external .egg-info files in manifest.
Some plugins might rely on the fact that the .egg-info directory is produced inside the project dir, which may not be the case in editable installs (the .egg-info directory is produced inside the metadata directory given by the build frontend via PEP 660 hooks).
Both --build-option and --global-option are supported as a transitional effort (a.k.a. "escape hatch"). In the future a proper list of allowed config_
#3380: Passing some types of parameters via --global-option to setuptools PEP 517/PEP 660 backend is now considered deprecated. The user can pass the same arbitrary parameter via --build-option (--global-option is now reserved for flags like --verbose or --quiet).
Both --build-option and --global-option are supported as a transitional effort (a.k.a. "escape hatch"). In the future a proper list of allowed config_settings may be created.
#3265: Added implementation for editable install hooks (PEP 660).
By default the users will experience a lenient behavior which prioritises the ability of the users of changing the distributed packages (e.g. adding new files or removing old ones). But they can also opt into a strict mode, which will try to replicate as much as possible the behavior of the package as if it would be normally installed by end users. The strict editable installation is not able to detect if files are added or removed from the project (a new installation is required).
This implementation might also affect plugins and customizations that assume certain build subcommands don't run during editable installs or that they always copy files to the temporary build directory.
Important
The editable aspect of the editable install supported this implementation is restricted to the Python modules contained in the distributed package. Changes in binary extensions (e.g. C/C++), entry-point definitions, dependencies, metadata, datafiles, etc may require a new installation.
#3380: Improved the handling of the config_settings parameter in both PEP 517 and PEP 660 interfaces:
It is possible now to pass both --global-option and --build-option. As discussed in #1928, arbitrary arguments passed via --global-option should be placed before the name of the setuptools' internal command, while --build-option should come after.
Users can pass editable-mode=strict to select a strict behaviour for the editable installation.
#3392: Exposed get_output_mapping() from build_py and build_ext subcommands. This interface is reserved for the use of setuptools Extensions and third part packages are explicitly disallowed to calling it. However, any implementation overwriting build_py or build_ext are required to honour this interface.
#3412: Added ability of collecting source files from custom build sub-commands to sdist. This allows plugins and customization scripts to automatically add required source files in the source distribution.
#3414: Users can temporarily specify an environment variable SETUPTOOLS_ENABLE_FEATURES=legacy-editable as a escape hatch for the 660 behavior. This setting is transitional and may be removed in the future.
#3484: Added transient compat mode to editable installs. This more will be temporarily available (to facilitate the transition period) for those that want to emulate the behavior of the develop command (in terms of what is added to sys.path). This mode is provided "as is", with limited support, and will be removed in future versions of setuptools.
#3414: Updated Development Mode to reflect on the implementation of 660.
Misc ---- * #3496: Update to pypa/distutils@b65aa40 including more robust support for library/include dir handling in msvccompiler (pypa/distutils#153
#3496: Update to pypa/distutils@b65aa40 including more robust support for library/include dir handling in msvccompiler (pypa/distutils#153) and test suite improvements.
10 Aug 2022
#3496 : Update to pypa/distutils@b65aa40 including more robust support for library/include dir handling in msvccompiler ( pypa/distutils#153 ) and test suite improvements.
Misc ---- * #3453: Bump vendored version of pyparsing to 3.0.9. * #3481: Add warning for potential install_requires and extras_require misconfiguratio
#3453: Bump vendored version of pyparsing to 3.0.9.
#3481: Add warning for potential install_requires and extras_require misconfiguration in setup.cfg
#3487: Modified pyproject.toml validation exception handling to make relevant debugging information easier to spot.
Misc ---- * #3482: Sync with pypa/distutils@274758f1c02048d295efdbc13d2f88d9923547f8, restoring compatibility shim in bdist.format_commands.
#3482: Sync with pypa/distutils@274758f1c02048d295efdbc13d2f88d9923547f8, restoring compatibility shim in bdist.format_commands.
03 Aug 2022
#3482 : Sync with pypa/distutils@274758f1c02048d295efdbc13d2f88d9923547f8 , restoring compatibility shim in bdist.format_commands.
Changes ------- * #2971: upload_docs command is deprecated once again. Documentation changes --------------------- * #3443: Installed sphinx-hoverxref
#2971: upload_docs command is deprecated once again.
#3443: Installed sphinx-hoverxref extension to show tooltips on internal an external references. -- by humitos
#3444: Installed sphinx-notfound-page extension to generate nice 404 pages. -- by humitos
#3480: Merge with pypa/distutils@c397f4c
02 Aug 2022
#2971 : upload_docs command is deprecated once again.
#3443 : Installed sphinx-hoverxref extension to show tooltips on internal an external references. – by @humitos
#3444 : Installed sphinx-notfound-page extension to generate nice 404 pages. – by @humitos
#3480 : Merge with pypa/distutils@c397f4c
Changes ------- * #3475: Merge with pypa/distutils@129480b, including substantial delinting and cleanup, some refactoring around compiler logic, bette
#3475: Merge with pypa/distutils@129480b, including substantial delinting and cleanup, some refactoring around compiler logic, better messaging in cygwincompiler (pypa/distutils#161).
31 Jul 2022
#3475 : Merge with pypa/distutils@129480b , including substantial delinting and cleanup, some refactoring around compiler logic, better messaging in cygwincompiler ( pypa/distutils#161 ).
Changes ------- * #3395: Included a performance optimization: setuptools.build_meta no longer tries to compile the setup script code before exec-ing i
#3395: Included a performance optimization: setuptools.build_meta no longer tries to compile the setup script code before exec-ing it.
#3435: Corrected issue in macOS framework builds on Python 3.9 not installed by homebrew (pypa/distutils#158).
Changes ------- * #3430: Merge with pypa/distutils@152c13d including pypa/distutils#155 (improved compatibility for editable installs on homebrew Pyth
#3430: Merge with pypa/distutils@152c13d including pypa/distutils#155 (improved compatibility for editable installs on homebrew Python 3.9), pypa/distutils#150 (better handling of runtime_library_dirs on cygwin), and pypa/distutils#151 (remove warnings for namespace packages).
the mechanism to do so is deprecated (fetch_build_eggs).
#3421: Drop setuptools' support for installing an entrypoint extra requirements at load time: - the functionality has been broken since v60.8.0. - the mechanism to do so is deprecated (fetch_build_eggs). - that use case (e.g. a custom command class entrypoint) is covered by making sure the necessary build requirements are declared.
#3305: Updated the example pyproject.toml -- by jacalata
#3394: This updates the documentation for the file_finders hook so that the logging recommendation aligns with the suggestion to not use distutils directly.
#3397: Fix reference for keywords to point to the Core Metadata Specification instead of PEP 314 (the live standard is kept always up-to-date and consolidates several PEPs together in a single document).
#3402: Reordered the User Guide's Table of Contents -- by codeandfire
This is a *beta* release including PEP 660 functionality.
This is a beta release including PEP 660 functionality.
config_settings as they would be passed by pip, https://github.com/pypa/setuptools/pull/3380get_output_mapping for the construction of the link tree, https://github.com/pypa/setuptools/pull/3409, https://github.com/pypa/setuptools/pull/3392get_source_files) to sdist, https://github.com/pypa/setuptools/pull/3412Full Diff: https://github.com/pypa/setuptools/compare/v62.6.0...v63.0.0b1
Changes ------- * #3253: Enabled using file: for requirements in setup.cfg -- by akx (this feature is currently considered to be in beta stage). * #32
#3253: Enabled using file: for requirements in setup.cfg -- by akx (this feature is currently considered to be in beta stage).
#3255: Enabled using file: for dependencies and optional-dependencies in pyproject.toml -- by akx (this feature is currently considered to be in beta stage).
#3391: Updated attr: to also extract simple constants with type annotations -- by karlotness
19 Jun 2022
#3253 : Enabled using file: for requirements in setup.cfg – by @akx (this feature is currently considered to be in beta stage).
#3255 : Enabled using file: for dependencies and optional-dependencies in pyproject.toml – by @akx (this feature is currently considered to be in beta stage).
#3391 : Updated attr: to also extract simple constants with type annotations – by @karlotness
Added a simple MANIFEST.in example.
#3347: Changed warnings and documentation notes about experimental aspect of pyproject.toml configuration: now [project] is a fully supported configuration interface, but the [tool.setuptools] table and sub-tables are still considered to be in beta stage.
#3383: In _distutils_hack, suppress/undo the use of local distutils when select tests are imported in CPython.
#3368: Added documentation page about extension modules -- by mkoeppe
#3371: Moved documentation from /userguide/commands to /depracted/commands. This change was motived by the fact that running python setup.py directly is considered a deprecated practice.
#3372: Consolidated sections about sdist contents and MANIFEST.in into a single page.
Added a simple MANIFEST.in example.
#3373: Moved remarks about using Cython to the newly created page for extension modules.
#3374: Added clarification that using python setup.py egg_info commands to manage project versions is only supported in a transitional basis, and that eventually egg_info will be deprecated.
Reorganized sections with tips for managing versions.
#3378: Updated Quickstart docs to make it easier to follow for beginners.
#3385: Modules used to parse and evaluate configuration from pyproject.toml files are intended for internal use only and that not part of the public API.
Extracted text about additional metadata files from userguide/miscellaneous into the existing userguide/extension document.
#3256: Added setuptools.command.build command to match distutils.command.build -- by isuruf
#3366: Merge with pypa/distutils@75ed79d including reformat using black, fix for Cygwin support (pypa/distutils#139), and improved support for cross compiling (pypa/distutils#144 and pypa/distutils#145).
#3355: Changes to the User Guide's Entry Points page -- by codeandfire
#3361: Further minor corrections to the Entry Points page -- by codeandfire
#3363: Rework some documentation pages to de-emphasize distutils and the history of packaging in the Python ecosystem. The focus of these changes is to make the documentation easier to read for new users.
#3364: Update documentation about dependency management, removing mention to the deprecated dependency_links and adding some small improvements.
#3367: Extracted text about automatic resource extraction and the zip-safe flag from userguide/miscellaneous to deprecated/resource_extraction and deprecated/zip_safe.
Extracted text about additional metadata files from userguide/miscellaneous into the existing userguide/extension document.
Updated userguide/extension to better reflect the status of the setuptools project.
Removed userguide/functionalities_rewrite (a virtually empty part of the docs).
Documentation changes --------------------- * #3349: Fixed two small issues preventing docs from building locally -- by codeandfire * #3350: Added not
#3349: Fixed two small issues preventing docs from building locally -- by codeandfire
#3350: Added note explaining package_data glob pattern matching for dotfiles -- by comabrewer
#3358: Clarify the role of the package_dir configuration.
#3354: Improve clarity in warning about unlisted namespace packages.
11 Jun 2022
#3349 : Fixed two small issues preventing docs from building locally – by @codeandfire
#3350 : Added note explaining package_data glob pattern matching for dotfiles – by @comabrewer
#3358 : Clarify the role of the package_dir configuration.
#3354 : Improve clarity in warning about unlisted namespace packages.
Documentation changes --------------------- * #3331: Replaced single backticks with double ones in CHANGES.rst -- by codeandfire * #3332: Fixed gramma
#3331: Replaced single backticks with double ones in CHANGES.rst -- by codeandfire
#3332: Fixed grammar/typos, modified example directory trees for src-layout and flat-layout -- by codeandfire
#3335: Changes to code snippets and other examples in the Data Files page of the User Guide -- by codeandfire
#3336: Modified test_setup_install_includes_dependencies to work with custom PYTHONPATH –- by hroncok
07 Jun 2022
#3331 : Replaced single backticks with double ones in CHANGES.rst – by @codeandfire
#3332 : Fixed grammar/typos, modified example directory trees for src-layout and flat-layout – by @codeandfire
#3335 : Changes to code snippets and other examples in the Data Files page of the User Guide – by @codeandfire
#3336 : Modified test_setup_install_includes_dependencies to work with custom PYTHONPATH –- by @hroncok
Misc ---- * #3328: Include a first line summary to some of the existing multi-line warnings.
#3328: Include a first line summary to some of the existing multi-line warnings.
18 May 2022
#3328 : Include a first line summary to some of the existing multi-line warnings.
Misc ---- * #3320: Fixed typo which causes namespace_packages to raise an error instead of warning.
#3320: Fixed typo which causes namespace_packages to raise an error instead of warning.
17 May 2022
#3320 : Fixed typo which causes namespace_packages to raise an error instead of warning.
Added deprecation tags to test kwargs.
#3262: Formally added deprecation messages for namespace_packages. The methodology that uses pkg_resources and namespace_packages for creating namespaces was already discouraged by the setuptools docs and the Python Packaging User Guide, therefore this change just make the deprecation more official. Users can consider migrating to native/implicit namespaces (as introduced in 420).
#3308: Relying on include_package_data to ensure sub-packages are automatically added to the build wheel distribution (as "data") is now considered a deprecated practice.
This behaviour was controversial and caused inconsistencies (#3260).
Instead, projects are encouraged to properly configure packages or use discovery tools. General information can be found in userguide/package_discovery.
#1806: Allowed recursive globs (**) in package_data. -- by nullableVoidPtr
#3206: Fixed behaviour when both install_requires (in setup.py) and dependencies (in pyproject.toml) are specified. The configuration in pyproject.toml will take precedence over setup.py (in accordance with PEP 621). A warning was added to inform users.
#3307: Added introduction to references/keywords.
Added deprecation tags to test kwargs.
Moved userguide/keywords to deprecated section.
Clarified in deprecated doc what keywords came from distutils and which were added or changed by setuptools.
#3274: Updated version of vendored pyparsing to 3.0.8 to avoid problems with upcoming deprecation in Python 3.11.
#3292: Added warning about incompatibility with old versions of importlib-metadata.
Changes ------- * #3299: Optional metadata fields are now truly optional. Includes merge with pypa/distutils@a7cfb56 per pypa/distutils#138. Misc ----
#3299: Optional metadata fields are now truly optional. Includes merge with pypa/distutils@a7cfb56 per pypa/distutils#138.
#3282: Added CI cache for setup.cfg examples used when testing setuptools.config.
Changes ------- * #3258: Merge pypa/distutils@5229dad46b. Misc ---- * #3249: Simplified package_dir obtained via auto-discovery.
#3258: Merge pypa/distutils@5229dad46b.
#3249: Simplified package_dir obtained via auto-discovery.
10 Apr 2022
#3258 : Merge pypa/distutils@5229dad46b .
#3249 : Simplified package_dir obtained via auto-discovery.
Breaking Changes ---------------- * #3151: Made setup.py develop --user install to the user site packages directory even if it is disabled in the curr
#3151: Made setup.py develop --user install to the user site packages directory even if it is disabled in the current interpreter.
#3153: When resolving requirements use both canonical and normalized names -- by ldaniluk
#3167: Honor unix file mode in ZipFile when installing wheel via install_as_egg -- by delijati
#3088: Fixed duplicated tag with the dist-info command.
#3247: Fixed problem preventing readme specified as dynamic in pyproject.toml from being dynamically specified in setup.py.
Misc ---- * #3233: Included missing test file setupcfg_examples.txt in sdist. * #3233: Added script that allows developers to download setupcfg_exampl
#3233: Included missing test file setupcfg_examples.txt in sdist.
#3233: Added script that allows developers to download setupcfg_examples.txt prior to running tests. By caching these files it should be possible to run the test suite offline.
Changes ------- * #3229: Disabled automatic download of trove-classifiers to facilitate reproducibility. Misc ---- * #3229: Updated pyproject.toml val
#3229: Disabled automatic download of trove-classifiers to facilitate reproducibility.
#3229: Updated pyproject.toml validation via validate-pyproject v0.7.1.
#3229: New internal tool made available for updating the code responsible for the validation of pyproject.toml. This tool can be executed via tox -e generate-validation-code.
.. warning:: Please note that future releases of setuptools will halt the build process if a pyproject.toml file that does not match the PyPA Specific
#3215: Ignored a subgroup of invalid pyproject.toml files that use the [project] table to specify only requires-python (transitional).
Warning
Please note that future releases of setuptools will halt the build process if a pyproject.toml file that does not match the PyPA Specification is given.
#3215: Updated pyproject.toml validation, as generated by validate-pyproject==0.6.1.
#3218: Prevented builds from erroring if the project specifies metadata via pyproject.toml, but uses other files (e.g. setup.py) to complement it, without setting dynamic properly.
Important
This is a transitional behaviour. Future releases of setuptools may simply ignore externally set metadata not backed by dynamic or even halt the build with an error.
#3224: Merge changes from pypa/distutils@e1d5c9b1f6
#3217: Fixed typo in pyproject.toml example in Quickstart -- by pablo-cardenas.
#3223: Fixed missing requirements with environment markers when optional-dependencies is set in pyproject.toml.
Misc ---- * #3212: Fixed missing dependencies when running setup.py install. Note that calling setup.py install directly is still deprecated and will
#3212: Fixed missing dependencies when running setup.py install. Note that calling setup.py install directly is still deprecated and will be removed in future versions of setuptools. Please check the release notes for setup_install_deprecation_note.
26 Mar 2022
#3212 : Fixed missing dependencies when running setup.py install . Note that calling setup.py install directly is still deprecated and will be removed in future versions of setuptools . Please check the release notes for v58.3.0 .
.. note:: Users that don't set packages, py_modules, or configuration are still likely to observe the auto-discovery behavior, which may halt the buil
#3206: Changed setuptools.convert_path to an internal function that is not exposed as part of setuptools API. Future releases of setuptools are likely to remove this function.
#3202: Changed behaviour of auto-discovery to not explicitly expand package_dir for flat-layouts and to not use relative paths starting with ./.
#3203: Prevented pyproject.toml parsing from overwriting dist.include_package_data explicitly set in setup.py with default value.
#3208: Added a warning for non existing files listed with the file directive in setup.cfg and pyproject.toml.
#3208: Added a default value for dynamic classifiers in pyproject.toml when files are missing and errors being ignored.
#3211: Disabled auto-discovery when distribution class has a configuration attribute (e.g. when the setup.py script contains setup(..., configuration=...)). This is done to ensure extension-only packages created with numpy.distutils.misc_util.Configuration are not broken by the safe guard behaviour to avoid accidental multiple top-level packages in a flat-layout.
Note
Users that don't set packages, py_modules, or configuration are still likely to observe the auto-discovery behavior, which may halt the build if the project contains multiple directories and/or multiple Python files directly under the project root.
To disable auto-discovery please explicitly set either packages or py_modules. Alternatively you can also configure custom-discovery.
…configuration format itself is likely to be deprecated in the future).
#3068: Deprecated setuptools.config.read_configuration, setuptools.config.parse_configuration and other functions or classes from setuptools.config.
Users that still need to parse and process configuration from setup.cfg can import a direct replacement from setuptools.config.setupcfg, however this module is transitional and might be removed in the future (the setup.cfg configuration format itself is likely to be deprecated in the future).
#2894: If you purposefully want to create an "empty distribution", please be aware that some Python files (or general folders) might be automatically detected and included.
Projects that currently don't specify both packages and py_modules in their configuration and contain extra folders or Python files (not meant for distribution), might see these files being included in the wheel archive or even experience the build to fail.
You can check details about the automatic discovery (and how to configure a different behaviour) in /userguide/package_discovery.
#3067: If the file pyproject.toml exists and it includes project metadata/config (via [project] table or [tool.setuptools]), a series of new behaviors that are not backward compatible may take place:
The default value of include_package_data will be considered to be True.
Setuptools will attempt to validate the pyproject.toml file according to PEP 621 specification.
The values specified in pyproject.toml will take precedence over those specified in setup.cfg or setup.py.
#2887: [EXPERIMENTAL] Added automatic discovery for py_modules and packages -- by abravalheri.
Setuptools will try to find these values assuming that the package uses either the src-layout (a src directory containing all the packages or modules), the flat-layout (package directories directly under the project root), or the single-module approach (an isolated Python file, directly under the project root).
The automatic discovery will also respect layouts that are explicitly configured using the package_dir option.
For backward-compatibility, this behavior will be observed only if both py_modules and packages are not set. (Note: specifying ext_modules might also prevent auto-discover from taking place)
If setuptools detects modules or packages that are not supposed to be in the distribution, please manually set py_modules and packages in your setup.cfg or setup.py file. If you are using a flat-layout, you can also consider switching to src-layout.
#2887: [EXPERIMENTAL] Added automatic configuration for the name metadata -- by abravalheri.
Setuptools will adopt the name of the top-level package (or module in the case of single-module distributions), only when name is not explicitly provided.
Please note that it is not possible to automatically derive a single name when the distribution consists of multiple top-level packages or modules.
#3066: Added vendored dependencies for tomli, validate-pyproject.
These dependencies are used to read pyproject.toml files and validate them.
#3067: [EXPERIMENTAL] When using pyproject.toml metadata, the default value of include_package_data is changed to True.
#3068: [EXPERIMENTAL] Add support for pyproject.toml configuration (as introduced by 621). Configuration parameters not covered by standards are handled in the [tool.setuptools] sub-table.
In the future, existing setup.cfg configuration may be automatically converted into the pyproject.toml equivalent before taking effect (as proposed in #1688). Meanwhile users can use automated tools like ini2toml to help in the transition.
Please note that the legacy backend is not guaranteed to work with pyproject.toml configuration.
-- by abravalheri
#3125: Implicit namespaces (as introduced in 420) are now considered by default during package discovery, when setuptools configuration and project metadata are added to the pyproject.toml file.
To disable this behaviour, use namespaces = False when explicitly setting the [tool.setuptools.packages.find] section in pyproject.toml.
This change is backwards compatible and does not affect the behaviour of configuration done in setup.cfg or setup.py.
#3152: [EXPERIMENTAL] Added support for attr: and cmdclass configurations in setup.cfg and pyproject.toml when package_dir is implicitly found via auto-discovery.
#3178: Postponed importing ctypes when hiding files on Windows. This helps to prevent errors in systems that might not have libffi installed.
#3179: Merge with pypa/distutils@267dbd25ac
#3172: Added initial documentation about configuring setuptools via pyproject.toml (using standard project metadata).
#3065: Refactored setuptools.config by separating configuration parsing (specific to the configuration file format, e.g. setup.cfg) and post-processing (which includes directives such as file: that can be used across different configuration formats).
Changes ------- * #2971: Deprecated upload_docs command, to be removed in the future. * #3137: Use samefile from stdlib, supported on Windows since Py
#2971: Deprecated upload_docs command, to be removed in the future.
#3137: Use samefile from stdlib, supported on Windows since Python 3.2.
#3170: Adopt nspektr (vendored) to implement Distribution._install_dependencies.
#3144: Added documentation on using console_scripts from setup.py, which was previously only shown in setup.cfg -- by xhlulu
#3148: Added clarifications about MANIFEST.in, that include links to PyPUG docs and more prominent mentions to using a revision control system plugin as an alternative.
#3148: Removed mention to pkg_resources as the recommended way of accessing data files, in favour of importlib.resources. Additionally more emphasis was put on the fact that package data files reside inside the package directory (and therefore should be read-only).
#3120: Added workaround for intermittent failures of backend tests on PyPy. These tests now are marked with XFAIL, instead of erroring out directly.
#3124: Improved configuration for rst-linker (extension used to build the changelog).
#3133: Enhanced isolation of tests using virtual environments - PYTHONPATH is not leaking to spawned subprocesses -- by befeleme
#3147: Added options to provide a pre-built setuptools wheel or sdist for being used during tests with virtual environments. Paths for these pre-built distribution files can now be set via the environment variables: PRE_BUILT_SETUPTOOLS_SDIST and PRE_BUILT_SETUPTOOLS_WHEEL.
Misc ---- * #3093: Repaired automated release process.
#3093: Repaired automated release process.
Misc ---- * #3035: When loading distutils from the vendored copy, rewrite __name__ to ensure consistent importing from inside and out.
#3035: When loading distutils from the vendored copy, rewrite __name__ to ensure consistent importing from inside and out.
15 Feb 2022
#3035 : When loading distutils from the vendored copy, rewrite name to ensure consistent importing from inside and out.
Misc ---- * #3102: Prevent vendored importlib_metadata from loading distributions from older importlib_metadata. * #3103: Fixed issue where string-bas
#3102: Prevent vendored importlib_metadata from loading distributions from older importlib_metadata.
#3103: Fixed issue where string-based entry points would be omitted.
#3107: Bump importlib_metadata to 4.11.1 addressing issue with parsing requirements in egg-info as found in PyPy.
.. warning:: Users trying to install the unmaintained pathlib backport from PyPI/sdist/source code may find problems when using setuptools >= 60.9.0.
#2876: In the build backend, allow single config settings to be supplied.
#2993: Removed workaround in distutils hack for get-pip now that pypa/get-pip#137 is closed.
#3085: Setuptools no longer relies on pkg_resources for entry point handling.
#3098: Bump vendored packaging to 21.3.
Removed bootstrap script.
Warning
Users trying to install the unmaintained pathlib backport from PyPI/sdist/source code may find problems when using setuptools >= 60.9.0. This happens because during the installation, the unmaintained implementation of pathlib is loaded and may cause compatibility problems (it does not expose the same public API defined in the Python standard library).
Whenever possible users should avoid declaring pathlib as a dependency. An alternative is to pre-build a wheel for pathlib using a separated virtual environment with an older version of setuptools and install the library directly from the pre-built wheel.
Misc ---- * #3091: Make concurrent.futures import lazy in vendored more_itertools package to a avoid importing threading as a side effect (which cause
#3091: Make concurrent.futures import lazy in vendored more_itertools package to a avoid importing threading as a side effect (which caused gevent/gevent#1865). -- by maciejp-ro
08 Feb 2022
#3091 : Make concurrent.futures import lazy in vendored more_itertools package to a avoid importing threading as a side effect (which caused gevent/gevent#1865 ). – by @maciejp-ro
Misc ---- * #3084: When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer.
#3084: When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer.
06 Feb 2022
#3084 : When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer.
Changes ------- * #3085: Setuptools now vendors importlib_resources and importlib_metadata and jaraco.text. Setuptools no longer relies on pkg_resourc
#3085: Setuptools now vendors importlib_resources and importlib_metadata and jaraco.text. Setuptools no longer relies on pkg_resources for ensure_directory nor parse_requirements.
05 Feb 2022
#3085 : Setuptools now vendors importlib_resources and importlib_metadata and jaraco.text. Setuptools no longer relies on pkg_resources for ensure_directory nor parse_requirements.
Misc ---- * #3072: Remove lorem_ipsum from jaraco.text when vendored.
#3072: Remove lorem_ipsum from jaraco.text when vendored.
02 Feb 2022
#3072 : Remove lorem_ipsum from jaraco.text when vendored.
Changes ------- * #3061: Vendored jaraco.text and use line processing from that library in pkg_resources. Misc ---- * #3070: Avoid AttributeError in e
#3061: Vendored jaraco.text and use line processing from that library in pkg_resources.
#3070: Avoid AttributeError in easy_install.create_home_path when sysconfig.get_config_vars values are not strings.
Changes ------- * #3043: Merge with pypa/distutils@bb018f1ac3 including consolidated behavior in sysconfig.get_platform (pypa/distutils#104). * #3057:
#3043: Merge with pypa/distutils@bb018f1ac3 including consolidated behavior in sysconfig.get_platform (pypa/distutils#104).
#3057: Don't include optional Home-page in metadata if no url is specified. -- by cdce8p
#3062: Merge with pypa/distutils@b53a824ec3 including improved support for lib directories on non-x64 Windows builds.
#2897: Added documentation about wrapping setuptools.build_meta in a in-tree custom backend. This is a 517-compliant way of dynamically specifying build dependencies (e.g. when platform, OS and other markers are not enough). -- by abravalheri
#3034: Replaced occurrences of the defunct distutils-sig mailing list with pointers to GitHub Discussions. -- by ashemedai
#3056: The documentation has stopped suggesting to add wheel to 517 requirements -- by webknjaz
#3054: Used Py3 syntax super().__init__() -- by imba-tjd
30 Jan 2022
#3043 : Merge with pypa/distutils@bb018f1ac3 including consolidated behavior in sysconfig.get_platform ( pypa/distutils#104 ).
#3057 : Don’t include optional Home-page in metadata if no url is specified. – by @cdce8p
#3062 : Merge with pypa/distutils@b53a824ec3 including improved support for lib directories on non-x64 Windows builds.
#2897 : Added documentation about wrapping setuptools.build_meta in a in-tree custom backend. This is a PEP 517 -compliant way of dynamically specifying build dependencies (e.g. when platform, OS and other markers are not enough). – by @abravalheri
#3034 : Replaced occurrences of the defunct distutils-sig mailing list with pointers to GitHub Discussions. – by @ashemedai
#3056 : The documentation has stopped suggesting to add wheel to PEP 517 requirements – by @webknjaz
#3054 : Used Py3 syntax super().init() – by @imba-tjd
Changes ------- * #2990: Set the .origin attribute of the distutils module to the module's __file__.
#2990: Set the .origin attribute of the distutils module to the module's __file__.
08 Jan 2022
#2990 : Set the .origin attribute of the distutils module to the module’s file .
Since tmp_src was used to populate virtual environments (installing the version of setuptools under test via the source tree), it was replaced by the
#2839: Removed requires sorting when installing wheels as an egg dir.
#2953: Fixed a bug that easy install incorrectly parsed Python 3.10 version string.
#3006: Fixed startup performance issue of Python interpreter due to imports of costly modules in _distutils_hack -- by tiran
#2674: Added link to additional resources on packaging in Quickstart guide
#3008: "In-tree" Sphinx extension for "favicons" replaced with sphinx-favicon.
#3008: SVG images (logo, banners, ...) optimised with the help of the scour package.
#2862: Added integration tests that focus on building and installing some packages in the Python ecosystem via pip -- by abravalheri
#2952: Modified "vendoring" logic to keep license files.
#2968: Improved isolation for some tests that where inadvertently using the project root for builds, and therefore creating directories (e.g. build, dist, *.egg-info) that could interfere with the outcome of other tests -- by abravalheri.
#2968: Introduced new test fixtures venv, venv_without_setuptools, bare_venv that rely on the jaraco.envs package. These new test fixtures were also used to remove the (currently problematic) dependency on the pytest_virtualenv plugin.
#2968: Removed tmp_src test fixture. Previously this fixture was copying all the files and folders under the project root, including the .git directory, which is error prone and increases testing time.
Since tmp_src was used to populate virtual environments (installing the version of setuptools under test via the source tree), it was replaced by the new setuptools_sdist and setuptools_wheel fixtures (that are build only once per session testing and can be shared between all the workers for read-only usage).
Misc ---- * #3002: Suppress AttributeError when detecting get-pip.
#3002: Suppress AttributeError when detecting get-pip.
06 Jan 2022
#3002 : Suppress AttributeError when detecting get-pip.
Changes ------- * #2993: In _distutils_hack, bypass the distutils exception for pip when get-pip is being invoked, because it imports setuptools. Misc
#2993: In _distutils_hack, bypass the distutils exception for pip when get-pip is being invoked, because it imports setuptools.
#2989: Merge with pypa/distutils@788cc159. Includes fix for config vars missing from sysconfig.
Changes ------- * #2974: Setuptools now relies on the Python logging infrastructure to log messages. Instead of using distutils.log.*, use logging.get
#2974: Setuptools now relies on the Python logging infrastructure to log messages. Instead of using distutils.log.*, use logging.getLogger(name).*.
#2987: Sync with pypa/distutils@2def21c5d74fdd2fe7996ee4030ac145a9d751bd, including fix for missing get_versions attribute (#2969), more reliance on sysconfig from stdlib.
#2962: Avoid attempting to use local distutils when the presiding version of Setuptools on the path doesn't have one.
#2983: Restore 'add_shim' as the way to invoke the hook. Avoids compatibility issues between different versions of Setuptools with the distutils local implementation.
Misc ---- * #2980: Bypass distutils loader when setuptools module is no longer available on sys.path.
#2980: Bypass distutils loader when setuptools module is no longer available on sys.path.
28 Dec 2021
#2980 : Bypass distutils loader when setuptools module is no longer available on sys.path.
Changes ------- * #2958: In distutils_hack, only add the metadata finder once. In ensure_local_distutils, rely on a context manager for reliable manip
#2958: In distutils_hack, only add the metadata finder once. In ensure_local_distutils, rely on a context manager for reliable manipulation.
#2963: Merge with pypa/distutils@a5af364910. Includes revisited fix for pypa/distutils#15 and improved MinGW/Cygwin support from pypa/distutils#77.
Misc ---- * #2960: Install schemes fall back to default scheme for headers.
#2960: Install schemes fall back to default scheme for headers.
23 Dec 2021
#2960 : Install schemes fall back to default scheme for headers.
Misc ---- * #2954: Merge with pypa/distutils@eba2bcd310. Adds platsubdir to config vars available for substitution.
#2954: Merge with pypa/distutils@eba2bcd310. Adds platsubdir to config vars available for substitution.
22 Dec 2021
#2954 : Merge with pypa/distutils@eba2bcd310 . Adds platsubdir to config vars available for substitution.
Misc ---- * #2940: Avoid KeyError in distutils hack when pip is imported during ensurepip.
#2940: Avoid KeyError in distutils hack when pip is imported during ensurepip.
20 Dec 2021
#2940 : Avoid KeyError in distutils hack when pip is imported during ensurepip.
Misc ---- * #2938: Select 'posix_user' for the scheme unless falling back to stdlib, then use 'unix_user'.
#2938: Select 'posix_user' for the scheme unless falling back to stdlib, then use 'unix_user'.
20 Dec 2021
#2938 : Select ‘posix_user’ for the scheme unless falling back to stdlib, then use ‘unix_user’.
Misc ---- * #2944: Add support for extended install schemes in easy_install.
#2944: Add support for extended install schemes in easy_install.
20 Dec 2021
#2944 : Add support for extended install schemes in easy_install.
Breaking Changes ---------------- * #2896: Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUT
#2896: Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUTILS=stdlib.
19 Dec 2021
#2896 : Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUTILS=stdlib.
Changes ------- * #2935: Merge pypa/distutils@460b59f0e68dba17e2465e8dd421bbc14b994d1f.
#2935: Merge pypa/distutils@460b59f0e68dba17e2465e8dd421bbc14b994d1f.
19 Dec 2021
#2935 : Merge pypa/distutils@460b59f0e68dba17e2465e8dd421bbc14b994d1f .
Changes ------- * #2930: Require Python 3.7
#2930: Require Python 3.7
Changes ------- * #2925: Merge with pypa/distutils@92082ee42c including introduction of deprecation warning on Version classes.
#2925: Merge with pypa/distutils@92082ee42c including introduction of deprecation warning on Version classes.
12 Dec 2021
#2925 : Merge with pypa/distutils@92082ee42c including introduction of deprecation warning on Version classes.
Changes ------- * #2914: Merge with pypa/distutils@8f2df0bf6.
#2914: Merge with pypa/distutils@8f2df0bf6.
Changes ------- * #2893: Restore deprecated support for newlines in the Summary field.
#2893: Restore deprecated support for newlines in the Summary field.
28 Nov 2021
#2893 : Restore deprecated support for newlines in the Summary field.
Your coding agent can read these notes before it upgrades. Set up the MCP server →