Remove post-release tags on setuptools’ own build. (#4530)

#5033

Set a deadline for the removal of pkg_resources later this year (December). (#3085)

Removed reliance on pkg_resources in test_wheel. (#3085)

Replaced more references to pkg_resources with importlib equivalents in wheel odule. (#3085)

Restore explicit LICENSE file. (#5001)

Removed no longer used build dependency oncoherent.licensed. (#5003)

Only attempt to fetch eggs for unsatisfied requirements. (#4998)

In installer, when discovering egg dists, let metadata discovery search each egg. (#4998)

Removed usage of pkg_resources from installer. Set an official deadline on the installer deprecation to 2025-10-31. (#4997)

#4996

Added a build dependency on coherent.licensed to inject the declared license text at build time. (#4981)

#4995

Replaced more references to pkg_resources with importlib equivalents. (#3085)

#4982

Simplified the error reporting in editable installs. (#4984)

Restored select attributes in easy_install for temporary pbr compatibility. (#4976)

Removed easy_install and package_index modules. (#917)

Restored license declaration in package metadata. See jaraco/skeleton#171. (#4956)

Restored support for install_scripts –executable (and classic behavior for the executable for those invocations). Instead, build_editable provides the portable form of the executables for downstream installers to rewrite. (#4934)

Added a deadline of Oct 31 to the setup.py install deprecation.

Withsetup.pyinstall--prefix=..., fall back to distutils install rather than failing. Note that runningsetup.pyinstall is deprecated. (#3143)

Fixed index_url logic in develop compatibility shim. (#4966)

Update test to honor new behavior in importlib_metadata 8.7. (#4961)

Removed support for the easy_install command including the sandbox module. (#2908)

Develop command no longer uses easy_install, but instead defers execution to pip (which then will re-invoke Setuptools viaPEP 517 to build the editable wheel). Most of the options to develop are dropped. This is the final warning before the command is dropped completely in a few months. Use-cases relying on ‘setup.py develop’ should pin to older Setuptools version or migrate to modern build tooling. (#4955)

Merge withpypa/distutils@24bd3179b including fix forpypa/distutils#355.

Removed support for ‘legacy-editable’ installs. (#917)

More fully sanitized the filename in PackageIndex._download. (#4946)

Restore access to _get_vc_env with a warning. (#4874)

Postponed removals of deprecated dash-separated and uppercase fields insetup.cfg.All packages with deprecated configurations are advised to move before 2026. (#4911)

#4909

Reverted distutils changes that broke the monkey patching of command classes. (#4902)

Setuptools no longer accepts options containing uppercase or dash characters insetup.cfg.Please ensure to write the options insetup.cfg using thelower_snake_case convention(e.g.Name=>name,install-requires=>install_requires).This is a follow-up on deprecations introduced inv54.1.0 (see#1608) andv54.1.1 (see#2592).

#4904

Temporarily convert error for license glob patterns containing../ into a deprecation warningto allow an accomodation period. (#4896)

Better error messages forpackaging.licenses import errors in environments withpackaging<24.2.The import statement was also deferred to spare users that are not usinglicense expressions. (#4898)

Avoided eagerly raising an exception whenlicense-files is definedsimultaneously inside and outside ofpyproject.toml.Instead we rely on the existing deprecation error. (#4899)

Restoredistutils.ccompiler._default_compilers – by@ManiacDC (#4876)

Fixed copy pasta inmsvc.shared_lib_format. (#4885)

Manually fix news fragment entries causing CI to crash when building docs. (#4891)

Added initial support for license expression (PEP639). – by@cdce8p (#4706)

StoreLicense-Files in.dist-info/licenses subfolder and added support for recursive globs forlicense_files (PEP639). – by@cdce8p (#4728)

Bump core metadata version to2.4. – by@cdce8p (#4830)

Updated vendored copy ofwheel tov0.45.1. (#4869)

Added initial implementation ofPEP 639.Users relying on pre-PEP 639 implementation details(like precise license file paths insidedist-info directory)may need to adjust their code base to avoid problems.Deprecations and stronger validation were also introduced (#4829).

Added exception (or warning) when deprecated license classifiers are used,according to PEP639. (#4833)

Deprecatedtools.setuptools.license-files in favor ofproject.license-filesand added exception ifproject.license-files andtools.setuptools.license-filesare used together. – by@cdce8p (#4837)

Deprecatedproject.license as a TOML table inpyproject.toml. Users are expected to move towards usingproject.license-files and/or SPDX expressions (as strings) inproject.license.See PEP639. (#4840)

Added simple validation for given glob patterns inlicense-files:a warning will be generated if no file is matched.Invalid glob patterns can raise an exception.– thanks@cdce8p for contributions. (#4838)

#4734

In setuptools.msvc.EnvironmentInfo, now honor the correct paths when on an ARM host. (#4786)

Restored implicit distutils.ccompiler import for g-ir-scanner. (#4871)

Restoredistutils.ccompiler.compiler_class – by@Avasam (#4876)

Fix wheel file naming to follow binary distribution specification – by@di (#4877)

Synced withpypa/distutils@5589d7527 including a simplified shebang generation when building scripts (#4863). (#4865)

Fix ImportError in distutils when configuring for linking. (#4866)

Synced withpypa/distutils@91f75bb98 including exporting of PyInit_pkg (pypa/distutils#327) and a refactoring of the compiler classes into distutils.compilers (pypa/distutils#295). (#4852)

Fixedpkg_resources.require(...) to also consider standardiseddist-info directories. (#4856)

Fix wheel file naming to follow binary distribution specification – by@di (#4766)

Fixed crash generating error message printed when building wheels for thefree-threaded build using the limited API. – by@ngoldbaum (#4809)

Fix documentation for recent CFLAGS distutils change. – by@thesamesam (#4836)

ImplementedDynamic field for core metadata (as introduced inPEP 643).The existing implementation is currently experimental and the exact approachmay change in future releases. (#4698)

Synced withpypa/distutils@c97a3db2f including better support for free threaded Python on Windows (pypa/distutils#310), improved typing support, and linter accommodations. (#4478)

Synced withpypa/distutils@ff11eed0c including bugfix for duplicate CFLAGS and adaption to support Python 3.13 is_abs in the C compiler (#4669). (#4790)

Preserve originalPKG-INFO intoMETADATA when creating wheel(instead of callingwheel.metadata.pkginfo_to_metadata).This helps to be more compliant with the flow specified inPEP 517. (#4701)

Changed theWindowsSdkVersion,FrameworkVersion32 andFrameworkVersion64 properties ofsetuptools.msvc.PlatformInfo to return an emptytuple instead ofNone as a fallthrough case – by@Avasam (#4754)

Removed support forSETUPTOOLS_DANGEROUSLY_SKIP_PYPROJECT_VALIDATION, as itis deemed prone to errors. (#4746)

Added support for the environment variableSETUPTOOLS_DANGEROUSLY_SKIP_PYPROJECT_VALIDATION=true, allowing users to bypassthe validation ofpyproject.toml.This option should be used only as a last resort when resolving dependencyissues, as it may lead to improper functioning.Users who enable this setting are responsible for ensuring thatpyproject.tomlcomplies with setuptools requirements. (#4611)

Require Python 3.9 or later. (#4718)

Remove dependency onimportlib_resourcesand the vendored copy of the library.Instead,setuptools consistently rely on stdlib’simportlib.resources(available on Python 3.9+). (#4718)

Setuptools’bdist_wheel implementation no longer produces wheels withthem SOABI flag (pymalloc-related).This flag was removed on Python 3.8+ (seesys.abiflags). (#4718)

Updated vendored packaging version to 24.2. (#4740)

Merge withpypa/distutils@251797602, including fix for dirutil.mkpath handling inpypa/distutils#304.

Allowed usingdict as an ordered type insetuptools.dist.check_requirements – by@Avasam (#4575)

Ensured methods insetuptools.modified preferably raise a consistentdistutils.errors.DistutilsError type(except in the deprecated use case ofSETUPTOOLS_USE_DISTUTILS=stdlib)– by@Avasam (#4567)

Fix the ABI tag when building a wheel using the debug build of Python 3.13 on Windows. Previously, the ABI tag was missing the"d" flag. (#4674)

Fix clashes foroptional-dependencies inpyproject.toml andextra_requires insetup.cfg/setup.py.As perPEP 621,optional-dependencies have to be honoured and dynamicbehaviour is not allowed. (#4696)

#4560

Made errors when parsingDistribution data more explicit about the expected type (tuple[str,...]|list[str]) – by@Avasam (#4578)

Fix aTypeError when aDistribution’s old included attribute was atuple – by@Avasam (#4578)

Add workaround forbdist_wheel--dist-info-dir errorswhen customisation does not inherit from setuptools. (#4684)

Re-use pre-existing.dist-info dir when creating wheels via the build backend APIs (PEP 517) and themetadata_directory argument is passed – by@pelson. (#1825)

Changedegg_info command to avoid adding an empty.egg-info directorywhile iterating over entry-points.This avoids triggering integration problems withimportlib.metadata/importlib_metadata(reference:pypa/pyproject-hooks#206). (#4680)

Deprecatedbdist_wheel.universal configuration. (#4617)

Removed reference to upload_docs module in entry points. (#4650)

Declare also the dependencies used by distutils (adds jaraco.collections).

Removed upload_docs command. (#2971)

Merge withpypa/distutils@7283751. Removed the register and upload commands and the config module that backs them (pypa/distutils#294). Removed the borland compiler. Replaced vendored dependencies with natural dependencies. Cygwin C compiler now gets compilers from sysconfig (pypa/distutils#296). (#4649)

Fix cross-platform compilation usingdistutils._msvccompiler.MSVCCompiler – by@saschanaz and@Avasam (#4648)

Fixed TypeError in sdist filelist processing by adding support for pathlib Paths for the build_base. (#4615)

Removed degraded and deprecatedtest_integration (easy_install) from the test suite. (#4632)

Fixed TypeError inmsvc.EnvironmentInfo.return_env when no runtime redistributables are installed. (#1902)

Added support for definingext-modules viapyproject.toml(EXPERIMENTAL, may change in future releases). (#4568)

Merge withpypa/distutils@3dcdf8567, removing the duplicate vendored copy of packaging. (#4622)

Restoredsetuptools.msvc.Environmentinfo as it is used externally. (#4625)

Changed the type of error raised bysetuptools.command.easy_install.CommandSpec.from_param on unsupported argument fromAttributeError toTypeError – by@Avasam (#4548)

Added detection of ARM64 variant of MSVC – by@saschanaz (#4553)

Madesetuptools.package_index.Credential atyping.NamedTuple – by@Avasam (#4585)

Reraise error fromsetuptools.command.easy_install.auto_chmod instead of nonsensicalTypeError:'Exception'objectisnotsubscriptable – by@Avasam (#4593)

Fully typed all collection attributes inpkg_resources – by@Avasam (#4598)

Automatically exclude.tox|.nox|.venv directories fromsdist. (#4603)

Removed the monkeypatching of distutils._msvccompiler. Now all compiler logic is consolidated in distutils. (#4600)

Synced withpypa/distutils@58fe058e4, including consolidating Visual Studio 2017 support (#4600,pypa/distutils#289), removal of deprecated legacy MSVC compiler modules (pypa/distutils#287), suppressing of errors when the home directory is missing (pypa/distutils#278), removal of wininst binaries (pypa/distutils#282). (#4606)

#4592

Removeabc.ABCMeta metaclass from abstract classes.pypa/setuptools#4503<https://github.com/pypa/setuptools/issues/4503>`_<https://github.com/pypa/setuptools/pull/4503>`_hadanunintendedconsequenceofcausingpotential``TypeError:metaclassconflict:themetaclassofaderivedclassmustbea(non-strict)subclassofthemetaclassesofallitsbases – by@Avasam (#4579)

Mark abstract base classes and methods withabc.ABC andabc.abstractmethod – by@Avasam (#4503)

Changed the order of type checks insetuptools.command.easy_install.CommandSpec.from_param to support anycollections.abc.Iterable ofstr param – by@Avasam (#4505)

Prevent an error inbdist_wheel ifcompression is set to astr (even if valid) after finalizing options but before running the command. – by@Avasam (#4383)

Raises an exception whenpy_limited_api is used in a build withPy_GIL_DISABLED. This is currently not supported (python/cpython#111506). (#4420)

Synced withpypa/distutils@30b7331 including fix for modified check on empty sources (pypa/distutils#284).

setuptools is replacing the usages ofordered_set with simpleinstances ofdict[Hashable,None]. This is done to remove the extradependency and it is possible because since Python 3.7,dict maintaininsertion order. (#4574)

#4534,#4546,#4554,#4559,#4565

Merged withpypa/distutils@b7ee725f3 including: Support for Pathlike objects in data files and extensions (pypa/distutils#272,pypa/distutils#237), native support for C++ compilers (pypa/distutils#228) and removed unused get_msvcr() (pypa/distutils#274). (#4538)

Restore the tests command and deprecate access to the module. (#4519) (#4520)

The test command has been removed. Users relying on ‘setup.py test’ will need to migrate to another test runner or pin setuptools before this version. (#931)

Added return types to typed public functions – by@Avasam

MarkedPackage Discovery and Resource Access using pkg_resources aspy.typed – by@Avasam (#4409)

#4492

Removed lingering unused code around Distribution._patched_dist. (#4489)

Reset the backports module when enabling vendored packages. (#4476)

Include all vendored files in the sdist. (#4480)

Restored package data that went missing in 71.0. This change also incidentally causes tests to be installed once again. (#4475)

Now setuptools declares its own dependencies in thecore extra. Dependencies are still vendored for bootstrapping purposes, but setuptools will prefer installed dependencies if present. Thecore extra is used for informational purposes and shouldnot be declared in package metadata (e.g.build-requires). Downstream packagers can de-vendor by simply removing thesetuptools/_vendor directory. Since Setuptools now prefers installed dependencies, those installing to an environment with old, incompatible dependencies will not work. In that case, either uninstall the incompatible dependencies or upgrade them to satisfy those declared incore. (#2825)

Support for loading distutils from the standard library is now deprecated, including use of SETUPTOOLS_USE_DISTUTILS=stdlib and importing distutils before importing setuptools. (#4137)

Bugfix for building Cython extension on Windows (pypa/distutils#268).

Updated distutils including significant changes to support Cygwin and mingw compilers. (#4444)

Fix distribution name normalisation (PEP 625) for valid versions that arenot canonical (e.g.1.0-2). (#4434)

#4429

Adopted thebdist_wheel command from thewheel project – by@agronholm (#1386)

Improve error message whenpkg_resources.ZipProvider tries to extract resources with a missing Egg – by@Avasam

Added variables and parameter type annotations topkg_resources to be nearly on par with typeshed.* – by@Avasam* ExcludingTypeVar andoverload. Return types are currently inferred. (#4246)

Migrated Setuptools’ own config to pyproject.toml (#4310)

Prevent aTypeError:'NoneType'objectisnotcallable whenshutil_rmtree is called without anonexc parameter on Python<=3.11 – by@Avasam (#4382)

Replace use of mktemp with can_symlink from the stdlib test suite. (#4403)

Improvement forattr: directives in configuration to handlemore edge cases related to complexpackage_dir. (#4405)

Fix accidental implicit string concatenation. (#4411)

#4365,#4422

Emit a warning when[tools.setuptools] is present inpyproject.toml and will be ignored. – by@SnoopJ (#4150)

ImprovedAttributeError error message ifpkg_resources.EntryPoint.require is called without extras or distributionGracefully “do nothing” when trying to activate apkg_resources.Distribution with aNone location, rather than raising aTypeError– by@Avasam (#4262)

Typed the dynamically defined variables fromPackage Discovery and Resource Access using pkg_resources – by@Avasam (#4267)

Modernized and refactored VCS handling in package_index. (#4332)

In install command, use super to call the superclass methods. Avoids race conditions when monkeypatching from _distutils_system_mod occurs late. (#4136)

Fix finder template for lenient editable installs of implicit nested namespacesconstructed by usingpackage_dir to reorganise directory structure. (#4278)

Fix an error withUnicodeDecodeError handling inpkg_resources when trying to read files in UTF-8 with a fallback – by@Avasam (#4348)

Uses RST substitution to put badges in 1 line. (#4312)

Further adoption of UTF-8 insetuptools.This change regards mostly files produced and consumed during the build process(e.g. metadata files, script wrappers, automatically updated config files, etc..)Although precautions were taken to minimize disruptions, some edge cases mightbe subject to backwards incompatibility.

Support for"locale" encoding is nowdeprecated. (#4309)

Removesetuptools.convert_path after long deprecation period.This function was never defined bysetuptools itself, but rather aside-effect of an import for internal usage. (#4322)

Remove fallback for customisations ofdistutils’build.sub_command after longdeprecated period.Users are advised to importbuild directly fromsetuptools.command.build. (#4322)

Removedtyping_extensions from vendored dependencies – by@Avasam (#4324)

Remove deprecatedsetuptools.dep_util.The provided alternative issetuptools.modified. (#4360)

#4255,#4280,#4282,#4308,#4348

Refresh unpinned vendored dependencies. (#4253)

Updated vendored packaging to version 24.0. (#4301)

Merged bugfix forpypa/distutils#246.

Merged withpypa/distutils@55982565e, including interoperability improvements for rfc822_escape (pypa/distutils#213), dynamic resolution of config_h_filename for Python 3.13 compatibility (pypa/distutils#219), added support for the z/OS compiler (pypa/distutils#216), modernized compiler options in unixcompiler (pypa/distutils#214), fixed accumulating flags bug after compile/link (pypa/distutils#207), fixed enconding warnings (pypa/distutils#236), and general quality improvements (pypa/distutils#234). (#4298)

Remove attempt to canonicalize the version. It’s already canonical enough. (#4302)

SupportPEP 625 by canonicalizing package name and version in filenamesperthe spec.Projects whose names contain uppercase characters, dashes, or periods willnow see their sdist names normalized to match the standard and the formatpreviously seen in wheels. For example:

• zope.interface ->zope_interface

• CherryPy ->cherrypy

• foo-bar_baz ->foo_bar_baz

Projects are encouraged to adopt this change to align with standards andother backend build systems. (#3593)

Explicitly useencoding="locale" for.pth files whenever possible,to reduceEncodingWarnings.This avoid errors with UTF-8 (see discussion inpython/cpython#77102). (#4265)

Clarify somePackage Discovery and Resource Access using pkg_resources methods returnbytes, notstr. Also return an emptybytes inEmptyProvider._get – by@Avasam (#4243)

Return an emptylist by default inpkg_resources.ResourceManager.cleanup_resources – by@Avasam (#4244)

Madepkg_resoursces.NullProvider’shas_metadata andmetadata_isdir methods return actual booleans like all other Providers. – by@Avasam (#4254)

#4237,#4238,#4241,#4260,#4261,#4263

Fix argument order of--config-settings["--build-option"] arguments.This was broken by <https://github.com/pypa/setuptools/pull/4079>`. (#4217)

#4231

Updated and removed obsolete Python < 3.8 code and comments. – by@Avasam (#4096)

UpdatedPackage Discovery and Resource Access using pkg_resources to use stdlibimportlib.machinery instead ofimportlib_machinery – by@Avasam (#4097)

In tests, rely on pytest-home for reusable fixture. (#4072)

Explicitly marked asProtocol and fixed missingself argument in interfacespkg_resources.IMetadataProvider andpkg_resources.IResourceProvider – by@Avasam (#4144)

Restored expectation that egg-link files would be named with dash separators for compatibility with pip prior to version 24. (#4167)

Updated documentation referencing obsolete Python 3.7 code. – by@Avasam (#4096)

Changedversionadded for “Type information included by default” feature fromv68.3.0 tov69.0.0 – by@Avasam (#4182)

Described the auto-generated files – by@VladimirFokow (#4198)

Updated “Quickstart” to describe the current status ofsetup.cfg andpyproject.toml – by@VladimirFokow (#4200)

Retain valid names with underscores in egg_info.

Added missing estimated date for removingsetuptools.dep_util (deprecated in v69.0.0). (#4131)

Fixed imports ofsetuptools.dep_util.newer_group.A deprecation warning is issued instead of a hard failure. (#4126)

Include type information (py.typed,*.pyi) by default (#3136) – by@Danie-1,EXPERIMENTAL. (#3136)

Exporteddistutils.dep_util andsetuptools.dep_util throughsetuptools.modified – by@Avasam (#4069)

Merged withpypa/distutils@7a04cbda0fc714.

Replaced hardcoded numeric values withdis.opmap,fixing problem with 3.13.0a1. (#4094)

Configuring projectversion andegg_info.tag_* in such a way thatresults in invalid version strings (according toPEP 440) is no longer permitted. (#4066)

Removed deprecatedegg_base option fromdist_info.Note that thedist_info command is considered internal to the waysetuptools build backend works and not intended forpublic usage. (#4066)

The parsing of the deprecatedmetadata.license_file andmetadata.requires fields insetup.cfg is no longer supported.Users are expected to move tometadata.license_files andoptions.install_requires (respectively). (#4066)

Passingconfig_settings tosetuptools.build_meta withdeprecated values for--global-option is no longer allowed. (#4066)

Removed deprecatednamespace-packages frompyproject.toml.Users are asked to useimplicit namespace packages(as defined inPEP 420). (#4066)

Added strict enforcement forproject.dynamic inpyproject.toml.This removes the transitional ability of users configuring certain parametersviasetup.py without making the necessary changes topyproject.toml(as mandated byPEP 621). (#4066)

Removed handling of--config-settings["--build-option"] insetuptools.build_metafrom build-backend API hooksother thanbuild_wheel.This was motivate byerrors caused when passing this option. (#4079)

Improve backwards compatibility with deprecated CLI practices. (#4048)

Avoid using caching attributes inDistribution.metadata for requirements.This is done for backwards compatibility with customizations that attempt tomodifyinstall_requires orextras_require at a late point (still notrecommended). (#4043)

#4045

Rework howsetuptools internally handlesdependencies/install_requiresandoptional-dependencies/extras_require. (#3903)

Improve the generatedPKG-INFO files, by addingRequires-Dist fields.Previously, these fields would be omitted in favour of a non-standard*.egg-info/requires.txt file (which is still generated for the time being). (#3904)

Improve atomicity when writingPKG-INFO files to avoid raceconditions withimportlib.metadata. (#3904)

Fix the name given to the*-nspkg.pth files in editable installs,ensuring they are unique per distribution. (#4041)

Workaround some limitations onpkg_resources-style legacy namespaces inthe meta path finder for editable installations. (#4041)

#4023,#4027,#4027

#4022,#4022

Fix editable install finder handling of nested packages, by only handling 1level of nesting and relying onimportlib.machinery to find the remainingmodules based on the parent package path. (#4020)

Removed code referencing bdist_wininst in install_scripts. (#3525)

Promotepyproject.toml’s[tool.setuptools] out of beta.Note that some fields are still considered deprecated and/or obsolete,and these might be removed in future versions (i.e., there is no guaranteefor long term support and backward compatibility on those fields). (#3962)

Automatically add files listed inExtension.depends to sdists,as long as they are contained in the project directory – by@RuRo (#4000)

Require Python 3.8 or later.

Made imports in editable installs case-sensitive on case-insensitive filesystems – by@aganders3 (#3995)

Use default encoding to create.pth files witheditable_wheel. (#4009)

Detects (and complain about)scripts andgui-scripts set viasetup.pywhenpyproject.toml does not include them indynamic. (#4012)

#3833,#3960,#4001,#4007

#3948: Removed verification for existingdepends.txt file (deprecated since v0.5a4).

#3948: Remove autofixing of broken.egg-info directories containing the-character in their base name (without suffix).They should no longer be produced by sufficiently new versions ofsetuptools(warning introduced in 2005).

#3948: Remove deprecated APIs ineasy_install:get_script_args,get_script_header andget_writer.The direct usage ofeasy_install has been deprecated since v58.3.0,and the warnings regarding these APIs predate that version.

#3948: Removedegg_info.get_pkg_info_revision (deprecated since 2015).

#3948: Removedsetuptools.dist._get_unpatched (deprecated since 2016)

#3948: Removed support for SVN insetuptools.package_index (deprecated since 2018).

#3948: Removed support for invalidpyproject.toml files.During the implementation ofPEP 621, it was identified that some users wereproducing invalid files. As a transitional measure, the validation was relaxedfor a few use cases. The grace period, however, came to an end.

#3760: Added symlink support to launcher for installed executables – by@eugene-sevostianov-sc

#3926: Updated vendoredpackaging version from 23.0 to 23.1 – by@MetRonnie

#3950: Implemented workaround for old versions ofvswhere, which miss the-requiresAny parameter, such as the ones distributed together with Visual Studio 2017 < 15.6.

#3952: ChangedDistutilsMetaFinder to skipspec_for_pip on Python >= 3.12.

#3952: Removed_distutils_hack.remove_shim on Python >= 3.12(sincedistutils was removed from the standard library,DistutilsMetaFinder cannot be disabled on Python >= 3.12).

#3920: Add a link to deprecation warning inpkg_resources and improvestacklevel for better visibility.

#3128: In deprecated easy_install, reload and merge the pth file before saving.

#3915: Adequate tests to the latest changes invirtualenv for Python 3.12.

#3902: Fixed wrong URLs used in warnings and logs.

#3898: Fixes setuptools.dist:invalid_unless_false when value is false don’t raise error – by@jammarher

#3849: Overhaul warning system for better visibility.

#3859: Added a note about historical presence ofwheelinbuild-system.requires, inpyproject.toml.

#3893: Improved the documentation example regarding making a thinPEP 517 in-treebackend wrapper ofsetuptools.build_meta that is future-proof and supportsPEP 660 hook too – by@webknjaz.

#3884: Add astacklevel parameter towarnings.warn() to provide more information to the user.– by@cclauss

#3865: Fixed_WouldIgnoreField warnings forscripts andgui_scripts,whenentry-points is not listed in dynamic.

#3875: Update code generated byvalidate-pyproject to use v0.12.2.This should fix default license patterns whenpyproject.toml is used.

#3804: Added caching for supported wheel tags.

#3846: Added pruning heuristics toPackageFinder based onexclude.

#3836: Fixed interaction betweensetuptools’ package auto-discovery andauto-generatedhtmlcov files.

Previously, thehtmlcov name was ignored when searching for single-filemodules, however the correct behaviour is to ignore it when searching forpackages (since it is supposed to be a directory, seecoverage config)– by@yukihiko-shinoda.

#3838: Improved error messages forpyproject.toml validations.

#3839: Fixedpkg_resources errors caused when parsing metadata of packages thatare already installed but do not conform withPEP 440.

#3843: Although pkg_resources has been discouraged for use, some projects still consider pkg_resources viable for usage. This change makes it clear that pkg_resources should not be used, emitting a DeprecationWarning when imported.

#3832: Update vendoredimportlib-metadata (to 6.0.0) andimportlib-resources (to 5.10.2)

#3820: Restore quoted#include argument tohas_function.

#3827: Improve deprecation warning message onpkg_resources.declare_namespaceto display package name.

#3823: Fixesegg_info code path triggered during integration withpip.

#3434: Added deprecation warning forpkg_resources.declare_namespace.Users that wish to implement namespace packages, are recommended to follow thepractice described inPEP 420 and omit the__init__.py file entirely.

#3792: Reduced usage ofpkg_resources insetuptools via internalrestructuring and refactoring.

#3822: Added debugging tips for “editable mode” and update related docs.Instead of using a custom exception to display the help message to the user,setuptools will now use a warning and re-raise the original exception.

#3822: Added clarification abouteditable_wheel anddist_info CLI commands:they should not be called directly withpythonsetup.py....Instead they are reserved for internal use ofsetuptools (effectively as “private” commands).Users are recommended to rely on build backend APIs (PEP 517 andPEP 660)exposed bysetuptools.build_meta.

#3809: Merge withdistutils@8c3c3d29, including fix forsysconfig.get_python_inc() (pypa/distutils#178), fix for segfault on MinGW (pypa/distutils#196), and betterhas_function support (pypa/distutils#195,#3648).

#3795: Ensured that__file__ is an absolute path when executingsetup.py aspart ofsetuptools.build_meta.

#3798: Updated validations forpyproject.toml usingvalidate-pyproject==0.12.1to allow stub packages (PEP 561) to be listed intool.setuptools.packagesandtool.setuptools.package-dir.

#3741: Removed patching ofdistutils._msvccompiler.gen_lib_optionsfor compatibility with Numpy < 1.11.2 – by@mgorny

#3790: Bump vendored version ofpackaging to 23.0(pyparsing is no longer required and was removed).As a consequence, users will experience a more strict parsing of requirements.Specifications that don’t comply withPEP 440 andPEP 508 will resultin build errors.

#3782: Fixed problem withfile directive intool.setuptools.dynamic(pyproject.toml) when value is a simple string instead of list.

#3685: Fix improper usage of deprecated/removedpkgutil APIs in Python 3.12+.

#3779: Files referenced byfile: insetup.cfg and byproject.readme.file,project.license.file ortool.setuptools.dynamic.*.file inpyproject.toml are now automatically included in the generated sdists.

#3776: Added note about using the--pep-517 flag withpip to workaroundInvalidVersion errors for packages that are already installed in the system.

#2497: Support forPEP 440 non-conforming versions has been removed. Environments containing packages with non-conforming versions may fail or the packages may not be recognized.

#3769: Replace ‘appdirs’ with ‘platformdirs’.

#3594: Addedhtmlcov to FlatLayoutModuleFinder.DEFAULT_EXCLUDE – by@demianbrecht

#3667: Added a human-readable error description when.egg-info directory is not writeable – by@droodev

#3713: Fixed incompletegetattr statement that caused problems when accessingundefined attribute.

#3709: Fix condition to patchdistutils.dist.log to only apply when usingdistutils from the stdlib.

#3689: Documented thatdistutils.cfg might be ignored unlessSETUPTOOLS_USE_DISTUTILS=stdlib.

#3678: Improve clib builds reproducibility by sorting sources – by@danigm

#3684: Improved exception/traceback when invalid entry-points are specified.

#3690: Fixed logging errors: ‘underlying buffer has been detached’ (issue#1631).

#3693: Mergepypa/distutils@3e9d47e with compatibility fix for distutils.log.Log.

#3695,#3697,#3698,#3699: Changed minor text details (spelling, spaces …)

#3696: Removed unnecessarycoding:utf-8 annotations

#3704: Fixed temporary build directories interference with auto-discovery.

#3674: Sync withpypa/distutils@e0787fa, includingpypa/distutils#183 updating distutils to use the Python logging framework.

#3638: Drop a test dependency on themock package, always useunittest.mock – by@hroncok

#3659: Fixed REDoS vector in package_index – by@SCH227

#3624: Fixed editable install for multi-module/no-packagesrc-layout projects.

#3626: Minor refactorings to support distutils using stdlib logging module.

#3419: Updated the example version numbers to be compliant withPEP-440 on the “Specifying Your Project’s Version” page of the user guide.

#3569: Improved information about conflicting entries in the current working directoryand editable install (in documentation and as an informational warning).

#3576: Updated version ofvalidate_pyproject.

#3613: Fixed encoding errors inexpand.StaticModule when system default encoding doesn’t match expectations for source files.

#3617: Merge withpypa/distutils@6852b20 including fix forpypa/distutils#181.

#3609: Merge withpypa/distutils@d82d926 including support for DIST_EXTRA_CONFIG inpypa/distutils#177.

#3547: StopConfigDiscovery.analyse_name from splatting theDistribution.name attribute – by@jeamland

#3554: Changed requires to requests in the pyproject.toml example in theDependency management section of the Quickstart guide – by@mfbutner

#3561: Fixed accidental name matching in editable hooks.

#3553: Sync withpypa/distutils@22b9bcf, including fixed cross-compiling support and removing deprecation warning perpypa/distutils#169.

#3551: Avoided circular imports in meta path finder for editable installs when amissing module has the same name as its parent.

#3536: Remove monkeypatching of msvc9compiler.

#3538: Corrected documentation on how to use thelegacy-editable mode.

#3505: Restored distutils msvccompiler and msvc9compiler modules and marked as deprecated (pypa/distutils@c802880).

#3529: Added clarification toQuickstart about supporttosetup.py.

#3526: Fixed backward compatibility of editable installs and custombuild_extcommands inheriting directly fromdistutils.

#3528: Fixedbuid_meta.prepare_metadata_for_build_wheel whengivenmetadata_directory is".".

#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 inkeywords documentation regarding editable installationsto specify whichsetuptools version require a minimalsetup.py file or not.

#3515: Fixed “inline” file copying for editable installations andoptional extensions.

#3517: Fixededitable_wheel to ensure other commands are finalized before usingthem. This should prevent errors with plugins trying to use different commandsor reinitializing them.

#3517: Augmented filter to prevent transient/temporary source files from beingconsideredpackage_data ordata_files.

#3506: Suppress errors in custombuild_py implementations when running editableinstalls in favor of a warning indicating what is the most appropriatemigration path.This is atransitional measure. Errors might be raised in future versions ofsetuptools.

#3512: Added capability of handling namespace packages createdaccidentally/purposefully via discovery configuration during editable installs.This should emulate the behaviour of a non-editable installation.

#3497: Fixededitable_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 isproduced inside the project dir, which may not be the case in editable installs(the.egg-info directory is produced inside the metadata directory given bythe build frontend viaPEP 660 hooks).

#3380: Passing some types of parameters via--global-option to setuptoolsPEP 517/PEP 660 backendis now considered deprecated. The user can pass the same arbitrary parametervia--build-option (--global-option is now reserved for flags like--verbose or--quiet).

Both--build-option and--global-option are supported as atransitional effort (a.k.a. “escape hatch”).In the future a proper list of allowedconfig_settings may be created.

#3265: Added implementation foreditable install hooks (PEP 660).

By default the users will experience alenient behavior which prioritisesthe ability of the users of changing the distributed packages (e.g. adding newfiles or removing old ones).But they can also opt into astrict mode, which will try to replicate as muchas possible the behavior of the package as if it would be normally installed byend users. Thestrict editable installation is not able to detect if filesare added or removed from the project (a new installation is required).

This implementation might also affect plugins and customizations that assumecertainbuild subcommands don’t run during editable installs or that theyalways copy files to the temporary build directory.

#3380: Improved the handling of theconfig_settings parameter in bothPEP 517 andPEP 660 interfaces:

• It is possible now to pass both--global-option and--build-option.As discussed in#1928, arbitrary arguments passed via--global-optionshould be placed before the name of the setuptools’ internal command, while--build-option should come after.

• Users can passeditable-mode=strict to select a strict behaviour for theeditable installation.

#3392: Exposedget_output_mapping() frombuild_py andbuild_extsubcommands. This interface is reserved for the use ofsetuptoolsExtensions and third part packages are explicitly disallowed to calling it.However, any implementation overwritingbuild_py orbuild_ext arerequired to honour this interface.

#3412: Added ability of collecting source files from custom build sub-commands tosdist. This allows plugins and customization scripts to automaticallyadd required source files in the source distribution.

#3414: Users cantemporarily specify an environment variableSETUPTOOLS_ENABLE_FEATURES=legacy-editable as a escape hatch for thePEP 660 behavior. This setting istransitional and may be removed in thefuture.

#3484: Addedtransientcompat mode to editable installs.This more will be temporarily available (to facilitate the transition period)for those that want to emulate the behavior of thedevelop command(in terms of what is added tosys.path).This mode is provided “as is”, with limited support, and will be removed infuture versions ofsetuptools.

#3414: UpdatedDevelopment Mode to reflect on theimplementation ofPEP 660.

#3496: Update topypa/distutils@b65aa40 including more robust support for library/include dir handling in msvccompiler (pypa/distutils#153) and test suite improvements.

#3453: Bump vendored version ofpyparsing to 3.0.9.

#3481: Add warning for potentialinstall_requires andextras_requiremisconfiguration insetup.cfg

#3487: Modifiedpyproject.toml validation exception handling tomake relevant debugging information easier to spot.

#3482: Sync withpypa/distutils@274758f1c02048d295efdbc13d2f88d9923547f8, restoring compatibility shim in bdist.format_commands.

#2971:upload_docs command is deprecated once again.

#3443: Installedsphinx-hoverxref extension to show tooltips on internal an external references.– by@humitos

#3444: Installedsphinx-notfound-page extension to generate nice 404 pages.– by@humitos

#3480: Merge withpypa/distutils@c397f4c

#3475: Merge withpypa/distutils@129480b, including substantial delinting and cleanup, some refactoring around compiler logic, better messaging in cygwincompiler (pypa/distutils#161).

#3395: Included a performance optimization:setuptools.build_meta no longer triestocompile() the setup script code beforeexec()-ing it.

#3435: Corrected issue in macOS framework builds on Python 3.9 not installed by homebrew (pypa/distutils#158).

#3430: Merge withpypa/distutils@152c13d includingpypa/distutils#155 (improved compatibility for editable installs on homebrew Python 3.9),pypa/distutils#150 (better handling of runtime_library_dirs on cygwin), andpypa/distutils#151 (remove warnings for namespace packages).

#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 thefile_finders hook so thatthe logging recommendation aligns with the suggestion to not usedistutils directly.

#3397: Fix reference forkeywords to point to the Core Metadata Specificationinstead ofPEP 314 (the live standard is kept always up-to-date andconsolidates several PEPs together in a single document).

#3402: Reordered the User Guide’s Table of Contents – by@codeandfire

#3253: Enabled usingfile: for requirements in setup.cfg – by@akx(this feature is currently considered to be inbeta stage).

#3255: Enabled usingfile: for dependencies and optional-dependencies in pyproject.toml – by@akx(this feature is currently considered to be inbeta stage).

#3391: Updatedattr: to also extract simple constants with type annotations – by@karlotness

#3347: Changed warnings and documentation notes aboutexperimental aspect ofpyproject.toml configuration:now[project] is a fully supported configuration interface, but the[tool.setuptools] tableand sub-tables are still considered to be inbeta 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 runningpythonsetup.py directly isconsidered a deprecated practice.

#3372: Consolidated sections aboutsdist contents andMANIFEST.in into a single page.

Added a simpleMANIFEST.in example.

#3373: Moved remarks about usingCython to the newly created page forextension modules.

#3374: Added clarification that usingpythonsetup.pyegg_info commands tomanage project versions is only supported in atransitional basis, andthat eventuallyegg_info will be deprecated.

Reorganized sections with tips for managing versions.

#3378: UpdatedQuickstart docs to make it easier to follow for beginners.

#3385: Modules used to parse and evaluate configuration frompyproject.toml files areintended for internal use only and that not part of the public API.

#3256: Added setuptools.command.build command to match distutils.command.build – by@isuruf

#3366: Merge withpypa/distutils@75ed79d including reformat using black, fix for Cygwin support (pypa/distutils#139), and improved support for cross compiling (pypa/distutils#144 andpypa/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-emphasizedistutils and the historyof packaging in the Python ecosystem. The focus of these changes is to make thedocumentation easier to read for new users.

#3364: Update documentation about dependency management, removing mention tothe deprecateddependency_links and adding some small improvements.

#3367: Extracted text about automatic resource extraction and the zip-safe flagfromuserguide/miscellaneous todeprecated/resource_extraction anddeprecated/zip_safe.

Extracted text about additional metadata files fromuserguide/miscellaneous into the existinguserguide/extensiondocument.

Updateduserguide/extension to better reflect the status of thesetuptools project.

Removeduserguide/functionalities_rewrite (a virtually empty part of thedocs).

#3349: Fixed two small issues preventing docs from building locally – by@codeandfire

#3350: Added note explainingpackage_data glob pattern matching for dotfiles – by@comabrewer

#3358: Clarify the role of thepackage_dir configuration.

#3354: Improve clarity in warning about unlisted namespace packages.

#3331: Replaced single backticks with double ones inCHANGES.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: Modifiedtest_setup_install_includes_dependencies to work with customPYTHONPATH –- by@hroncok

#3328: Include a first line summary to some of the existing multi-line warnings.

#3320: Fixed typo which causesnamespace_packages to raise an error instead ofwarning.

#3262: Formally added deprecation messages fornamespace_packages.The methodology that usespkg_resources andnamespace_packages forcreating namespaces was already discouraged by thesetuptools docs and thePython Packaging User Guide,therefore this change just make the deprecation more official.Users can consider migrating to native/implicit namespaces (as introduced inPEP 420).

#3308: Relying oninclude_package_data to ensure sub-packages are automaticallyadded to the build wheel distribution (as “data”) is now considered adeprecated practice.

This behaviour was controversial and caused inconsistencies (#3260).

Instead, projects are encouraged to properly configurepackages or usediscovery tools. General information can be found inPackage Discovery and Namespace Packages.

#1806: Allowed recursive globs (**) inpackage_data. – by@nullableVoidPtr

#3206: Fixed behaviour when bothinstall_requires (insetup.py) anddependencies (inpyproject.toml) are specified.The configuration inpyproject.toml will take precedence oversetup.py(in accordance withPEP 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 vendoredpyparsing to 3.0.8 to avoid problems withupcoming deprecation in Python 3.11.

#3292: Added warning about incompatibility with old versions ofimportlib-metadata.

#3299: Optional metadata fields are now truly optional. Includes merge withpypa/distutils@a7cfb56 perpypa/distutils#138.

#3282: Added CI cache forsetup.cfg examples used when testingsetuptools.config.

#3258: Mergepypa/distutils@5229dad46b.

#3249: Simplifiedpackage_dir obtained via auto-discovery.

#3151: Madesetup.pydevelop--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 viainstall_as_egg – by@delijati

#3088: Fixed duplicated tag with thedist-info command.

#3247: Fixed problem preventingreadme specified as dynamic inpyproject.tomlfrom being dynamically specified insetup.py.

#3233: Included missing test filesetupcfg_examples.txt insdist.

#3233: Added script that allows developers to downloadsetupcfg_examples.txt prior torunning tests. By caching these files it should be possible to run the test suiteoffline.

#3229: Disabled automatic download oftrove-classifiers to facilitate reproducibility.

#3229: Updatedpyproject.toml validation viavalidate-pyproject v0.7.1.

#3229: New internal tool made available for updating the code responsible forthe validation ofpyproject.toml.This tool can be executed viatox-egenerate-validation-code.

#3215: Ignored a subgroup of invalidpyproject.toml files that use the[project]table to specify onlyrequires-python (transitional).

#3215: Updatedpyproject.toml validation, as generated byvalidate-pyproject==0.6.1.

#3218: Prevented builds from erroring if the project specifies metadata viapyproject.toml, but uses other files (e.g.setup.py) to complement it,without settingdynamic properly.

#3224: Merge changes frompypa/distutils@e1d5c9b1f6

#3217: Fixed typo inpyproject.toml example in Quickstart – by@pablo-cardenas.

#3223: Fixed missing requirements with environment markers whenoptional-dependencies is set inpyproject.toml.

#3212: Fixed missing dependencies when runningsetup.pyinstall.Note that callingsetup.pyinstall directly is still deprecated andwill be removed in future versions ofsetuptools.Please check the release notes forv58.3.0.

#3206: Changedsetuptools.convert_path to an internal function that is not exposedas part of setuptools API.Future releases ofsetuptools are likely to remove this function.

#3202: Changed behaviour of auto-discovery to not explicitly expandpackage_dirfor flat-layouts and to not use relative paths starting with./.

#3203: Preventedpyproject.toml parsing from overwritingdist.include_package_data explicitly set insetup.py with defaultvalue.

#3208: Added a warning for non existing files listed with thefile directive insetup.cfg andpyproject.toml.

#3208: Added a default value for dynamicclassifiers inpyproject.toml whenfiles are missing and errors being ignored.

#3211: Disabled auto-discovery when distribution class has aconfigurationattribute (e.g. when thesetup.py script containssetup(...,configuration=...)). This is done to ensure extension-only packages createdwithnumpy.distutils.misc_util.Configuration are not broken by the safeguardbehaviour to avoid accidental multiple top-level packages in a flat-layout.

#3068: Deprecatedsetuptools.config.read_configuration,setuptools.config.parse_configuration and other functions or classesfromsetuptools.config.

Users that still need to parse and process configuration fromsetup.cfg canimport a direct replacement fromsetuptools.config.setupcfg, however thismodule is transitional and might be removed in the future(thesetup.cfg configuration format itself is likely to be deprecated in the future).

#2894: If you purposefully want to create an“empty distribution”, please be awarethat some Python files (or general folders) might be automatically detected andincluded.

Projects that currently don’t specify bothpackages andpy_modules in theirconfiguration and contain extra folders or Python files (not meant for distribution),might see these files being included in the wheel archive or even experiencethe build to fail.

You can check details about the automatic discovery (and how to configure adifferent behaviour) inPackage Discovery and Namespace Packages.

#3067: If the filepyproject.toml exists and it includes projectmetadata/config (via[project] table or[tool.setuptools]),a series of new behaviors that are not backward compatible may take place:

• The default value ofinclude_package_data will be considered to beTrue.

• Setuptools will attempt to validate thepyproject.toml file accordingtoPEP 621 specification.

• The values specified inpyproject.toml will take precedence over thosespecified insetup.cfg orsetup.py.

#2887:[EXPERIMENTAL] Added automatic discovery forpy_modules andpackages– by@abravalheri.

Setuptools will try to find these values assuming that the package uses eitherthesrc-layout (asrc directory containing all the packages or modules),theflat-layout (package directories directly under the project root),or thesingle-module approach (an isolated Python file, directly underthe project root).

The automatic discovery will also respect layouts that are explicitlyconfigured using thepackage_dir option.

For backward-compatibility, this behavior will be observedonly if bothpy_modulesandpackagesare not set.(Note: specifyingext_modules might also prevent auto-discover fromtaking place)

If setuptools detects modules or packages that are not supposed to be in thedistribution, please manually setpy_modules andpackages in yoursetup.cfg orsetup.py file.If you are using aflat-layout, you can also consider switching tosrc-layout.

#2887:[EXPERIMENTAL] Added automatic configuration for thename metadata– by@abravalheri.

Setuptools will adopt the name of the top-level package (or module in the caseof single-module distributions),only whennameis not explicitlyprovided.

Please note that it is not possible to automatically derive a single name whenthe distribution consists of multiple top-level packages or modules.

#3066: Added vendored dependencies fortomli,validate-pyproject.

These dependencies are used to readpyproject.toml files and validate them.

#3067:[EXPERIMENTAL] When usingpyproject.toml metadata,the default value ofinclude_package_data is changed toTrue.

#3068:[EXPERIMENTAL] Add support forpyproject.toml configuration(as introduced byPEP 621). Configuration parameters not covered bystandards are handled in the[tool.setuptools] sub-table.

In the future, existingsetup.cfg configurationmay be automatically converted into thepyproject.toml equivalent before taking effect(as proposed in#1688). Meanwhile users can use automated tools likeini2toml to help in the transition.

Please note that the legacy backend is not guaranteed to work withpyproject.toml configuration.

– by@abravalheri

#3125: Implicit namespaces (as introduced inPEP 420) are now considered by defaultduringpackage discovery, whensetuptools configuration and project metadata are added to thepyproject.toml file.

To disable this behaviour, usenamespaces=False when explicitly settingthe[tool.setuptools.packages.find] section inpyproject.toml.

This change is backwards compatible and does not affect the behaviour ofconfiguration done insetup.cfg orsetup.py.

#3152:[EXPERIMENTAL] Added support forattr: andcmdclass configurationsinsetup.cfg andpyproject.toml whenpackage_dir is implicitlyfound via auto-discovery.

#3178: Postponed importingctypes when hiding files on Windows.This helps to prevent errors in systems that might not havelibffi installed.

#3179: Merge withpypa/distutils@267dbd25ac

#3172: Added initial documentation about configuringsetuptools viapyproject.toml(using standard project metadata).

#3065: Refactoredsetuptools.config by separating configuration parsing (specificto the configuration file format, e.g.setup.cfg) and post-processing(which includes directives such asfile: that can be used across differentconfiguration formats).

#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 aboutMANIFEST.in, that include links to PyPUG docsand more prominent mentions to using a revision control system plugin as analternative.

#3148: Removed mention topkg_resources as the recommended way of accessing datafiles, in favour of importlib.resources.Additionally more emphasis was put on the fact thatpackage data files resideinside thepackage directory (and therefore should beread-only).

#3120: Added workaround for intermittent failures of backend tests on PyPy.These tests now are marked withXFAIL, instead of erroringout directly.

#3124: Improved configuration forrst-linker (extension used to build thechangelog).

#3133: Enhanced isolation of tests using virtual environments - PYTHONPATH is not leaking to spawned subprocesses – by@befeleme

#3147: Added options to provide a pre-builtsetuptools wheel or sdist for beingused during tests with virtual environments.Paths for these pre-built distribution files can now be set via the environmentvariables:PRE_BUILT_SETUPTOOLS_SDIST andPRE_BUILT_SETUPTOOLS_WHEEL.

#3093: Repaired automated release process.

#3035: When loading distutils from the vendored copy, rewrite__name__ to ensure consistent importing from inside and out.

#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.

#2876: In the build backend, allow single config settings to be supplied.

#2993: Removed workaround in distutils hack for get-pip now thatpypa/get-pip#137 is closed.

#3085: Setuptools no longer relies onpkg_resources for entry point handling.

#3098: Bump vendored packaging to 21.3.

Removed bootstrap script.

#3091: Makeconcurrent.futures import lazy in vendoredmore_itertoolspackage to a avoid importing threading as a side effect (which causedgevent/gevent#1865).– by@maciejp-ro

#3084: When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer.

#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.

#3072: Remove lorem_ipsum from jaraco.text when vendored.

#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.

#3043: Merge withpypa/distutils@bb018f1ac3 including consolidated behavior in sysconfig.get_platform (pypa/distutils#104).

#3057: Don’t include optionalHome-page in metadata if nourl is specified. – by@cdce8p

#3062: Merge withpypa/distutils@b53a824ec3 including improved support for lib directories on non-x64 Windows builds.

#2897: Added documentation about wrappingsetuptools.build_meta in a in-treecustom backend. This is aPEP 517-compliant way of dynamically specifyingbuild 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 pointersto GitHub Discussions.– by@ashemedai

#3056: The documentation has stopped suggesting to addwheel toPEP 517 requirements – by@webknjaz

#3054: Used Py3 syntaxsuper().__init__() – by@imba-tjd

#3009: Remove filtering of distutils warnings.

#3031: Suppress distutils replacement when building or testing CPython.

#3026: Honor sysconfig variables in easy_install.

#2993: In _distutils_hack, for get-pip, simulate existence of setuptools.

#2918: Correct support for Python 3 native loaders.

#2990: Set the.origin attribute of thedistutils module to the module’s__file__.

#2839: Removedrequires 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 ofcostly 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 withsphinx-favicon.

#3008: SVG images (logo, banners, …) optimised with the help of thescourpackage.

#2862: Added integration tests that focus on building and installing some packages inthe Python ecosystem viapip – by@abravalheri

#2952: Modified “vendoring” logic to keep license files.

#2968: Improved isolation for some tests that where inadvertently using the projectroot 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 fixturesvenv,venv_without_setuptools,bare_venv that rely on thejaraco.envs package.These new test fixtures were also used to remove the (currently problematic)dependency on thepytest_virtualenv plugin.

#2968: Removedtmp_src test fixture. Previously this fixture was copying all thefiles and folders under the project root, including the.git directory,which is error prone and increases testing time.

Sincetmp_src was used to populate virtual environments (installing theversion ofsetuptools under test via the source tree), it was replaced bythe newsetuptools_sdist andsetuptools_wheel fixtures (that are buildonly once per session testing and can be shared between all the workers forread-only usage).

#3002: Suppress AttributeError when detecting get-pip.

#2993: In _distutils_hack, bypass the distutils exception for pip when get-pip is being invoked, because it imports setuptools.

#2989: Merge withpypa/distutils@788cc159. Includes fix for config vars missing from sysconfig.

#2974: Setuptools now relies on the Python logging infrastructure to log messages. Instead of usingdistutils.log.*, uselogging.getLogger(name).*.

#2987: Sync withpypa/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.

#2980: Bypass distutils loader when setuptools module is no longer available on sys.path.

#2958: In distutils_hack, only add the metadata finder once. In ensure_local_distutils, rely on a context manager for reliable manipulation.

#2963: Merge withpypa/distutils@a5af364910. Includes revisited fix forpypa/distutils#15 and improved MinGW/Cygwin support frompypa/distutils#77.

#2960: Install schemes fall back to default scheme for headers.

#2954: Merge withpypa/distutils@eba2bcd310. Adds platsubdir to config vars available for substitution.

#2940: Avoid KeyError in distutils hack when pip is imported during ensurepip.

#2938: Select ‘posix_user’ for the scheme unless falling back to stdlib, then use ‘unix_user’.

#2944: Add support for extended install schemes in easy_install.

#2896: Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUTILS=stdlib.

#2935: Mergepypa/distutils@460b59f0e68dba17e2465e8dd421bbc14b994d1f.

#2930: Require Python 3.7

#2925: Merge withpypa/distutils@92082ee42c including introduction of deprecation warning on Version classes.

#2914: Merge withpypa/distutils@8f2df0bf6.

#2893: Restore deprecated support for newlines in the Summary field.

#2902: Merge withpypa/distutils@85db7a41242.

#2906: In ensure_local_distutils, re-use DistutilsMetaFinder to load the module. Avoids race conditions when _distutils_system_mod is employed.

#2875: Introduce changes frompypa/distutils@514e9d0, including support for overrides from Debian and pkgsrc, unlocking the possibility of making SETUPTOOLS_USE_DISTUTILS=local the default again.

#2885: Fixed errors when encountering LegacyVersions.

#2497: Update packaging to 21.2.

#2877: Back out deprecation of setup_requires and replace instead by a deprecation of setuptools.installer and fetch_build_egg. Now setup_requires is still supported when installed as part of aPEP 517 build, but is deprecated when an unsatisfied requirement is encountered.

#2879: Bump packaging to 21.2.

#2867: PNG/ICO images replaced with SVG in the docs.

#2867: Added support to SVG “favicons” via “in-tree” Sphinx extension.

#2880: Removed URL requirement forpytest-virtualenv insetup.cfg.PyPI rejects packages with dependencies external to itself.Instead the test dependency was overwritten viatox.ini

#2856: Support for custom commands that inherit directly fromdistutils isdeprecated. Users should extend classes provided by setuptools instead.

#2870: Started failing on invalid inline description with line breaksValueError – by@webknjaz

#2698: Exposed exception classes fromdistutils.errors viasetuptools.errors.

#2866: Incorporate changes frompypa/distutils@f1b0a2b.

#2227: Added sphinx theme customisations to display the new logo in the sidebar anduse its colours as “accent” in the documentation – by@abravalheri

#2227: Added new setuptools logo, including editable files and artwork documentation– by@abravalheri

#2698: Added mentions tosetuptools.errors as a way of handling custom commanderrors.

#2698: Added instructions to migrate fromdistutils.commands anddistutils.errors in the porting guide.

#2871: Added a note to the docs that it is possible to installsetup.py-less projects in editable mode withpip v21.1+, only havingsetup.cfg andpyproject.toml inproject root – by@webknjaz

#2849: Add fallback for custombuild_py commands inheriting directly fromdistutils, while still handlinginclude_package_data=True forsdist.

#2847: Suppress ‘setup.py install’ warning under bdist_wheel.

#2846: Move PkgResourcesDeprecationWarning above implicitly-called function so that it’s in the namespace when version warnings are generated in an environment that contains them.

#1461: Fix inconsistency withinclude_package_data andpackages_data in sdistby replacing the loop breaking mechanism between thesdist andegg_info commands – by@abravalheri

#2497: Officially deprecatedPEP 440 non-compliant versions.

#2832: Removed the deprecateddata_files option from the example in thedeclarative configuration docs – by@abravalheri

#2832: Change type ofdata_files option fromdict tosection indeclarative configuration docs (to match previous example) – by@abravalheri

#917:setup.pyinstall andeasy_install commands are now officially deprecated. Use other standards-based installers (like pip) and builders (like build). Workloads reliant on this behavior should pin to this major version of Setuptools. SeeWhy you shouldn’t invoke setup.py directly for more background.

#1988: Deprecated thebdist_rpm command. Binary packages should be built as wheels instead.– by@hugovk

#2785: Replaceconfigparser’sreadfp withread_file, deprecated since Python 3.2.– by@hugovk

#2823: Officially deprecated support forsetup_requires. Users are encouraged instead to migrate toPEP 518build-system.requires inpyproject.toml. Users reliant onsetup_requires should consider pinning to this major version to avoid disruption.

#2762: Changed codecov.yml to configure the threshold to be lower– by@tanvimoharir

#2757: Add windows arm64 launchers for scripts generated by easy_install.

#2800: Added--owner and--group options to thesdist command,for specifying file ownership within the produced tarball (similarlyto the corresponding distutilssdist options).

#2792: Document how the legacy and non-legacy versions are compared, and reference to thePEP 440 scheme.

#2796: Merge withpypa/distutils@02e9f65ab0

#2773: Retain case in setup.cfg during sdist.

#2777: Build does not fail fast whenuse_2to3 is supplied but set to a false value.

#2769: Build now fails fast whenuse_2to3 is supplied.

#2765: In Distribution.finalize_options, suppress known removed entry points to avoid issues with older Setuptools.

#2086: Removed support for 2to3 during builds. Projects should port to a unified codebase or pin to an older version of Setuptools usingPEP 518 build-requires.

#2746: add python_requires example

#2712: Added implicit globbing support for[options.data_files] values.

#2737: fix various syntax and style errors in code snippets in docs

#2722: Added support forSETUPTOOLS_EXT_SUFFIX environment variable to override the suffix normally detected from thesysconfig module.

#2465: Documentation is now published using the Furo theme.

#2724: Added detection of Windows ARM64 build environments using theVSCMD_ARG_TGT_ARCH environment variable.

#2692: Globs are now sorted in ‘license_files’ restoring reproducibility by eliminating variance from disk order.

#2714: Update to distutils atpypa/distutils@e2627b7.

#2715: Removed reliance on deprecated ssl.match_hostname by removing the ssl support. Now any index operations rely on the native SSL implementation.

#2604: Revamped the backward/cross tool compatibility section to removesome confusion.Add some examples and the version since whenentry_points aresupported in declarative configuration.Tried to make the reading flow a bit leaner, gather some informationthat were a bit dispersed.

#2645: License files excluded via theMANIFEST.in but matched by eitherthelicense_file (deprecated) orlicense_files options,will be nevertheless included in the source distribution. - by@cdce8p

#2628: Write long description in message payload of PKG-INFO file. - by@cdce8p

#2645: AddedLicense-File (multiple) to the output package metadata.The field will contain the path of a license file, matched by thelicense_file (deprecated) andlicense_files options,relative to.dist-info. - by@cdce8p

#2678: Moved Setuptools’ own entry points into declarative config.

#2680: Vendoredmore_itertools for Setuptools.

#2681: Setuptools own setup.py no longer declares setup_requires, but instead expects wheel to be installed as declared by pyproject.toml.

#2650: Updated the docs build tooling to support the latest version ofTowncrier and show the previews of not-yet-released setuptools versionsin the changelog –@webknjaz

#2640: Fixed handling of multiline license strings. - by@cdce8p

#2641: Setuptools will now always try to use the latest supportedmetadata version forPKG-INFO. - by@cdce8p

#2653: Incorporated assorted changes from pypa/distutils.

#2657: Adopted docs from distutils.

#2663: Added Visual Studio Express 2017 support – by@dofuuz

#2644: FixedDeprecationWarning due tothreading.Thread.setDaemon in tests – by@tirkarthi

#2654: Made the changelog generator compatiblewith Towncrier >= 19.9 –@webknjaz

#2664: Relax the deprecation message in the distutils hack.

#2620: Thelicense_file option is now marked as deprecated.Uselicense_files instead. – by@cdce8p

#2620: If neitherlicense_file norlicense_files is specified, thesdistoption will now auto-include files that match the following patterns:LICEN[CS]E*,COPYING*,NOTICE*,AUTHORS*.This matches the behavior ofbdist_wheel. – by@cdce8p

#2620: Thelicense_file andlicense_files options now support glob patterns. – by@cdce8p

#2632: ImplementedVendorImporter.find_spec() method to get ridofImportWarning that Python 3.10 emits when only the old-styleimporter hooks are present – by@webknjaz

#2620: Added documentation for thelicense_files option. – by@cdce8p

#2566: Remove the deprecatedbdist_wininst command. Binary packages should be built as wheels instead. – by@hroncok

#2608: Added informative error message toPEP 517 build failures owing toan emptysetup.py – by@layday

#2595: Reduced scope of dash deprecation warning to Setuptools/distutils only – by@melissa-kun-li

#2584: Addedsphinx-inline-tabs extension to allow for comparison ofsetup.py and its equivalentsetup.cfg – by@amy-lei

#2592: Made option keys in the[metadata] section ofsetup.cfg case-sensitive. Users havinguppercase option spellings will get a warning suggesting to make them to lowercase– by@melissa-kun-li

#1608: Removed the conversion of dashes to underscores in theextras_require anddata_files ofsetup.cfg to support the usage of dashes. Method will warn users when they use a dash-separated key which in the future will only allow an underscore. Note: the method performs the dash to underscore conversion to preserve compatibility, but future versions will no longer support it – by@melissa-kun-li

#2582: Simplified build-from-source story by providing bootstrapping metadata in a separate egg-info directory. Build requirements no longer include setuptools itself. Sdist once again includes the pyproject.toml. Project can no longer be installed from source on pip 19.x, but install from source is still supported on pip < 19 and pip >= 20 and install from wheel is still supported with pip >= 9.

#1932: HandledAttributeError by raisingDistutilsSetupError indist.check_specifier() when specifier is not a string – by@melissa-kun-li

#2570: Correctly parse cmdclass in setup.cfg.

#2553: Added userguide example for markers in extras_require – by@pwoolvett

#1937: Preserved case-sensitivity of keys in setup.cfg so that entry point names are case-sensitive. Changed sensitivity of configparser. NOTE: Any projects relying on case-insensitivity will need to adapt to accept the original case as published. – by@melissa-kun-li

#2573: Fixed error in uploading a Sphinx doc with theupload_docs command. An html builder will be used.Note:upload_docs is deprecated for PyPi, but is supported for other sites – by@melissa-kun-li

#1527: Removed bootstrap script. Now Setuptools requires pip or another pep517-compliant builder such as ‘build’ to build. Now Setuptools can be installed from Github main branch.

#2537: Remove fallback support for fetch_build_eggs using easy_install. Now pip is required for setup_requires to succeed.

#2544: Removed ‘easy_install’ top-level model (runpy entry point) and ‘easy_install’ console script.

#2545: Removed support for eggsecutables.

#2459: Tests now run in parallel via pytest-xdist, completing in about half the time. Special thanks to@webknjaz for hard work implementing test isolation. To run without parallelization, disable the plugin withtox---pno:xdist.

#2539: Fix AttributeError in Description validation.

#1390: Validation of Description field now is more lenient, emitting a warning and mangling the value to be valid (replacing newlines with spaces).

#2536: Reverted tag deduplication handling.

#1390: Newlines in metadata description/Summary now trigger a ValueError.

#2481: Definecreate_module() andexec_module() methods inVendorImporterto get rid ofImportWarning – by@hroncok

#2489:pkg_resources behavior for zipimport now matches the regular behavior, and finds.egg-info (previously would only find.dist-info) – by@thatch

#2529: Fixed an issue where version tags may be added multiple times

#2493: Use importlib.import_module() rather than the deprecated loader.load_module()in pkg_resources namespace declaration – by@encukou

#2525: Fix typo in the document page about entry point. – by@jtr109

#2534: Avoid hitting network during test_easy_install.

#2505: Disable inclusion of package data as it causes ‘tests’ to be included as data.

#2534: Avoid hitting network during test_virtualenv.test_test_command.

#2486: Project adopts jaraco/skeleton for shared package maintenance.

#2477: Restore inclusion of rst files in sdist.

#2484: Setuptools has replaced the master branch with the main branch.

#2485: Fixed failing test when pip 20.3+ is present.– by@yan12125

#2487: Fix tests with pytest 6.2– by@yan12125

#2435: Require Python 3.6 or later.

#2430: Fixed inconsistent RST title nesting levels caused by#2399– by@webknjaz

#2430: Fixed a typo in Sphinx docs that made docs dev section disappearas a result ofPR #2426 – by@webknjaz

#2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils.

#2394: Extended towncrier news template to include change note categories.This allows to see what types of changes a given version introduces– by@webknjaz

#2427: Started enforcing strict syntax and reference validationin the Sphinx docs – by@webknjaz

#2428: Removed redundant SphinxMakefile support – by@webknjaz

#2401: Enabled test results reporting in AppVeyor CI– by@webknjaz

#2420: Replace Python 3.9.0 beta with 3.9.0 final on GitHub Actions.

#2421: Python 3.9 Trove classifier got added to the dist metadata– by@webknjaz

#2093: Finalized doc revamp.

#2097: doc: simplify index and group deprecated files

#2102: doc overhaul step 2: break main doc into multiple sections

#2111: doc overhaul step 3: update userguide

#2395: Added a:user: role to Sphinx config – by@webknjaz

#2395: Added an illustrative explanation about the change notes to fragments dir – by@webknjaz

#2379: Travis CI test suite now tests against PPC64.

#2413: Suppress EOF errors (and other exceptions) when importing lib2to3.

#2368: In distutils, restore support for monkeypatched CCompiler.spawn perpypa/distutils#15.

#2355: When pip is imported as part of a build, leave distutils patched.

#2380: There are some setuptools specific changes in thesetuptools.command.bdist_rpm module that are no longer needed, becausethey are part of thebdist_rpm module in distutils in Python3.5.0. Therefore, code was removed fromsetuptools.command.bdist_rpm.

#2350: Setuptools reverts using the included distutils by default. Platform maintainers and system integrators and others arestrongly encouraged to setSETUPTOOLS_USE_DISTUTILS=local to help identify and work through the reported issues with distutils adoption, mainly to file issues and pull requests with pypa/distutils such that distutils performs as needed across every supported environment.

#2363: Restore link_libpython support on Python 3.7 and earlier (seepypa/distutils#9).

#2352: In distutils hack, use absolute import rather than relative to avoidbpo-30876.

#2357: Restored Python 3.5 support in distutils.util for missingsubprocess._optim_args_from_interpreter_flags.

#2358: Restored AIX support on Python 3.8 and earlier.

#2361: Add Python 3.10 support to _distutils_hack. Get the ‘Loader’ abstract classfrom importlib.abc rather than importlib.util.abc (alias removed in Python3.10).

#2232: Once again, Setuptools overrides the stdlib distutils on import. For environments or invocations where this behavior is undesirable, users are provided with a temporary escape hatch. If the environment variableSETUPTOOLS_USE_DISTUTILS is set tostdlib, Setuptools will fall back to the legacy behavior. Use of this escape hatch is discouraged, but it is provided to ease the transition while proper fixes for edge cases can be addressed.

#2334: In MSVC module, refine text in error message.

#2129: In pkg_resources, no longer detect any pathname ending in .egg as a Python egg. Now the path must be an unpacked egg or a zip file.

#2306: When running as aPEP 517 backend, setuptools does not try to installsetup_requires itself. They are reported as build requirements for thefrontend to install.

#2310: Updated vendored packaging version to 20.4.

#2300: Improve thesafe_version function documentation

#2297: Once again, in stubs prefer exec_module to the deprecated load_module.

#2316: Removed warning whendistutils is imported beforesetuptools whendistutils replacement is not enabled.

#2259: Setuptools now provides a .pth file (except for editable installs of setuptools) to the target environment to ensure that when enabled, the setuptools-provided distutils is preferred before setuptools has been imported (and even if setuptools is never imported). Honors the SETUPTOOLS_USE_DISTUTILS environment variable.

#2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn.

#2230: Now warn the user when setuptools is imported after distutils modules have been loaded (exempting PyPy for 3.6), directing the users of packages to import setuptools first.

#2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state.

#2249: Fix extension loading technique in stubs.

#2232: In preparation for re-enabling a local copy of distutils, Setuptools now honors an environment variable, SETUPTOOLS_USE_DISTUTILS. If set to ‘stdlib’ (current default), distutils will be used from the standard library. If set to ‘local’ (default in a imminent backward-incompatible release), the local copy of distutils will be used.

#2094: Removed pkg_resources.py2_warn module, which is no longer reachable.

#2228: Applied fix forpypa/distutils#3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file.

#2228: Disabled distutils adoption for now while emergent issues are addressed.

#2165: Setuptools no longer installs a site.py file during easy_install or develop installs. As a result, .eggs on PYTHONPATH will no longer take precedence over other packages on sys.path. If this issue affects your production environment, please reach out to the maintainers at#2165.

#2137: Removed (private) pkg_resources.RequirementParseError, now replaced by packaging.requirements.InvalidRequirement. Kept the name for compatibility, but users should catch InvalidRequirement instead.

#2180: Update vendored packaging in pkg_resources to 19.2.

#2199: Fix exception causes all over the codebase by usingraisenew_exceptionfromold_exception

#2143: Setuptools adopts distutils from the Python 3.9 standard library and no longer depends on distutils in the standard library. When importingsetuptools orsetuptools.distutils_patch, Setuptools will expose its bundled version as a top-leveldistutils package (and unload any previously-imported top-level distutils package), retaining the expectation thatdistutils’ objects are actually Setuptools objects.To avoid getting any legacy behavior from the standard library, projects are advised to always “import setuptools” prior to importing anything from distutils. This behavior happens by default when usingpipinstall orpep517.build. Workflows that rely onsetup.py(anything) will need to first ensure setuptools is imported. One way to achieve this behavior without modifying code is to invoke Python thus:python-c"importsetuptools;exec(open('setup.py').read())"(anything).

#2071: Replaced references to the deprecated imp package with references to importlib

#1973: Removedpkg_resources.py31compat.makedirs in favor of the stdlib. Useos.makedirs() instead.

#2198: Restore__requires__ directive in easy-install wrapper scripts.

#2197: Console script wrapper for editable installs now has a unified template and honors importlib_metadata if present for faster script execution on older Pythons.

#2195: Fix broken entry points generated by easy-install (pip editable installs).

#2194: Editable-installed entry points now load significantly faster on Python versions 3.8+.

#1471: Incidentally fixed by#2194 on Python 3.8 or when importlib_metadata is present.

#2156: Update mailing list pointer in developer docs

#2158: Avoid loading working set duringDistribution.finalize_options prior to invoking_install_setup_requires, broken since v42.0.0.

#2158: Avoid loading working set duringDistribution.finalize_options prior to invoking_install_setup_requires, broken since v42.0.0.

#2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages.

#2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should usesetuptools<45.

#1700: Document all supported keywords by migrating the ones from distutils.

#1753:attr: now extracts variables through rudimentary examination of the AST,thereby supporting modules with third-party imports. If examining the ASTfails to find the variable,attr: falls back to the old behavior ofimporting the module. Works on Python 3 only.

#2089: Package index functionality no longer attempts to remove an md5 fragment from the index URL. This functionality, added for distribute#163 is no longer relevant.

#2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards.

#2105: Filter2to3 deprecation warnings fromTestDevelop.test_2to3_user_mode.

#2040: Deprecated thebdist_wininst command. Binary packages should be built as wheels instead.

#2062: Change ‘Mac OS X’ to ‘macOS’ in code.

#2075: Stop recognizing files ending with.dist-info as distribution metadata.

#2086: Deprecate ‘use_2to3’ functionality. Packagers are encouraged to use single-source solutions or build tool chains to manage conversions outside of setuptools.

#1698: Added documentation forbuild_meta (a bare minimum, not completed).

#2082: Filterlib2to3PendingDeprecationWarning andDeprecationWarning in tests,becauselib2to3 isdeprecated in Python 3.9.

#1458: Added template for reporting Python 2 incompatibilities.

#308: Allow version number normalization to be bypassed by wrapping in a ‘setuptools.sic()’ call.

#1424: Prevent keeping files mode for package_data build. It may break a build if user’s package data has read only flag.

#1431: Ineasy_install.check_site_dir, ensure the installation directory exists.

#1563: Inpkg_resources preferfind_spec (PEP 451) tofind_module.

#1704: Set sys.argv[0] in setup script run by build_meta.__legacy__

#1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2

#1994: Fixed a bug in the “setuptools.finalize_distribution_options” hook that lead to ignoring the order attribute of entry points managed by this hook.

#1704: Set sys.argv[0] in setup script run by build_meta.__legacy__

#1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2

#1994: Fixed a bug in the “setuptools.finalize_distribution_options” hook that lead to ignoring the order attribute of entry points managed by this hook.

#65: Once again as in 3.0, removed the Features feature.

#1890: Fix vendored dependencies so importingsetuptools.extern.some_module gives the same object assetuptools._vendor.some_module. This makes Metadata picklable again.

#1899: Test suite now fails on warnings.

#2011: Fix broken link to distutils docs on package_data

#1991: Include pkg_resources test data in sdist, so tests can be executed from it.

#1557: Deprecated eggsecutable scripts and updated docs.

#1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+

#1905: Fixed defect in _imp, introduced in 41.6.0 when the ‘tests’ directory is not present.

#1941: Improve editable installs withPEP 518 build isolation:

• The--user option is now always available. A warning is issued if the user site directory is not available.

• The error shown when the install directory is not inPYTHONPATH has been turned into a warning.

#1981: Setuptools now declares itstests anddocs dependencies in metadata (extras).

#1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9).

#1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info.

#1458: Add minimum sunset date and preamble to Python 2 warning.

#1704: Set sys.argv[0] in setup script run by build_meta.__legacy__

#1974: Add Python 3 Only Trove Classifier and remove universal wheel declaration for more complete transition from Python 2.

#1458: Drop support for Python 2. Setuptools now requires Python 3.5 or later. Install setuptools using pip >=9 or pin to Setuptools <45 to maintain 2.7 support.

#1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2

#1908: Drop support for Python 3.4.

#1634: Includepyproject.toml in source distribution by default. Projects relying on the previous behavior wherepyproject.toml was excluded by default should stop relying on that behavior or addexcludepyproject.toml to their MANIFEST.in file.

#1927: Setuptools once again declares ‘setuptools’ in thebuild-system.requires and addsPEP 517 build support by declaring itself as thebuild-backend. It additionally specifiesbuild-system.backend-path to rely on itself for those builders that support it.

#1921: Fix support for easy_install’sfind-links option insetup.cfg.

#1922: Build dependencies (setup_requires and tests_require) now install transitive dependencies indicated by extras.

#1918: Fix regression in handling wheels compatibility tags.

#1830,#1909: Mark the easy_install script and setuptools command as deprecated, and usepip when available to fetch/build wheels for missingsetup_requires/tests_require requirements, with the following differences in behavior:

• support forpython_requires

• better support for wheels (proper handling of priority with respect toPEP 425 tags)

• PEP 517/518 support

• eggs are not supported

• no support for theallow_hosts easy_install option (index_url/find_links are still honored)

• pip environment variables are honored (and take precedence over easy_install options)

#1898: Removed the “upload” and “register” commands in favor oftwine.

#1767: Add support for thelicense_files option insetup.cfg to automaticallyinclude multiple license files in a source distribution.

#1829: Update handling of wheels compatibility tags:* add support for manylinux2010* fix use of removed ‘m’ ABI flag in Python 3.8 on Windows

#1861: Fix empty namespace package installation from wheel.

#1877: Setuptools now exposes a new entry point hook “setuptools.finalize_distribution_options”, enabling plugins likesetuptools_scm to configure options on the distribution at finalization time.

#479: Replace usage of deprecatedimp module with local re-implementation insetuptools._imp.

#1891: Fix code for detecting Visual Studio’s version on Windows under Python 2.

#1811: Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019.

#1814: Fixpkg_resources.Requirement hash/equality implementation: takePEP 508 direct URL into account.

#1824: Fix tests when running underpython3.10.

#1878: Formally deprecated thetest command, with the recommendation that users migrate totox.

#1860: Update documentation to mention the egg format is not supported by pip and dependency links support was dropped starting with pip 19.0.

#1862: Drop ez_setup documentation: deprecated for some time (last updated in 2016), and still relying on easy_install (deprecated too).

#1868: Drop most documentation references to (deprecated) EasyInstall.

#1884: Added a trove classifier to document support for Python 3.8.

#1886: Added Python 3.8 release to the Travis test matrix.

#1847: In declarative config, now traps errors when invalidpython_requires values are supplied.

#1690: When storing extras, rely on OrderedSet to retain order of extras as indicated by the packager, which will also be deterministic on Python 2.7 (with PYTHONHASHSEED unset) and Python 3.6+.

#1858: Fixed failing integration test triggered by ‘long_description_content_type’ in packaging.

#479: Remove some usage of the deprecatedimp module.

#1565: Changed html_sidebars from string to list of string as perhttps://www.sphinx-doc.org/en/master/changes.html#id58

#1697: Moved most of the constants from setup.py to setup.cfg

#1749: Fixed issue with thePEP 517 backend where building a source distribution would fail if any tarball existed in the destination directory.

#1750: Fixed an issue withPEP 517 backend where wheel builds would fail if the destination directory did not already exist.

#1756: Force metadata-version >= 1.2. when project urls are present.

#1769: Improvepackage_data check: ensure the dictionary values are lists/tuples of strings.

#1788: Changed compatibility fallback logic forhtml.unescape to avoid accessingHTMLParser.unescape when not necessary.HTMLParser.unescape is deprecated and will be removed in Python 3.9.

#1790: Added the file path to the error message when aUnicodeDecodeError occurs while reading a metadata file.

#1776: Use license classifiers rather than the license field.

#1671: Fixed issue with thePEP 517 backend that prevented building a wheel when thedist/ directory contained existing.whl files.

#1709: In test.paths_on_python_path, avoid adding unnecessary duplicates to the PYTHONPATH.

#1741: In package_index, now honor “current directory” during a checkout of git and hg repositories under Windows

#1735: When parsing setup.cfg files, setuptools now requires the files to be encoded as UTF-8. Any other encoding will lead to a UnicodeDecodeError. This change removes support for specifying an encoding using a ‘coding: ‘ directive in the header of the file, a feature that was introduces in 40.7. Given the recent release of the aforementioned feature, it is assumed that few if any projects are utilizing the feature to specify an encoding other than UTF-8.

#1675: Added support forsetup.cfg-only projects when using thesetuptools.build_meta backend. Projects that have enabledPEP 517 no longer need to have asetup.py and can use the purely declarativesetup.cfg configuration file instead.

#1720: Added support forpkg_resources.parse_requirements-style requirements insetup_requires whensetup.py is invoked from thesetuptools.build_meta build backend.

#1664: Added the path to thePKG-INFO orMETADATA file in the exceptiontext when theVersion: header can’t be found.

#1705: Removed some placeholder documentation sections referring to deprecated features.

#1652: Added thebuild_meta:__legacy__ backend, a “compatibility mode”PEP 517 backend that can be used as the default whenbuild-backend is left unspecified inpyproject.toml.

#1635: Resource paths are passed topkg_resources.resource_string and similar no longer accept paths that traverse parents, that begin with a leading/. Violations of this expectation raise DeprecationWarnings and will become errors. Additionally, any paths that are absolute on Windows are strictly disallowed and will raise ValueErrors.

#1536:setuptools will now automatically include licenses ifsetup.cfg contains alicense_file attribute, unless this file is manually excluded insideMANIFEST.in.

#1670: In package_index, revert to using a copy of splituser from Python 3.8. Attempts to useurllib.parse.urlparse led to problems as reported in#1663 and#1668. This change serves as an alternative to#1499 and fixes#1668.

#1666: Restore port in URL handling in package_index.

#1660: On Python 2, when reading config files, downcast options from text to bytes to satisfy distutils expectations.

#1551: File inputs for thelicense field insetup.cfg files now explicitly raise an error.

#1180: Add support for non-ASCII in setup.cfg (#1062). Add support for native strings on some parameters (#1136).

#1499:setuptools.package_index no longer relies on the deprecatedurllib.parse.splituser perPython #27485.

#1544: Added tests for PackageIndex.download (for git URLs).

#1625: InPEP 517 build_meta builder, ensure that sdists are built as gztar per the spec.

#1594:PEP 517 backend no longer declares setuptools as a dependency as it can be assumed.

#1592: Fix invalid dependency on external six module (instead of vendored version).

#1590: Fixed regression where packages withoutauthor orauthor_email fields generated malformed package metadata.

#1541: Officially deprecated therequires parameter insetup().

#1519: Inpkg_resources.normalize_path, additional path normalization is now performed to ensure path values to a directory is always the same, preventing false positives when checking scripts have a consistent prefix to set up on Windows.

#1545: Changed the warning class of all deprecation warnings; deprecation warning classes are no longer derived fromDeprecationWarning and are thus visible by default.

#1554:build_meta.build_sdist now includessetup.py in source distributions by default.

#1576: Started monkey-patchingget_metadata_version andread_pkg_file ontodistutils.DistributionMetadata to retain the correct version on thePKG-INFO file in the (deprecated)upload command.

#1395: Changed Pyrex references to Cython in the documentation.

#1456: Documented that therpmbuild packages is required for thebdist_rpm command.

#1537: Documented how to usesetup.cfg forsrc/layouts

#1539: Added minimum version column insetup.cfg metadata table.

#1552: Fixed a minor typo in the python 2/3 compatibility documentation.

#1553: Updated installation instructions to point topipinstall instead ofez_setup.py.

#1560: Updatedsetuptools distribution documentation to remove some outdated information.

#1564: Documentedsetup.cfg minimum version for version and project_urls.

#1533: Restricted therecursive-includesetuptools/_vendor to contain only .py and .txt files.

#1572: Added theconcurrent.futures backportfutures to the Python 2.7 test suite requirements.

#1335: Inpkg_resources.normalize_path, fix issue on Cygwin when cwd contains symlinks.

#1502: Deprecated support for downloads from Subversion in package_index/easy_install.

#1517: Dropped use of six.u in favor ofu"" literals.

#1520: Added support fordata_files insetup.cfg.

#1525: Fixed rendering of the deprecation warning in easy_install doc.

#1480: Bump vendored pyparsing in pkg_resources to 2.2.1.

#1497: Updated gitignore in repo.

#1480: Bump vendored pyparsing to 2.2.1.

#1481: Join the sdist--dist-dir and thebuild_meta sdist directory argument to point to the same target (meaning the build frontend no longer needs to clean manually the dist dir to avoid multiple sdist presence, and setuptools no longer needs to handle conflicts between the two).