This PR pins setuptools to the latest release 51.0.0.
Changelog
### 51.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 2435: Require Python 3.6 or later.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2430: Fixed inconsistent RST title nesting levels caused by 2399
-- by :user:`webknjaz`
* 2430: Fixed a typo in Sphinx docs that made docs dev section disappear
as a result of PR 2426 -- by :user:`webknjaz`
Misc
^^^^
* 2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils.
```
### 50.3.2
```
-------
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2394: Extended towncrier news template to include change note categories.
This allows to see what types of changes a given version introduces
-- by :user:`webknjaz`
* 2427: Started enforcing strict syntax and reference validation
in the Sphinx docs -- by :user:`webknjaz`
* 2428: Removed redundant Sphinx ``Makefile`` support -- by :user:`webknjaz`
Misc
^^^^
* 2401: Enabled test results reporting in AppVeyor CI
-- by :user:`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 :user:`webknjaz`
```
### 50.3.1
```
-------
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 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 :user:`webknjaz`
* 2395: Added an illustrative explanation about the change notes to fragments dir -- by :user:`webknjaz`
Misc
^^^^
* 2379: Travis CI test suite now tests against PPC64.
* 2413: Suppress EOF errors (and other exceptions) when importing lib2to3.
```
### 50.3.0
```
-------
Changes
^^^^^^^
* 2368: In distutils, restore support for monkeypatched CCompiler.spawn per pypa/distutils15.
```
### 50.2.0
```
-------
Changes
^^^^^^^
* 2355: When pip is imported as part of a build, leave distutils patched.
* 2380: There are some setuptools specific changes in the
``setuptools.command.bdist_rpm`` module that are no longer needed, because
they are part of the ``bdist_rpm`` module in distutils in Python
3.5.0. Therefore, code was removed from ``setuptools.command.bdist_rpm``.
```
### 50.1.0
```
-------
Changes
^^^^^^^
* 2350: Setuptools reverts using the included distutils by default. Platform maintainers and system integrators and others are *strongly* encouraged to set ``SETUPTOOLS_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.
```
### 50.0.3
```
-------
Misc
^^^^
* 2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils9).
```
### 50.0.2
```
-------
Misc
^^^^
* 2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876.
```
### 50.0.1
```
-------
Misc
^^^^
* 2357: Restored Python 3.5 support in distutils.util for missing ``subprocess._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 class
from importlib.abc rather than importlib.util.abc (alias removed in Python
3.10).
```
### 50.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 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 variable ``SETUPTOOLS_USE_DISTUTILS`` is set to ``stdlib``, 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.
Changes
^^^^^^^
* 2334: In MSVC module, refine text in error message.
```
### 49.6.0
```
-------
Changes
^^^^^^^
* 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.
```
### 49.5.0
```
-------
Changes
^^^^^^^
* 2306: When running as a PEP 517 backend, setuptools does not try to install
``setup_requires`` itself. They are reported as build requirements for the
frontend to install.
```
### 49.4.0
```
-------
Changes
^^^^^^^
* 2310: Updated vendored packaging version to 20.4.
```
### 49.3.2
```
-------
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2300: Improve the ``safe_version`` function documentation
Misc
^^^^
* 2297: Once again, in stubs prefer exec_module to the deprecated load_module.
```
### 49.3.1
```
-------
Changes
^^^^^^^
* 2316: Removed warning when ``distutils`` is imported before ``setuptools`` when ``distutils`` replacement is not enabled.
```
### 49.3.0
```
-------
Changes
^^^^^^^
* 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.
```
### 49.2.1
```
-------
Misc
^^^^
* 2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn.
```
### 49.2.0
```
-------
Changes
^^^^^^^
* 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.
```
### 49.1.3
```
-------
Misc
^^^^
* 2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state.
* 2249: Fix extension loading technique in stubs.
```
### 49.1.2
```
-------
Changes
^^^^^^^
* 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.
```
### 49.1.1
```
-------
Misc
^^^^
* 2094: Removed pkg_resources.py2_warn module, which is no longer reachable.
```
### 49.1.0
```
-------
Changes
^^^^^^^
* 2228: Disabled distutils adoption for now while emergent issues are addressed.
```
### 49.0.1
```
-------
Misc
^^^^
* 2228: Applied fix for pypa/distutils3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file.
```
### 49.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 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.
Changes
^^^^^^^
* 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.
Misc
^^^^
* 2199: Fix exception causes all over the codebase by using ``raise new_exception from old_exception``
```
### 48.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 2143: Setuptools adopts distutils from the Python 3.9 standard library and no longer depends on distutils in the standard library. When importing ``setuptools`` or ``setuptools.distutils_patch``, Setuptools will expose its bundled version as a top-level ``distutils`` package (and unload any previously-imported top-level distutils package), retaining the expectation that ``distutils``' 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 using ``pip install`` or ``pep517.build``. Workflows that rely on ``setup.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 "import setuptools; exec(open('setup.py').read())" (anything)``.
```
### 47.3.2
```
-------
Misc
^^^^
* 2071: Replaced references to the deprecated imp package with references to importlib
```
### 47.3.1
```
-------
Misc
^^^^
* 1973: Removed ``pkg_resources.py31compat.makedirs`` in favor of the stdlib. Use ``os.makedirs()`` instead.
* 2198: Restore ``__requires__`` directive in easy-install wrapper scripts.
```
### 47.3.0
```
-------
Changes
^^^^^^^
* 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.
Misc
^^^^
* 2195: Fix broken entry points generated by easy-install (pip editable installs).
```
### 47.2.0
```
-------
Changes
^^^^^^^
* 2194: Editable-installed entry points now load significantly faster on Python versions 3.8+.
```
### 47.1.1
```
-------
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2156: Update mailing list pointer in developer docs
```
### 47.1.0
```
-------
Changes
^^^^^^^
* 2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages.
```
### 47.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should use ``setuptools<45``.
Changes
^^^^^^^
* 1700: Document all supported keywords by migrating the ones from distutils.
```
### 46.4.0
```
-------
Changes
^^^^^^^
* 1753: ``attr:`` now extracts variables through rudimentary examination of the AST,
thereby supporting modules with third-party imports. If examining the AST
fails to find the variable, ``attr:`` falls back to the old behavior of
importing the module. Works on Python 3 only.
```
### 46.3.1
```
-------
No significant changes.
```
### 46.3.0
```
-------
Changes
^^^^^^^
* 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.
Misc
^^^^
* 2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards.
* 2105: Filter ``2to3`` deprecation warnings from ``TestDevelop.test_2to3_user_mode``.
```
### 46.2.0
```
-------
Changes
^^^^^^^
* 2040: Deprecated the ``bdist_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.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1698: Added documentation for ``build_meta`` (a bare minimum, not completed).
Misc
^^^^
* 2082: Filter ``lib2to3`` ``PendingDeprecationWarning`` and ``DeprecationWarning`` in tests,
because ``lib2to3`` is `deprecated in Python 3.9 <https://bugs.python.org/issue40360>`_.
```
### 46.1.3
```
-------
No significant changes.
```
### 46.1.2
```
-------
Misc
^^^^
* 1458: Added template for reporting Python 2 incompatibilities.
```
### 46.1.1
```
-------
No significant changes.
```
### 46.1.0
```
-------
Changes
^^^^^^^
* 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: In ``easy_install.check_site_dir``, ensure the installation directory exists.
* 1563: In ``pkg_resources`` prefer ``find_spec`` (PEP 451) to ``find_module``.
```
### 46.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 65: Once again as in 3.0, removed the Features feature.
Changes
^^^^^^^
* 1890: Fix vendored dependencies so importing ``setuptools.extern.some_module`` gives the same object as ``setuptools._vendor.some_module``. This makes Metadata picklable again.
* 1899: Test suite now fails on warnings.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2011: Fix broken link to distutils docs on package_data
Misc
^^^^
* 1991: Include pkg_resources test data in sdist, so tests can be executed from it.
```
### 45.3.0
```
-------
Changes
^^^^^^^
* 1557: Deprecated eggsecutable scripts and updated docs.
* 1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+
```
### 45.2.0
```
-------
Changes
^^^^^^^
* 1905: Fixed defect in _imp, introduced in 41.6.0 when the 'tests' directory is not present.
* 1941: Improve editable installs with PEP 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 in ``PYTHONPATH`` has been turned into a warning.
* 1981: Setuptools now declares its ``tests`` and ``docs`` dependencies in metadata (extras).
* 1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9).
Misc
^^^^
* 1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info.
```
### 45.1.0
```
-------
Changes
^^^^^^^
* 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.
```
### 45.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 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.
Changes
^^^^^^^
* 1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
```
### 44.1.1
```
-------
Misc
^^^^
* 2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.
```
### 44.1.0
```
-------
Changes
^^^^^^^
* 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.
```
### 44.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 1908: Drop support for Python 3.4.
```
### 43.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 1634: Include ``pyproject.toml`` in source distribution by default. Projects relying on the previous behavior where ``pyproject.toml`` was excluded by default should stop relying on that behavior or add ``exclude pyproject.toml`` to their MANIFEST.in file.
Changes
^^^^^^^
* 1927: Setuptools once again declares 'setuptools' in the ``build-system.requires`` and adds PEP 517 build support by declaring itself as the ``build-backend``. It additionally specifies ``build-system.backend-path`` to rely on itself for those builders that support it.
```
### 42.0.2
```
-------
Changes
^^^^^^^
* 1921: Fix support for easy_install's ``find-links`` option in ``setup.cfg``.
* 1922: Build dependencies (setup_requires and tests_require) now install transitive dependencies indicated by extras.
```
### 42.0.1
```
-------
Changes
^^^^^^^
* 1918: Fix regression in handling wheels compatibility tags.
```
### 42.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 1830, 1909: Mark the easy_install script and setuptools command as deprecated, and use `pip <https://pip.pypa.io/en/stable/>`_ when available to fetch/build wheels for missing ``setup_requires``/``tests_require`` requirements, with the following differences in behavior:
* support for ``python_requires``
* better support for wheels (proper handling of priority with respect to PEP 425 tags)
* PEP 517/518 support
* eggs are not supported
* no support for the ``allow_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 of `twine <https://pypi.org/p/twine>`_.
Changes
^^^^^^^
* 1767: Add support for the ``license_files`` option in ``setup.cfg`` to automatically
include 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 like `setuptools_scm <https://pypi.org/project/setuptools_scm>`_ to configure options on the distribution at finalization time.
```
### 41.6.0
```
-------
Changes
^^^^^^^
* 479: Replace usage of deprecated ``imp`` module with local re-implementation in ``setuptools._imp``.
```
### 41.5.1
```
-------
Changes
^^^^^^^
* 1891: Fix code for detecting Visual Studio's version on Windows under Python 2.
```
### 41.5.0
```
-------
Changes
^^^^^^^
* 1811: Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019.
* 1814: Fix ``pkg_resources.Requirement`` hash/equality implementation: take PEP 508 direct URL into account.
* 1824: Fix tests when running under ``python3.10``.
* 1878: Formally deprecated the ``test`` command, with the recommendation that users migrate to ``tox``.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 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.
Misc
^^^^
* 1886: Added Python 3.8 release to the Travis test matrix.
```
### 41.4.0
```
-------
Changes
^^^^^^^
* 1847: In declarative config, now traps errors when invalid ``python_requires`` values are supplied.
```
### 41.3.0
```
-------
Changes
^^^^^^^
* 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+.
Misc
^^^^
* 1858: Fixed failing integration test triggered by 'long_description_content_type' in packaging.
```
### 41.2.0
```
-------
Changes
^^^^^^^
* 479: Remove some usage of the deprecated ``imp`` module.
Misc
^^^^
* 1565: Changed html_sidebars from string to list of string as per
https://www.sphinx-doc.org/en/master/changes.htmlid58
```
### 41.1.0
```
-------
Misc
^^^^
* 1697: Moved most of the constants from setup.py to setup.cfg
* 1749: Fixed issue with the PEP 517 backend where building a source distribution would fail if any tarball existed in the destination directory.
* 1750: Fixed an issue with PEP 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: Improve ``package_data`` check: ensure the dictionary values are lists/tuples of strings.
* 1788: Changed compatibility fallback logic for ``html.unescape`` to avoid accessing ``HTMLParser.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 a ``UnicodeDecodeError`` occurs while reading a metadata file.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1776: Use license classifiers rather than the license field.
```
### 41.0.1
```
-------
Changes
^^^^^^^
* 1671: Fixed issue with the PEP 517 backend that prevented building a wheel when the ``dist/`` 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
```
### 41.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 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.
```
### 40.9.0
```
-------
Changes
^^^^^^^
* 1675: Added support for ``setup.cfg``-only projects when using the ``setuptools.build_meta`` backend. Projects that have enabled PEP 517 no longer need to have a ``setup.py`` and can use the purely declarative ``setup.cfg`` configuration file instead.
* 1720: Added support for ``pkg_resources.parse_requirements``-style requirements in ``setup_requires`` when ``setup.py`` is invoked from the ``setuptools.build_meta`` build backend.
* 1664: Added the path to the ``PKG-INFO`` or ``METADATA`` file in the exception
text when the ``Version:`` header can't be found.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1705: Removed some placeholder documentation sections referring to deprecated features.
```
### 40.8.0
```
-------
Changes
^^^^^^^
* 1652: Added the ``build_meta:__legacy__`` backend, a "compatibility mode" PEP 517 backend that can be used as the default when ``build-backend`` is left unspecified in ``pyproject.toml``.
* 1635: Resource paths are passed to ``pkg_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 if ``setup.cfg`` contains a ``license_file`` attribute, unless this file is manually excluded inside ``MANIFEST.in``.
```
### 40.7.3
```
-------
Changes
^^^^^^^
* 1670: In package_index, revert to using a copy of splituser from Python 3.8. Attempts to use ``urllib.parse.urlparse`` led to problems as reported in 1663 and 1668. This change serves as an alternative to 1499 and fixes 1668.
```
### 40.7.2
```
-------
Changes
^^^^^^^
* 1666: Restore port in URL handling in package_index.
```
### 40.7.1
```
-------
Changes
^^^^^^^
* 1660: On Python 2, when reading config files, downcast options from text to bytes to satisfy distutils expectations.
```
### 40.7.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 1551: File inputs for the ``license`` field in ``setup.cfg`` files now explicitly raise an error.
Changes
^^^^^^^
* 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 deprecated ``urllib.parse.splituser`` per Python 27485.
* 1544: Added tests for PackageIndex.download (for git URLs).
* 1625: In PEP 517 build_meta builder, ensure that sdists are built as gztar per the spec.
```
### 40.6.3
```
-------
Changes
^^^^^^^
* 1594: PEP 517 backend no longer declares setuptools as a dependency as it can be assumed.
```
### 40.6.2
```
-------
Changes
^^^^^^^
* 1592: Fix invalid dependency on external six module (instead of vendored version).
```
### 40.6.1
```
-------
Changes
^^^^^^^
* 1590: Fixed regression where packages without ``author`` or ``author_email`` fields generated malformed package metadata.
```
### 40.6.0
```
-------
Deprecations
^^^^^^^^^^^^
* 1541: Officially deprecated the ``requires`` parameter in ``setup()``.
Changes
^^^^^^^
* 1519: In ``pkg_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 from ``DeprecationWarning`` and are thus visible by default.
* 1554: ``build_meta.build_sdist`` now includes ``setup.py`` in source distributions by default.
* 1576: Started monkey-patching ``get_metadata_version`` and ``read_pkg_file`` onto ``distutils.DistributionMetadata`` to retain the correct version on the ``PKG-INFO`` file in the (deprecated) ``upload`` command.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1395: Changed Pyrex references to Cython in the documentation.
* 1456: Documented that the ``rpmbuild`` packages is required for the ``bdist_rpm`` command.
* 1537: Documented how to use ``setup.cfg`` for ``src/ layouts``
* 1539: Added minimum version column in ``setup.cfg`` metadata table.
* 1552: Fixed a minor typo in the python 2/3 compatibility documentation.
* 1553: Updated installation instructions to point to ``pip install`` instead of ``ez_setup.py``.
* 1560: Updated ``setuptools`` distribution documentation to remove some outdated information.
* 1564: Documented ``setup.cfg`` minimum version for version and project_urls.
Misc
^^^^
* 1533: Restricted the ``recursive-include setuptools/_vendor`` to contain only .py and .txt files.
* 1572: Added the ``concurrent.futures`` backport ``futures`` to the Python 2.7 test suite requirements.
```
### 40.5.0
```
-------
Changes
^^^^^^^
* 1335: In ``pkg_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 of ``u""`` literals.
* 1520: Added support for ``data_files`` in ``setup.cfg``.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1525: Fixed rendering of the deprecation warning in easy_install doc.
```
### 40.4.3
```
-------
Changes
^^^^^^^
* 1480: Bump vendored pyparsing in pkg_resources to 2.2.1.
```
### 40.4.2
```
-------
Misc
^^^^
* 1497: Updated gitignore in repo.
```
### 40.4.1
```
-------
Changes
^^^^^^^
* 1480: Bump vendored pyparsing to 2.2.1.
```
### 40.4.0
```
-------
Changes
^^^^^^^
* 1481: Join the sdist ``--dist-dir`` and the ``build_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).
```
### 40.3.0
```
-------
Changes
^^^^^^^
* 1402: Fixed a bug with namespace packages under Python 3.6 when one package in
current directory hides another which is installed.
* 1427: Set timestamp of ``.egg-info`` directory whenever ``egg_info`` command is run.
* 1474: ``build_meta.get_requires_for_build_sdist`` now does not include the ``wheel`` package anymore.
* 1486: Suppress warnings in pkg_resources.handle_ns.
Misc
^^^^
* 1479: Remove internal use of six.binary_type.
```
### 40.2.0
```
-------
Changes
^^^^^^^
* 1466: Fix handling of Unicode arguments in PEP 517 backend
```
### 40.1.1
```
--------
Changes
^^^^^^^
* 1465: Fix regression with ``egg_info`` command when tagging is used.
```
### 40.1.0
```
-------
Changes
^^^^^^^
* 1410: Deprecated ``upload`` and ``register`` commands.
* 1312: Introduced find_namespace_packages() to find PEP 420 namespace packages.
* 1420: Added find_namespace: directive to config parser.
* 1418: Solved race in when creating egg cache directories.
* 1450: Upgraded vendored PyParsing from 2.1.10 to 2.2.0.
* 1451: Upgraded vendored appdirs from 1.4.0 to 1.4.3.
* 1388: Fixed "Microsoft Visual C++ Build Tools" link in exception when Visual C++ not found.
* 1389: Added support for scripts which have unicode content.
* 1416: Moved several Python version checks over to using ``six.PY2`` and ``six.PY3``.
Misc
^^^^
* 1441: Removed spurious executable permissions from files that don't need them.
```
### 40.0.0
```
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* 1342: Drop support for Python 3.3.
Changes
^^^^^^^
* 1366: In package_index, fixed handling of encoded entities in URLs.
* 1383: In pkg_resources VendorImporter, avoid removing packages imported from the root.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1379: Minor doc fixes after actually using the new release process.
* 1385: Removed section on non-package data files.
* 1403: Fix developer's guide.
Misc
^^^^
* 1404: Fix PEP 518 configuration: set build requirements in ``pyproject.toml`` to ``["wheel"]``.
```
### 39.2.0
```
-------
Changes
^^^^^^^
* 1359: Support using "file:" to load a PEP 440-compliant package version from
a text file.
* 1360: Fixed issue with a mismatch between the name of the package and the
name of the .dist-info file in wheel files
* 1364: Add ``__dir__()`` implementation to ``pkg_resources.Distribution()`` that
includes the attributes in the ``_provider`` instance variable.
* 1365: Take the package_dir option into account when loading the version from
a module attribute.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1353: Added coverage badge to README.
* 1356: Made small fixes to the developer guide documentation.
* 1357: Fixed warnings in documentation builds and started enforcing that the
docs build without warnings in tox.
* 1376: Updated release process docs.
Misc
^^^^
* 1343: The ``setuptools`` specific ``long_description_content_type``,
``project_urls`` and ``provides_extras`` fields are now set consistently
after any ``distutils`` ``setup_keywords`` calls, allowing them to override
values.
* 1352: Added ``tox`` environment for documentation builds.
* 1354: Added ``towncrier`` for changelog management.
* 1355: Add PR template.
* 1368: Fixed tests which failed without network connectivity.
* 1369: Added unit tests for PEP 425 compatibility tags support.
* 1372: Stop testing Python 3.3 in Travis CI, now that the latest version of
``wheel`` no longer installs on it.
```
### 39.1.0
```
-------
* 1340: Update all PyPI URLs to reflect the switch to the
new Warehouse codebase.
* 1337: In ``pkg_resources``, now support loading resources
for modules loaded by the ``SourcelessFileLoader``.
* 1332: Silence spurious wheel related warnings on Windows.
```
### 39.0.1
```
-------
* 1297: Restore Unicode handling for Maintainer fields in
metadata.
```
### 39.0.0
```
-------
* 1296: Setuptools now vendors its own direct dependencies, no
longer relying on the dependencies as vendored by pkg_resources.
* 296: Removed long-deprecated support for iteration on
Version objects as returned by ``pkg_resources.parse_version``.
Removed the ``SetuptoolsVersion`` and
``SetuptoolsLegacyVersion`` names as well. They should not
have been used, but if they were, replace with
``Version`` and ``LegacyVersion`` from ``packaging.version``.
```
### 38.7.0
```
-------
* 1288: Add support for maintainer in PKG-INFO.
```
### 38.6.1
```
-------
* 1292: Avoid generating ``Provides-Extra`` in metadata when
no extra is present (but environment markers are).
```
### 38.6.0
```
-------
* 1286: Add support for Metadata 2.1 (PEP 566).
```
### 38.5.2
```
-------
* 1285: Fixed RuntimeError in pkg_resources.parse_requirements
on Python 3.7 (stemming from PEP 479).
```
### 38.5.1
```
-------
* 1271: Revert to Cython legacy ``build_ext`` behavior for
compatibility.
```
### 38.5.0
```
-------
* 1229: Expand imports in ``build_ext`` to refine detection of
Cython availability.
* 1270: When Cython is available, ``build_ext`` now uses the
new_build_ext.
```
### 38.4.1
```
-------
* 1257: In bdist_egg.scan_module, fix ValueError on Python 3.7.
```
### 38.4.0
```
-------
* 1231: Removed warning when PYTHONDONTWRITEBYTECODE is enabled.
```
### 38.3.0
```
-------
* 1210: Add support for PEP 345 Project-URL metadata.
* 1207: Add support for ``long_description_type`` to setup.cfg
declarative config as intended and documented.
```
### 38.2.5
```
-------
* 1232: Fix trailing slash handling in ``pkg_resources.ZipProvider``.
```
### 38.2.4
```
-------
* 1220: Fix ``data_files`` handling when installing from wheel.
```
### 38.2.3
```
-------
* fix Travis' Python 3.3 job.
```
### 38.2.2
```
-------
* 1214: fix handling of namespace packages when installing
from a wheel.
```
### 38.2.1
```
-------
* 1212: fix encoding handling of metadata when installing
from a wheel.
```
### 38.2.0
```
-------
* 1200: easy_install now support installing from wheels:
they will be installed as standalone unzipped eggs.
```
### 38.1.0
```
-------
* 1208: Improve error message when failing to locate scripts
in egg-info metadata.
```
### 38.0.0
```
-------
* 458: In order to support deterministic builds, Setuptools no
longer allows packages to declare ``install_requires`` as
unordered sequences (sets or dicts).
```
### 37.0.0
```
-------
* 878: Drop support for Python 2.6. Python 2.6 users should
rely on 'setuptools < 37dev'.
```
### 36.8.0
```
-------
* 1190: In SSL support for package index operations, use SNI
where available.
```
### 36.7.3
```
-------
* 1175: Bug fixes to ``build_meta`` module.
```
### 36.7.2
```
-------
* 701: Fixed duplicate test discovery on Python 3.
```
### 36.7.1
```
-------
* 1193: Avoid test failures in bdist_egg when
PYTHONDONTWRITEBYTECODE is set.
```
### 36.7.0
```
-------
* 1054: Support ``setup_requires`` in ``setup.cfg`` files.
```
### 36.6.1
```
-------
* 1132: Removed redundant and costly serialization/parsing step
in ``EntryPoint.__init__``.
* 844: ``bdist_egg --exclude-source-files`` now tested and works
on Python 3.
```
### 36.6.0
```
-------
* 1143: Added ``setuptools.build_meta`` module, an implementation
of PEP-517 for Setuptools-defined packages.
* 1143: Added ``dist_info`` command for producing dist_info
metadata.
```
### 36.5.0
```
-------
* 170: When working with Mercurial checkouts, use Windows-friendly
syntax for suppressing output.
* Inspired by 1134, performed substantial refactoring of
``pkg_resources.find_on_path`` to facilitate an optimization
for paths with many non-version entries.
```
### 36.4.0
```
-------
* 1075: Add new ``Description-Content-Type`` metadata field. `See here for
documentation on how to use this field.
<https://packaging.python.org/specifications/description-content-type>`_
* 1068: Sort files and directories when building eggs for
deterministic order.
* 196: Remove caching of easy_install command in fetch_build_egg.
Fixes issue where ``pytest-runner-N.N`` would satisfy the installation
of ``pytest``.
* 1129: Fix working set dependencies handling when replacing conflicting
distributions (e.g. when using ``setup_requires`` with a conflicting
transitive dependency, fix 1124).
* 1133: Improved handling of README files extensions and added
Markdown to the list of searched READMES.
* 1135: Improve performance of pkg_resources import by not invoking
``access`` or ``stat`` and using ``os.listdir`` instead.
```
### 36.3.0
```
-------
* 1131: Make possible using several files within ``file:`` directive
in metadata.long_description in ``setup.cfg``.
```
### 36.2.7
```
-------
* fix 1105: Fix handling of requirements with environment
markers when declared in ``setup.cfg`` (same treatment as
for 1081).
```
### 36.2.6
```
-------
* 462: Don't assume a directory is an egg by the ``.egg``
extension alone.
```
### 36.2.5
```
-------
* 1093: Fix test command handler with extras_require.
* 1112, 1091, 1115: Now using Trusty containers in
Travis for CI and CD.
```
### 36.2.4
```
-------
* 1092: ``pkg_resources`` now uses ``inspect.getmro`` to
resolve classes in method resolution order.
```
### 36.2.3
```
-------
* 1102: Restore behavior for empty extras.
```
### 36.2.2
```
-------
* 1099: Revert commit a3ec721, restoring intended purpose of
extras as part of a requirement declaration.
```
### 36.2.1
```
-------
* fix 1086
* fix 1087
* support extras specifiers in install_requires requirements
```
### 36.2.0
```
-------
* 1081: Environment markers indicated in ``install_requires``
are now processed and treated as nameless ``extras_require``
with markers, allowing their metadata in requires.txt to be
correctly generated.
* 1053: Tagged commits are now released using Travis-CI
build stages, meaning releases depend on passing tests on
all supported Python versions (Linux) and not just the latest
Python version.
```
### 36.1.1
```
-------
* 1083: Correct ``py31compat.makedirs`` to correctly honor
``exist_ok`` parameter.
* 1083: Also use makedirs compatibility throughout setuptools.
```
### 36.1.0
```
-------
* 1083: Avoid race condition on directory creation in
``pkg_resources.ensure_directory``.
* Removed deprecation of and restored support for
``upload_docs`` command for sites other than PyPI.
Only warehouse is dropping support, but services like
`devpi <http://doc.devpi.net/latest/>`_ continue to
support docs built by setuptools' plugins. See
`this comment <https://bitbucket.org/hpk42/devpi/issues/388/support-rtd-model-for-building-uploadingcomment-34292423>`_
for more context on the motivation for this change.
```
### 36.0.1
```
-------
* 1042: Fix import in py27compat module that still
referenced six directly, rather than through the externs
module (vendored packages hook).
```
### 36.0.0
```
-------
* 980 and others: Once again, Setuptools vendors all
of its dependencies. It seems to be the case that in
the Python ecosystem, all build tools must run without
any dependencies (build, runtime, or otherwise). At
such a point that a mechanism exists that allows
build tools to have dependencies, Setuptools will adopt
it.
```
### 35.0.2
```
-------
* 1015: Fix test failures on Python 3.7.
* 1024: Add workaround for Jython 2581 in monkey module.
```
### 35.0.1
```
-------
* 992: Revert change introduced in v34.4.1, now
considered invalid.
* 1016: Revert change introduced in v35.0.0 per 1014,
referencing 436. The approach had unintended
consequences, causing sdist installs to be missing
files.
```
### 35.0.0
```
-------
* 436: In egg_info.manifest_maker, no longer read
the file list from the manifest file, and instead
re-build it on each build. In this way, files removed
from the specification will not linger in the manifest.
As a result, any files manually added to the manifest
will be removed on subsequent egg_info invocations.
No projects should be manually adding files to the
manifest and should instead use MANIFEST.in or SCM
file finders to force inclusion of files in the manifest.
```
### 34.4.1
```
-------
* 1008: In MSVC support, use always the last version available for Windows SDK and UCRT SDK.
* 1008: In MSVC support, fix "vcruntime140.dll" returned path with Visual Studio 2017.
* 992: In msvc.msvc9_query_vcvarsall, ensure the
returned dicts have str values and not Unicode for
compatibility with os.environ.
```
### 34.4.0
```
-------
* 995: In MSVC support, add support for "Microsoft Visual Studio 2017" and "Microsoft Visual Studio Build Tools 2017".
* 999 via 1007: Extend support for declarative package
config in a setup.cfg file to include the options
``python_requires`` and ``py_modules``.
```
### 34.3.3
```
-------
* 967 (and 997): Explicitly import submodules of
packaging to account for environments where the imports
of those submodules is not implied by other behavior.
```
### 34.3.2
```
-------
* 993: Fix documentation upload by correcting
rendering of content-type in _build_multipart
on Python 3.
```
### 34.3.1
```
-------
* 988: Trap ``os.unlink`` same as ``os.remove`` in
``auto_chmod`` error handler.
* 983: Fixes to invalid escape sequence deprecations on
Python 3.6.
```
### 34.3.0
```
-------
* 941: In the upload command, if the username is blank,
default to ``getpass.getuser()``.
* 971: Correct distutils findall monkeypatch to match
appropriate versions (namely Python 3.4.6).
```
### 34.2.0
```
-------
* 966: Add support for reading dist-info metadata and
thus locating Distributions from zip files.
* 968: Allow '+' and '!' in egg fragments
so that it can take package names that contain
PEP 440 conforming version specifiers.
```
### 34.1.1
```
-------
* 953: More aggressively employ the compatibility issue
originally added in 706.
```
### 34.1.0
```
-------
* 930: ``build_info`` now accepts two new parameters
to optimize and customize the building of C libraries.
```
### 34.0.3
```
-------
* 947: Loosen restriction on the version of six required,
restoring compatibility with environments relying on
six 1.6.0 and later.
```
### 34.0.2
```
-------
* 882: Ensure extras are honored when building the
working set.
* 913: Fix issue in develop if package directory has
a trailing slash.
```
### 34.0.1
```
-------
* 935: Fix glob syntax in graft.
```
### 34.0.0
```
-------
* 581: Instead of vendoring the growing list of
dependencies that Setuptools requires to function,
Setuptools now requires these dependencies just like
any other project. Unlike other projects, however,
Setuptools cannot rely on ``setup_requires`` to
demand the dependencies it needs to install because
its own machinery would be necessary to pull those
dependencies if not present (a bootstrapping problem).
As a result, Setuptools no longer supports self upgrade or
installation in the general case. Instead, users are
directed to use pip to install and upgrade using the
``wheel`` distributions of setuptools.
Users are welcome to contrive other means to install
or upgrade Setuptools using other means, such as
pre-installing the Setuptools dependencies with pip
or a bespoke bootstrap tool, but such usage is not
recommended and is not supported.
As discovered in 940, not all versions of pip will
successfully install Setuptools from its pre-built
wheel. If you encounter issues with "No module named
six" or "No module named packaging", especially
following a line "Running setup.py egg_info for package
setuptools", then your pip is not new enough.
There's an additional issue in pip where setuptools
is upgraded concurrently with other source packages,
described in pip 4253. The proposed workaround is to
always upgrade Setuptools first prior to upgrading
other packages that would upgrade Setuptools.
```
### 33.1.1
```
-------
* 921: Correct issue where certifi fallback not being
reached on Windows.
```
### 33.1.0
```
-------
Installation via pip, as indicated in the `Python Packaging
User's Guide <https://packaging.python.org/installing/>`_,
is the officially-supported mechanism for installing
Setuptools, and this recommendation is now explicit in the
much more concise README.
Other edits and tweaks were made to the documentation. The
codebase is unchanged.
```
### 33.0.0
```
-------
* 619: Removed support for the ``tag_svn_revision``
distribution option. If Subversion tagging support is
still desired, consider adding the functionality to
setuptools_svn in setuptools_svn 2.
```
### 32.3.1
```
-------
* 866: Use ``dis.Bytecode`` on Python 3.4 and later in
``setuptools.depends``.
```
### 32.3.0
```
-------
* 889: Backport proposed fix for disabling interpolation in
distutils.Distribution.parse_config_files.
```
### 32.2.0
```
-------
* 884: Restore support for running the tests under
`pytest-runner <https://github.com/pytest-dev/pytest-runner>`_
by ensuring that PYTHONPATH is honored in tests invoking
a subprocess.
```
### 32.1.3
```
-------
* 706: Add rmtree compatibility shim for environments where
rmtree fails when passed a unicode string.
```
### 32.1.2
```
-------
* 893: Only release sdist in zip format as warehouse now
disallows releasing two different formats.
```
### 32.1.1
```
-------
* 704: More selectively ensure that 'rmtree' is not invoked with
a byte string, enabling it to remove files that are non-ascii,
even on Python 2.
* 712: In 'sandbox.run_setup', ensure that ``__file__`` is
always a ``str``, modeling the behavior observed by the
interpreter when invoking scripts and modules.
```
### 32.1.0
```
-------
* 891: In 'test' command on test failure, raise DistutilsError,
suppression invocation of subsequent commands.
```
### 32.0.0
```
-------
* 890: Revert 849. ``global-exclude .foo`` will not match all
``*.foo`` files any more. Package authors must add an explicit
wildcard, such as ``global-exclude *.foo``, to match all
``.foo`` files. See 886, 849.
```
### 31.0.1
```
-------
* 885: Fix regression where 'pkg_resources._rebuild_mod_path'
would fail when a namespace package's '__path__' was not
a list with a sort attribute.
```
### 31.0.0
```
-------
* 250: Install '-nspkg.pth' files for packages installed
with 'setup.py develop'. These .pth files allow
namespace packages installed by pip or develop to
co-mingle. This change required the removal of the
change for 805 and pip 1924, introduced in 28.3.0 and implicated
in 870, but means that namespace packages not in a
site packages directory will no longer work on Python
earlier than 3.5, whereas before they would work on
Python not earlier than 3.3.
```
### 30.4.0
```
-------
* 879: For declarative config:
- read_configuration() now accepts ignore_option_errors argument. This allows scraping tools to read metadata without a need to download entire packages. E.g. we can gather some stats right from GitHub repos just by downloading setup.cfg.
- packages find: directive now supports fine tuning from a subsection. The same arguments as for find() are accepted.
```
### 30.3.0
```
-------
* 394 via 862: Added support for `declarative package
config in a setup.cfg file
<https://setuptools.readthedocs.io/en/latest/setuptools.htmlconfiguring-setup-using-setup-cfg-files>`_.
```
### 30.2.1
```
-------
* 850: In test command, invoke unittest.main with
indication not to exit the process.
```
### 30.2.0
```
-------
* 854: Bump to vendored Packaging 16.8.
```
### 30.1.0
```
-------
* 846: Also trap 'socket.error' when opening URLs in
package_index.
* 849: Manifest processing now matches the filename
pattern anywhere in the filename and not just at the
start. Restores behavior found prior to 28.5.0.
```
### 30.0.0
```
-------
* 864: Drop support for Python 3.2. Systems requiring
Python 3.2 support must use 'setuptools < 30'.
* 825: Suppress warnings for single files.
* 830 via 843: Once again restored inclusion of data
files to sdists, but now trap TypeError caused by
techniques employed rjsmin and similar.
```
### 29.0.1
```
-------
* 861: Re-release of v29.0.1 with the executable script
launchers bundled. Now, launchers are included by default
and users that want to disable this behavior must set the
environment variable
'SETUPTOOLS_INSTALL_WINDOWS_SPECIFIC_FILES' to
a false value like "false" or "0".
```
### 29.0.0
```
-------
* 841: Drop special exception for packages invoking
win32com during the build/install process. See
Distribute 118 for history.
```
### 28.8.0
```
-------
* 629: Per the discussion, refine the sorting to use version
value order for more accurate detection of the latest
available version when scanning for packages. See also
829.
* 837: Rely on the config var "SO" for Python 3.3.0 only
when determining the ext filename.
```
### 28.7.1
```
-------
* 827: Update PyPI root for dependency links.
* 833: Backed out changes from 830 as the implementation
seems to have problems in some cases.
```
### 28.7.0
```
-------
* 832: Moved much of the namespace package handling
functionality into a separate module for re-use in something
like 789.
* 830: ``sdist`` command no longer suppresses the inclusion
of data files, re-aligning with the expectation of distutils
and addressing 274 and 521.
```
### 28.6.1
```
-------
* 816: Fix manifest file list order in tests.
```
### 28.6.0
```
-------
* 629: When scanning for packages, ``pkg_resources`` now
ignores empty egg-info directories and gives precedence to
packages whose versions are lexicographically greatest,
a rough approximation for preferring the latest available
version.
```
### 28.5.0
```
-------
* 810: Tests are now invoked with tox and not setup.py test.
* 249 and 450 via 764: Avoid scanning the whole tree
when building the manifest. Also fixes a long-standing bug
where patterns in ``MANIFEST.in`` had implicit wildcard
matching. This caused ``global-exclude .foo`` to exclude
all ``*.foo`` files, but also ``global-exclude bar.py`` to
exclude ``foo_bar.py``.
```
### 28.4.0
```
-------
* 732: Now extras with a hyphen are honored per PEP 426.
* 811: Update to pyparsing 2.1.10.
* Updated ``setuptools.command.sdist`` to re-use most of
the functionality directly from ``distutils.command.sdist``
for the ``add_defaults`` method with strategic overrides.
See 750 for rationale.
* 760 via 762: Look for certificate bundle where SUSE
Linux typically presents it. Use ``certifi.where()`` to locate
the bundle.
```
### 28.3.0
```
-------
* 809: In ``find_packages()``, restore support for excluding
a parent package without excluding a child package.
* 805: Disable ``-nspkg.pth`` behavior on Python 3.3+ where
PEP-420 functionality is adequate. Fixes pip 1924.
```
### 28.1.0
```
-------
* 803: Bump certifi to 2016.9.26.
```
### 28.0.0
```
-------
* 733: Do not search excluded directories for packages.
This introduced a backwards incompatible change in ``find_packages()``
so that ``find_packages(exclude=['foo']) == []``, excluding subpackages of ``foo``.
Previously, ``find_packages(exclude=['foo']) == ['foo.bar']``,
even though the parent ``foo`` package was excluded.
* 795: Bump certifi.
* 719: Suppress decoding errors and instead log a warning
when metadata cannot be decoded.
```
### 27.3.1
```
-------
* 790: In MSVC monkeypatching, explicitly patch each
function by name in the target module instead of inferring
the module from the function's ``__module__``. Improves
compatibility with other packages that might have previously
patched distutils functions (i.e. NumPy).
```
### 27.3.0
```
-------
* 794: In test command, add installed eggs to PYTHONPATH
when invoking tests so that subprocesses will also have the
dependencies available. Fixes `tox 330
<https://github.com/tox-dev/tox/issues/330>`_.
* 795: Update vendored pyparsing 2.1.9.
```
### 27.2.0
```
-------
* 520 and 513: Suppress ValueErrors in fixup_namespace_packages
when lookup fails.
* Nicer, more consistent interfaces for msvc monkeypatching.
```
### 27.1.2
```
-------
* 779 via 781: Fix circular import.
```
### 27.1.1
```
-------
* 778: Fix MSVC monkeypatching.
```
### 27.1.0
```
-------
* Introduce the (private) ``monkey`` module to encapsulate
the distutils monkeypatching behavior.
```
### 27.0.0
```
-------
* Now use Warehouse by default for
``upload``, patching ``distutils.config.PyPIRCCommand`` to
affect default behavior.
Any config in .pypirc should be updated to replace
https://pypi.python.org/pypi/
with
https://upload.pypi.org/legacy/
Similarly, any passwords stored in the keyring should be
updated to use this new value for "system".
The ``upload_docs`` command will continue to use the python.org
site, but the command is now deprecated. Users are urged to use
Read The Docs instead.
* 776: Use EXT_SUFFIX for py_limited_api renaming.
* 774 and 775: Use LegacyVersion from packaging when
detecting numpy versions.
```
### 26.1.1
```
-------
* Re-release of 26.1.0 with pytest pinned to allow for automated
deployment and thus proper packaging environment variables,
fixing issues with missing executable launchers.
```
### 26.1.0
```
-------
* 763: ``pkg_resources.get_default_cache`` now defers to the
`appdirs project <https://pypi.org/project/appdirs>`_ to
resolve the cache directory. Adds a vendored dependency on
appdirs to pkg_resources.
```
### 26.0.0
```
-------
* 748: By default, sdists are now produced in gzipped tarfile
format by default on all platforms, adding forward compatibility
for the same behavior in Python 3.6 (See Python 27819).
* 459 via 736: On Windows with script launchers,
sys.argv[0] now reflects
the name of the entry point, consistent with the behavior in
distlib and pip wrappers.
* 752 via 753: When indicating ``py_limited_api`` to Extension,
it must be passed as a keyword argument.
```
### 25.4.0
```
-------
* Add Extension(py_limited_api=True). When set to a truthy value,
that extension gets a filename appropriate for code using Py_LIMITED_API.
When used correctly this allows a single compiled extension to work on
all future versions of CPython 3.
The py_limited_api argument only controls the filename. To be
compatible with multiple versions of Python 3, the C extension
will also need to set -DPy_LIMITED_API=... and be modified to use
only the functions in the limited API.
```
### 25.3.0
```
-------
* 739 Fix unquoted libpaths by fixing compatibility between ``numpy.distutils`` and ``distutils._msvccompiler`` for numpy < 1.11.2 (Fix issue 728, error also fixed in Numpy).
* 731: Bump certifi.
* Style updates. See 740, 741, 743, 744, 742, 747.
* 735: include license file.
```
### 25.2.0
```
-------
* 612 via 730: Add a LICENSE file which needs to be provided by the terms of
the MIT license.
```
### 25.1.6
```
-------
* 725: revert ``library_dir_option`` patch (Error is related to ``numpy.distutils`` and make errors on non Numpy users).
```
### 25.1.5
```
-------
* 720
* 723: Improve patch for ``library_dir_option``.
```
### 25.1.4
```
-------
* 717
* 713
* 707: Fix Python 2 compatibility for MSVC by catching errors properly.
* 715: Fix unquoted libpaths by patching ``library_dir_option``.
```
### 25.1.3
```
-------
* 714 and 704: Revert fix as it breaks other components
downstream that can't handle unicode. See 709, 710,
and 712.
```
### 25.1.2
```
-------
* 704: Fix errors when installing a zip sdist that contained
files named with non-ascii characters on Windows would
crash the install when it attempted to clean up the build.
* 646: MSVC compatibility - catch errors properly in
RegistryInfo.lookup.
* 702: Prevent UnboundLocalError when initial working_set
is empty.
```
### 25.1.1
```
-------
* 686: Fix issue in sys.path ordering by pkg_resources when
rewrite technique is "raw".
* 699: Fix typo in msvc support.
```
### 25.1.0
```
-------
* 609: Setuptools will now try to download a distribution from
the next possible download location if the first download fails.
This means you can now specify multiple links as ``dependency_links``
and all links will be tried until a working download link is encountered.
```
### 25.0.2
```
-------
* 688: Fix AttributeError in setup.py when invoked not from
the current directory.
```
### 25.0.1
```
-------
* Cleanup of setup.py script.
* Fixed documentation builders by allowing setup.py
to be imported without having bootstrapped the
metadata.
* More style cleanup. See 677, 678, 679, 681, 685.
```
### 25.0.0
```
-------
* 674: Default ``sys.path`` manipulation by easy-install.pth
is now "raw", meaning that when writing easy-install.pth
during any install operation, the ``sys.path`` will not be
rewritten and will no longer give preference to easy_installed
packages.
To retain the old behavior when using any easy_install
operation (including ``setup.py install`` when setuptools is
present), set the environment variable:
SETUPTOOLS_SYS_PATH_TECHNIQUE=rewrite
This project hopes that that few if any environments find it
necessary to retain the old behavior, and intends to drop
support for it altogether in a future release. Please report
any relevant concerns in the ticket for this change.
```
### 24.3.1
```
-------
* 398: Fix shebang handling on Windows in script
headers where spaces in ``sys.executable`` would
produce an improperly-formatted shebang header,
introduced in 12.0 with the fix for 188.
* 663, 670: More style updates.
```
### 24.3.0
```
-------
* 516: Disable ``os.link`` to avoid hard linking
in ``sdist.make_distribution``, avoiding errors on
systems that support hard links but not on the
file system in which the build is occurring.
```
### 24.2.1
```
-------
* 667: Update Metadata-Version to 1.2 when
``python_requires`` is supplied.
```
### 24.2.0
```
-------
* 631: Add support for ``python_requires`` keyword.
```
### 24.1.1
```
-------
* More style updates. See 660, 661, 641.
```
### 24.1.0
```
-------
* 659: ``setup.py`` now will fail fast and with a helpful
error message when the necessary metadata is missing.
* More style updates. See 656, 635, 640,
644, 650, 652, and 655.
```
### 24.0.3
```
-------
* Updated style in much of the codebase to match
community expectations. See 632, 633, 634,
637, 639, 638, 642, 648.
```
### 24.0.2
```
-------
* If MSVC++14 is needed ``setuptools.msvc`` now redirect
user to Visual C++ Build Tools web page.
```
### 24.0.1
```
-------
* 625 and 626: Fixes on ``setuptools.msvc`` mainly
for Python 2 and Linux.
```
### 24.0.0
```
-------
* Pull Request 174: Add more aggressive support for
standalone Microsoft Visual C++ compilers in
msvc9compiler patch.
Particularly : Windows SDK 6.1 and 7.0
(MSVC++ 9.0), Windows SDK 7.1 (MSVC++ 10.0),
Visual C++ Build Tools 2015 (MSVC++14)
* Renamed ``setuptools.msvc9_support`` to
``setuptools.msvc``.
```
### 23.2.1
```
-------
Re-release of v23.2.0, which was missing the intended
commits.
* 623: Remove used of deprecated 'U' flag when reading
manifests.
```
### 23.1.0
```
-------
* 619: Deprecated ``tag_svn_revision`` distribution
option.
```
### 23.0.0
```
-------
* 611: Removed ARM executables for CLI and GUI script
launchers on Windows. If this was a feature you cared
about, please comment in the ticket.
* 604: Removed docs building support. The project
now relies on documentation hosted at
https://setuptools.readthedocs.io/.
```
### 22.0.5
```
-------
* 604: Restore repository for upload_docs command
to restore publishing of docs during release.
```
### 22.0.4
```
-------
* 589: Upload releases to pypi.io using the upload
hostname and legacy path.
```
### 22.0.3
```
-------
* 589: Releases are now uploaded to pypi.io (Warehouse)
even when releases are made on Twine via Travis.
```
### 22.0.2
```
-------
* 589: Releases are now uploaded to pypi.io (Warehouse).
```
### 22.0.1
```
-------
* 190: On Python 2, if unicode is passed for packages to
``build_py`` command, it will be handled just as with
text on Python 3.
```
### 22.0.0
```
-------
Intended to be v21.3.0, but jaraco accidentally released as
a major bump.
* 598: Setuptools now lists itself first in the User-Agent
for web requests, better following the guidelines in
`RFC 7231
<https://tools.ietf.org/html/rfc7231section-5.5.3>`_.
```
### 21.2.2
```
-------
* Minor fixes to changelog and docs.
```
### 21.2.1
```
-------
* 261: Exclude directories when resolving globs in
package_data.
```
### 21.2.0
```
-------
* 539: In the easy_install get_site_dirs, honor all
paths found in ``site.getsitepackages``.
```
### 21.1.0
```
-------
* 572: In build_ext, now always import ``_CONFIG_VARS``
from ``distutils`` rather than from ``sysconfig``
to allow ``distutils.sysconfig.customize_compiler``
configure the OS X compiler for ``-dynamiclib``.
```
### 21.0.0
```
-------
* Removed ez_setup.py from Setuptools sdist. The
bootstrap script will be main
This PR pins setuptools to the latest release 51.0.0.
Changelog
### 51.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 2435: Require Python 3.6 or later. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 2430: Fixed inconsistent RST title nesting levels caused by 2399 -- by :user:`webknjaz` * 2430: Fixed a typo in Sphinx docs that made docs dev section disappear as a result of PR 2426 -- by :user:`webknjaz` Misc ^^^^ * 2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils. ``` ### 50.3.2 ``` ------- Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 2394: Extended towncrier news template to include change note categories. This allows to see what types of changes a given version introduces -- by :user:`webknjaz` * 2427: Started enforcing strict syntax and reference validation in the Sphinx docs -- by :user:`webknjaz` * 2428: Removed redundant Sphinx ``Makefile`` support -- by :user:`webknjaz` Misc ^^^^ * 2401: Enabled test results reporting in AppVeyor CI -- by :user:`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 :user:`webknjaz` ``` ### 50.3.1 ``` ------- Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 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 :user:`webknjaz` * 2395: Added an illustrative explanation about the change notes to fragments dir -- by :user:`webknjaz` Misc ^^^^ * 2379: Travis CI test suite now tests against PPC64. * 2413: Suppress EOF errors (and other exceptions) when importing lib2to3. ``` ### 50.3.0 ``` ------- Changes ^^^^^^^ * 2368: In distutils, restore support for monkeypatched CCompiler.spawn per pypa/distutils15. ``` ### 50.2.0 ``` ------- Changes ^^^^^^^ * 2355: When pip is imported as part of a build, leave distutils patched. * 2380: There are some setuptools specific changes in the ``setuptools.command.bdist_rpm`` module that are no longer needed, because they are part of the ``bdist_rpm`` module in distutils in Python 3.5.0. Therefore, code was removed from ``setuptools.command.bdist_rpm``. ``` ### 50.1.0 ``` ------- Changes ^^^^^^^ * 2350: Setuptools reverts using the included distutils by default. Platform maintainers and system integrators and others are *strongly* encouraged to set ``SETUPTOOLS_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. ``` ### 50.0.3 ``` ------- Misc ^^^^ * 2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils9). ``` ### 50.0.2 ``` ------- Misc ^^^^ * 2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876. ``` ### 50.0.1 ``` ------- Misc ^^^^ * 2357: Restored Python 3.5 support in distutils.util for missing ``subprocess._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 class from importlib.abc rather than importlib.util.abc (alias removed in Python 3.10). ``` ### 50.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 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 variable ``SETUPTOOLS_USE_DISTUTILS`` is set to ``stdlib``, 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. Changes ^^^^^^^ * 2334: In MSVC module, refine text in error message. ``` ### 49.6.0 ``` ------- Changes ^^^^^^^ * 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. ``` ### 49.5.0 ``` ------- Changes ^^^^^^^ * 2306: When running as a PEP 517 backend, setuptools does not try to install ``setup_requires`` itself. They are reported as build requirements for the frontend to install. ``` ### 49.4.0 ``` ------- Changes ^^^^^^^ * 2310: Updated vendored packaging version to 20.4. ``` ### 49.3.2 ``` ------- Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 2300: Improve the ``safe_version`` function documentation Misc ^^^^ * 2297: Once again, in stubs prefer exec_module to the deprecated load_module. ``` ### 49.3.1 ``` ------- Changes ^^^^^^^ * 2316: Removed warning when ``distutils`` is imported before ``setuptools`` when ``distutils`` replacement is not enabled. ``` ### 49.3.0 ``` ------- Changes ^^^^^^^ * 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. ``` ### 49.2.1 ``` ------- Misc ^^^^ * 2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn. ``` ### 49.2.0 ``` ------- Changes ^^^^^^^ * 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. ``` ### 49.1.3 ``` ------- Misc ^^^^ * 2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state. * 2249: Fix extension loading technique in stubs. ``` ### 49.1.2 ``` ------- Changes ^^^^^^^ * 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. ``` ### 49.1.1 ``` ------- Misc ^^^^ * 2094: Removed pkg_resources.py2_warn module, which is no longer reachable. ``` ### 49.1.0 ``` ------- Changes ^^^^^^^ * 2228: Disabled distutils adoption for now while emergent issues are addressed. ``` ### 49.0.1 ``` ------- Misc ^^^^ * 2228: Applied fix for pypa/distutils3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file. ``` ### 49.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 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. Changes ^^^^^^^ * 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. Misc ^^^^ * 2199: Fix exception causes all over the codebase by using ``raise new_exception from old_exception`` ``` ### 48.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 2143: Setuptools adopts distutils from the Python 3.9 standard library and no longer depends on distutils in the standard library. When importing ``setuptools`` or ``setuptools.distutils_patch``, Setuptools will expose its bundled version as a top-level ``distutils`` package (and unload any previously-imported top-level distutils package), retaining the expectation that ``distutils``' 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 using ``pip install`` or ``pep517.build``. Workflows that rely on ``setup.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 "import setuptools; exec(open('setup.py').read())" (anything)``. ``` ### 47.3.2 ``` ------- Misc ^^^^ * 2071: Replaced references to the deprecated imp package with references to importlib ``` ### 47.3.1 ``` ------- Misc ^^^^ * 1973: Removed ``pkg_resources.py31compat.makedirs`` in favor of the stdlib. Use ``os.makedirs()`` instead. * 2198: Restore ``__requires__`` directive in easy-install wrapper scripts. ``` ### 47.3.0 ``` ------- Changes ^^^^^^^ * 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. Misc ^^^^ * 2195: Fix broken entry points generated by easy-install (pip editable installs). ``` ### 47.2.0 ``` ------- Changes ^^^^^^^ * 2194: Editable-installed entry points now load significantly faster on Python versions 3.8+. ``` ### 47.1.1 ``` ------- Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 2156: Update mailing list pointer in developer docs ``` ### 47.1.0 ``` ------- Changes ^^^^^^^ * 2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages. ``` ### 47.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should use ``setuptools<45``. Changes ^^^^^^^ * 1700: Document all supported keywords by migrating the ones from distutils. ``` ### 46.4.0 ``` ------- Changes ^^^^^^^ * 1753: ``attr:`` now extracts variables through rudimentary examination of the AST, thereby supporting modules with third-party imports. If examining the AST fails to find the variable, ``attr:`` falls back to the old behavior of importing the module. Works on Python 3 only. ``` ### 46.3.1 ``` ------- No significant changes. ``` ### 46.3.0 ``` ------- Changes ^^^^^^^ * 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. Misc ^^^^ * 2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards. * 2105: Filter ``2to3`` deprecation warnings from ``TestDevelop.test_2to3_user_mode``. ``` ### 46.2.0 ``` ------- Changes ^^^^^^^ * 2040: Deprecated the ``bdist_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. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 1698: Added documentation for ``build_meta`` (a bare minimum, not completed). Misc ^^^^ * 2082: Filter ``lib2to3`` ``PendingDeprecationWarning`` and ``DeprecationWarning`` in tests, because ``lib2to3`` is `deprecated in Python 3.9 <https://bugs.python.org/issue40360>`_. ``` ### 46.1.3 ``` ------- No significant changes. ``` ### 46.1.2 ``` ------- Misc ^^^^ * 1458: Added template for reporting Python 2 incompatibilities. ``` ### 46.1.1 ``` ------- No significant changes. ``` ### 46.1.0 ``` ------- Changes ^^^^^^^ * 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: In ``easy_install.check_site_dir``, ensure the installation directory exists. * 1563: In ``pkg_resources`` prefer ``find_spec`` (PEP 451) to ``find_module``. ``` ### 46.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 65: Once again as in 3.0, removed the Features feature. Changes ^^^^^^^ * 1890: Fix vendored dependencies so importing ``setuptools.extern.some_module`` gives the same object as ``setuptools._vendor.some_module``. This makes Metadata picklable again. * 1899: Test suite now fails on warnings. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 2011: Fix broken link to distutils docs on package_data Misc ^^^^ * 1991: Include pkg_resources test data in sdist, so tests can be executed from it. ``` ### 45.3.0 ``` ------- Changes ^^^^^^^ * 1557: Deprecated eggsecutable scripts and updated docs. * 1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+ ``` ### 45.2.0 ``` ------- Changes ^^^^^^^ * 1905: Fixed defect in _imp, introduced in 41.6.0 when the 'tests' directory is not present. * 1941: Improve editable installs with PEP 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 in ``PYTHONPATH`` has been turned into a warning. * 1981: Setuptools now declares its ``tests`` and ``docs`` dependencies in metadata (extras). * 1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9). Misc ^^^^ * 1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info. ``` ### 45.1.0 ``` ------- Changes ^^^^^^^ * 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. ``` ### 45.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 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. Changes ^^^^^^^ * 1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2 ``` ### 44.1.1 ``` ------- Misc ^^^^ * 2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0. ``` ### 44.1.0 ``` ------- Changes ^^^^^^^ * 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. ``` ### 44.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 1908: Drop support for Python 3.4. ``` ### 43.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 1634: Include ``pyproject.toml`` in source distribution by default. Projects relying on the previous behavior where ``pyproject.toml`` was excluded by default should stop relying on that behavior or add ``exclude pyproject.toml`` to their MANIFEST.in file. Changes ^^^^^^^ * 1927: Setuptools once again declares 'setuptools' in the ``build-system.requires`` and adds PEP 517 build support by declaring itself as the ``build-backend``. It additionally specifies ``build-system.backend-path`` to rely on itself for those builders that support it. ``` ### 42.0.2 ``` ------- Changes ^^^^^^^ * 1921: Fix support for easy_install's ``find-links`` option in ``setup.cfg``. * 1922: Build dependencies (setup_requires and tests_require) now install transitive dependencies indicated by extras. ``` ### 42.0.1 ``` ------- Changes ^^^^^^^ * 1918: Fix regression in handling wheels compatibility tags. ``` ### 42.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 1830, 1909: Mark the easy_install script and setuptools command as deprecated, and use `pip <https://pip.pypa.io/en/stable/>`_ when available to fetch/build wheels for missing ``setup_requires``/``tests_require`` requirements, with the following differences in behavior: * support for ``python_requires`` * better support for wheels (proper handling of priority with respect to PEP 425 tags) * PEP 517/518 support * eggs are not supported * no support for the ``allow_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 of `twine <https://pypi.org/p/twine>`_. Changes ^^^^^^^ * 1767: Add support for the ``license_files`` option in ``setup.cfg`` to automatically include 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 like `setuptools_scm <https://pypi.org/project/setuptools_scm>`_ to configure options on the distribution at finalization time. ``` ### 41.6.0 ``` ------- Changes ^^^^^^^ * 479: Replace usage of deprecated ``imp`` module with local re-implementation in ``setuptools._imp``. ``` ### 41.5.1 ``` ------- Changes ^^^^^^^ * 1891: Fix code for detecting Visual Studio's version on Windows under Python 2. ``` ### 41.5.0 ``` ------- Changes ^^^^^^^ * 1811: Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019. * 1814: Fix ``pkg_resources.Requirement`` hash/equality implementation: take PEP 508 direct URL into account. * 1824: Fix tests when running under ``python3.10``. * 1878: Formally deprecated the ``test`` command, with the recommendation that users migrate to ``tox``. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 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. Misc ^^^^ * 1886: Added Python 3.8 release to the Travis test matrix. ``` ### 41.4.0 ``` ------- Changes ^^^^^^^ * 1847: In declarative config, now traps errors when invalid ``python_requires`` values are supplied. ``` ### 41.3.0 ``` ------- Changes ^^^^^^^ * 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+. Misc ^^^^ * 1858: Fixed failing integration test triggered by 'long_description_content_type' in packaging. ``` ### 41.2.0 ``` ------- Changes ^^^^^^^ * 479: Remove some usage of the deprecated ``imp`` module. Misc ^^^^ * 1565: Changed html_sidebars from string to list of string as per https://www.sphinx-doc.org/en/master/changes.htmlid58 ``` ### 41.1.0 ``` ------- Misc ^^^^ * 1697: Moved most of the constants from setup.py to setup.cfg * 1749: Fixed issue with the PEP 517 backend where building a source distribution would fail if any tarball existed in the destination directory. * 1750: Fixed an issue with PEP 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: Improve ``package_data`` check: ensure the dictionary values are lists/tuples of strings. * 1788: Changed compatibility fallback logic for ``html.unescape`` to avoid accessing ``HTMLParser.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 a ``UnicodeDecodeError`` occurs while reading a metadata file. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 1776: Use license classifiers rather than the license field. ``` ### 41.0.1 ``` ------- Changes ^^^^^^^ * 1671: Fixed issue with the PEP 517 backend that prevented building a wheel when the ``dist/`` 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 ``` ### 41.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 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. ``` ### 40.9.0 ``` ------- Changes ^^^^^^^ * 1675: Added support for ``setup.cfg``-only projects when using the ``setuptools.build_meta`` backend. Projects that have enabled PEP 517 no longer need to have a ``setup.py`` and can use the purely declarative ``setup.cfg`` configuration file instead. * 1720: Added support for ``pkg_resources.parse_requirements``-style requirements in ``setup_requires`` when ``setup.py`` is invoked from the ``setuptools.build_meta`` build backend. * 1664: Added the path to the ``PKG-INFO`` or ``METADATA`` file in the exception text when the ``Version:`` header can't be found. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 1705: Removed some placeholder documentation sections referring to deprecated features. ``` ### 40.8.0 ``` ------- Changes ^^^^^^^ * 1652: Added the ``build_meta:__legacy__`` backend, a "compatibility mode" PEP 517 backend that can be used as the default when ``build-backend`` is left unspecified in ``pyproject.toml``. * 1635: Resource paths are passed to ``pkg_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 if ``setup.cfg`` contains a ``license_file`` attribute, unless this file is manually excluded inside ``MANIFEST.in``. ``` ### 40.7.3 ``` ------- Changes ^^^^^^^ * 1670: In package_index, revert to using a copy of splituser from Python 3.8. Attempts to use ``urllib.parse.urlparse`` led to problems as reported in 1663 and 1668. This change serves as an alternative to 1499 and fixes 1668. ``` ### 40.7.2 ``` ------- Changes ^^^^^^^ * 1666: Restore port in URL handling in package_index. ``` ### 40.7.1 ``` ------- Changes ^^^^^^^ * 1660: On Python 2, when reading config files, downcast options from text to bytes to satisfy distutils expectations. ``` ### 40.7.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 1551: File inputs for the ``license`` field in ``setup.cfg`` files now explicitly raise an error. Changes ^^^^^^^ * 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 deprecated ``urllib.parse.splituser`` per Python 27485. * 1544: Added tests for PackageIndex.download (for git URLs). * 1625: In PEP 517 build_meta builder, ensure that sdists are built as gztar per the spec. ``` ### 40.6.3 ``` ------- Changes ^^^^^^^ * 1594: PEP 517 backend no longer declares setuptools as a dependency as it can be assumed. ``` ### 40.6.2 ``` ------- Changes ^^^^^^^ * 1592: Fix invalid dependency on external six module (instead of vendored version). ``` ### 40.6.1 ``` ------- Changes ^^^^^^^ * 1590: Fixed regression where packages without ``author`` or ``author_email`` fields generated malformed package metadata. ``` ### 40.6.0 ``` ------- Deprecations ^^^^^^^^^^^^ * 1541: Officially deprecated the ``requires`` parameter in ``setup()``. Changes ^^^^^^^ * 1519: In ``pkg_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 from ``DeprecationWarning`` and are thus visible by default. * 1554: ``build_meta.build_sdist`` now includes ``setup.py`` in source distributions by default. * 1576: Started monkey-patching ``get_metadata_version`` and ``read_pkg_file`` onto ``distutils.DistributionMetadata`` to retain the correct version on the ``PKG-INFO`` file in the (deprecated) ``upload`` command. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 1395: Changed Pyrex references to Cython in the documentation. * 1456: Documented that the ``rpmbuild`` packages is required for the ``bdist_rpm`` command. * 1537: Documented how to use ``setup.cfg`` for ``src/ layouts`` * 1539: Added minimum version column in ``setup.cfg`` metadata table. * 1552: Fixed a minor typo in the python 2/3 compatibility documentation. * 1553: Updated installation instructions to point to ``pip install`` instead of ``ez_setup.py``. * 1560: Updated ``setuptools`` distribution documentation to remove some outdated information. * 1564: Documented ``setup.cfg`` minimum version for version and project_urls. Misc ^^^^ * 1533: Restricted the ``recursive-include setuptools/_vendor`` to contain only .py and .txt files. * 1572: Added the ``concurrent.futures`` backport ``futures`` to the Python 2.7 test suite requirements. ``` ### 40.5.0 ``` ------- Changes ^^^^^^^ * 1335: In ``pkg_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 of ``u""`` literals. * 1520: Added support for ``data_files`` in ``setup.cfg``. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 1525: Fixed rendering of the deprecation warning in easy_install doc. ``` ### 40.4.3 ``` ------- Changes ^^^^^^^ * 1480: Bump vendored pyparsing in pkg_resources to 2.2.1. ``` ### 40.4.2 ``` ------- Misc ^^^^ * 1497: Updated gitignore in repo. ``` ### 40.4.1 ``` ------- Changes ^^^^^^^ * 1480: Bump vendored pyparsing to 2.2.1. ``` ### 40.4.0 ``` ------- Changes ^^^^^^^ * 1481: Join the sdist ``--dist-dir`` and the ``build_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). ``` ### 40.3.0 ``` ------- Changes ^^^^^^^ * 1402: Fixed a bug with namespace packages under Python 3.6 when one package in current directory hides another which is installed. * 1427: Set timestamp of ``.egg-info`` directory whenever ``egg_info`` command is run. * 1474: ``build_meta.get_requires_for_build_sdist`` now does not include the ``wheel`` package anymore. * 1486: Suppress warnings in pkg_resources.handle_ns. Misc ^^^^ * 1479: Remove internal use of six.binary_type. ``` ### 40.2.0 ``` ------- Changes ^^^^^^^ * 1466: Fix handling of Unicode arguments in PEP 517 backend ``` ### 40.1.1 ``` -------- Changes ^^^^^^^ * 1465: Fix regression with ``egg_info`` command when tagging is used. ``` ### 40.1.0 ``` ------- Changes ^^^^^^^ * 1410: Deprecated ``upload`` and ``register`` commands. * 1312: Introduced find_namespace_packages() to find PEP 420 namespace packages. * 1420: Added find_namespace: directive to config parser. * 1418: Solved race in when creating egg cache directories. * 1450: Upgraded vendored PyParsing from 2.1.10 to 2.2.0. * 1451: Upgraded vendored appdirs from 1.4.0 to 1.4.3. * 1388: Fixed "Microsoft Visual C++ Build Tools" link in exception when Visual C++ not found. * 1389: Added support for scripts which have unicode content. * 1416: Moved several Python version checks over to using ``six.PY2`` and ``six.PY3``. Misc ^^^^ * 1441: Removed spurious executable permissions from files that don't need them. ``` ### 40.0.0 ``` ------- Breaking Changes ^^^^^^^^^^^^^^^^ * 1342: Drop support for Python 3.3. Changes ^^^^^^^ * 1366: In package_index, fixed handling of encoded entities in URLs. * 1383: In pkg_resources VendorImporter, avoid removing packages imported from the root. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 1379: Minor doc fixes after actually using the new release process. * 1385: Removed section on non-package data files. * 1403: Fix developer's guide. Misc ^^^^ * 1404: Fix PEP 518 configuration: set build requirements in ``pyproject.toml`` to ``["wheel"]``. ``` ### 39.2.0 ``` ------- Changes ^^^^^^^ * 1359: Support using "file:" to load a PEP 440-compliant package version from a text file. * 1360: Fixed issue with a mismatch between the name of the package and the name of the .dist-info file in wheel files * 1364: Add ``__dir__()`` implementation to ``pkg_resources.Distribution()`` that includes the attributes in the ``_provider`` instance variable. * 1365: Take the package_dir option into account when loading the version from a module attribute. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * 1353: Added coverage badge to README. * 1356: Made small fixes to the developer guide documentation. * 1357: Fixed warnings in documentation builds and started enforcing that the docs build without warnings in tox. * 1376: Updated release process docs. Misc ^^^^ * 1343: The ``setuptools`` specific ``long_description_content_type``, ``project_urls`` and ``provides_extras`` fields are now set consistently after any ``distutils`` ``setup_keywords`` calls, allowing them to override values. * 1352: Added ``tox`` environment for documentation builds. * 1354: Added ``towncrier`` for changelog management. * 1355: Add PR template. * 1368: Fixed tests which failed without network connectivity. * 1369: Added unit tests for PEP 425 compatibility tags support. * 1372: Stop testing Python 3.3 in Travis CI, now that the latest version of ``wheel`` no longer installs on it. ``` ### 39.1.0 ``` ------- * 1340: Update all PyPI URLs to reflect the switch to the new Warehouse codebase. * 1337: In ``pkg_resources``, now support loading resources for modules loaded by the ``SourcelessFileLoader``. * 1332: Silence spurious wheel related warnings on Windows. ``` ### 39.0.1 ``` ------- * 1297: Restore Unicode handling for Maintainer fields in metadata. ``` ### 39.0.0 ``` ------- * 1296: Setuptools now vendors its own direct dependencies, no longer relying on the dependencies as vendored by pkg_resources. * 296: Removed long-deprecated support for iteration on Version objects as returned by ``pkg_resources.parse_version``. Removed the ``SetuptoolsVersion`` and ``SetuptoolsLegacyVersion`` names as well. They should not have been used, but if they were, replace with ``Version`` and ``LegacyVersion`` from ``packaging.version``. ``` ### 38.7.0 ``` ------- * 1288: Add support for maintainer in PKG-INFO. ``` ### 38.6.1 ``` ------- * 1292: Avoid generating ``Provides-Extra`` in metadata when no extra is present (but environment markers are). ``` ### 38.6.0 ``` ------- * 1286: Add support for Metadata 2.1 (PEP 566). ``` ### 38.5.2 ``` ------- * 1285: Fixed RuntimeError in pkg_resources.parse_requirements on Python 3.7 (stemming from PEP 479). ``` ### 38.5.1 ``` ------- * 1271: Revert to Cython legacy ``build_ext`` behavior for compatibility. ``` ### 38.5.0 ``` ------- * 1229: Expand imports in ``build_ext`` to refine detection of Cython availability. * 1270: When Cython is available, ``build_ext`` now uses the new_build_ext. ``` ### 38.4.1 ``` ------- * 1257: In bdist_egg.scan_module, fix ValueError on Python 3.7. ``` ### 38.4.0 ``` ------- * 1231: Removed warning when PYTHONDONTWRITEBYTECODE is enabled. ``` ### 38.3.0 ``` ------- * 1210: Add support for PEP 345 Project-URL metadata. * 1207: Add support for ``long_description_type`` to setup.cfg declarative config as intended and documented. ``` ### 38.2.5 ``` ------- * 1232: Fix trailing slash handling in ``pkg_resources.ZipProvider``. ``` ### 38.2.4 ``` ------- * 1220: Fix ``data_files`` handling when installing from wheel. ``` ### 38.2.3 ``` ------- * fix Travis' Python 3.3 job. ``` ### 38.2.2 ``` ------- * 1214: fix handling of namespace packages when installing from a wheel. ``` ### 38.2.1 ``` ------- * 1212: fix encoding handling of metadata when installing from a wheel. ``` ### 38.2.0 ``` ------- * 1200: easy_install now support installing from wheels: they will be installed as standalone unzipped eggs. ``` ### 38.1.0 ``` ------- * 1208: Improve error message when failing to locate scripts in egg-info metadata. ``` ### 38.0.0 ``` ------- * 458: In order to support deterministic builds, Setuptools no longer allows packages to declare ``install_requires`` as unordered sequences (sets or dicts). ``` ### 37.0.0 ``` ------- * 878: Drop support for Python 2.6. Python 2.6 users should rely on 'setuptools < 37dev'. ``` ### 36.8.0 ``` ------- * 1190: In SSL support for package index operations, use SNI where available. ``` ### 36.7.3 ``` ------- * 1175: Bug fixes to ``build_meta`` module. ``` ### 36.7.2 ``` ------- * 701: Fixed duplicate test discovery on Python 3. ``` ### 36.7.1 ``` ------- * 1193: Avoid test failures in bdist_egg when PYTHONDONTWRITEBYTECODE is set. ``` ### 36.7.0 ``` ------- * 1054: Support ``setup_requires`` in ``setup.cfg`` files. ``` ### 36.6.1 ``` ------- * 1132: Removed redundant and costly serialization/parsing step in ``EntryPoint.__init__``. * 844: ``bdist_egg --exclude-source-files`` now tested and works on Python 3. ``` ### 36.6.0 ``` ------- * 1143: Added ``setuptools.build_meta`` module, an implementation of PEP-517 for Setuptools-defined packages. * 1143: Added ``dist_info`` command for producing dist_info metadata. ``` ### 36.5.0 ``` ------- * 170: When working with Mercurial checkouts, use Windows-friendly syntax for suppressing output. * Inspired by 1134, performed substantial refactoring of ``pkg_resources.find_on_path`` to facilitate an optimization for paths with many non-version entries. ``` ### 36.4.0 ``` ------- * 1075: Add new ``Description-Content-Type`` metadata field. `See here for documentation on how to use this field. <https://packaging.python.org/specifications/description-content-type>`_ * 1068: Sort files and directories when building eggs for deterministic order. * 196: Remove caching of easy_install command in fetch_build_egg. Fixes issue where ``pytest-runner-N.N`` would satisfy the installation of ``pytest``. * 1129: Fix working set dependencies handling when replacing conflicting distributions (e.g. when using ``setup_requires`` with a conflicting transitive dependency, fix 1124). * 1133: Improved handling of README files extensions and added Markdown to the list of searched READMES. * 1135: Improve performance of pkg_resources import by not invoking ``access`` or ``stat`` and using ``os.listdir`` instead. ``` ### 36.3.0 ``` ------- * 1131: Make possible using several files within ``file:`` directive in metadata.long_description in ``setup.cfg``. ``` ### 36.2.7 ``` ------- * fix 1105: Fix handling of requirements with environment markers when declared in ``setup.cfg`` (same treatment as for 1081). ``` ### 36.2.6 ``` ------- * 462: Don't assume a directory is an egg by the ``.egg`` extension alone. ``` ### 36.2.5 ``` ------- * 1093: Fix test command handler with extras_require. * 1112, 1091, 1115: Now using Trusty containers in Travis for CI and CD. ``` ### 36.2.4 ``` ------- * 1092: ``pkg_resources`` now uses ``inspect.getmro`` to resolve classes in method resolution order. ``` ### 36.2.3 ``` ------- * 1102: Restore behavior for empty extras. ``` ### 36.2.2 ``` ------- * 1099: Revert commit a3ec721, restoring intended purpose of extras as part of a requirement declaration. ``` ### 36.2.1 ``` ------- * fix 1086 * fix 1087 * support extras specifiers in install_requires requirements ``` ### 36.2.0 ``` ------- * 1081: Environment markers indicated in ``install_requires`` are now processed and treated as nameless ``extras_require`` with markers, allowing their metadata in requires.txt to be correctly generated. * 1053: Tagged commits are now released using Travis-CI build stages, meaning releases depend on passing tests on all supported Python versions (Linux) and not just the latest Python version. ``` ### 36.1.1 ``` ------- * 1083: Correct ``py31compat.makedirs`` to correctly honor ``exist_ok`` parameter. * 1083: Also use makedirs compatibility throughout setuptools. ``` ### 36.1.0 ``` ------- * 1083: Avoid race condition on directory creation in ``pkg_resources.ensure_directory``. * Removed deprecation of and restored support for ``upload_docs`` command for sites other than PyPI. Only warehouse is dropping support, but services like `devpi <http://doc.devpi.net/latest/>`_ continue to support docs built by setuptools' plugins. See `this comment <https://bitbucket.org/hpk42/devpi/issues/388/support-rtd-model-for-building-uploadingcomment-34292423>`_ for more context on the motivation for this change. ``` ### 36.0.1 ``` ------- * 1042: Fix import in py27compat module that still referenced six directly, rather than through the externs module (vendored packages hook). ``` ### 36.0.0 ``` ------- * 980 and others: Once again, Setuptools vendors all of its dependencies. It seems to be the case that in the Python ecosystem, all build tools must run without any dependencies (build, runtime, or otherwise). At such a point that a mechanism exists that allows build tools to have dependencies, Setuptools will adopt it. ``` ### 35.0.2 ``` ------- * 1015: Fix test failures on Python 3.7. * 1024: Add workaround for Jython 2581 in monkey module. ``` ### 35.0.1 ``` ------- * 992: Revert change introduced in v34.4.1, now considered invalid. * 1016: Revert change introduced in v35.0.0 per 1014, referencing 436. The approach had unintended consequences, causing sdist installs to be missing files. ``` ### 35.0.0 ``` ------- * 436: In egg_info.manifest_maker, no longer read the file list from the manifest file, and instead re-build it on each build. In this way, files removed from the specification will not linger in the manifest. As a result, any files manually added to the manifest will be removed on subsequent egg_info invocations. No projects should be manually adding files to the manifest and should instead use MANIFEST.in or SCM file finders to force inclusion of files in the manifest. ``` ### 34.4.1 ``` ------- * 1008: In MSVC support, use always the last version available for Windows SDK and UCRT SDK. * 1008: In MSVC support, fix "vcruntime140.dll" returned path with Visual Studio 2017. * 992: In msvc.msvc9_query_vcvarsall, ensure the returned dicts have str values and not Unicode for compatibility with os.environ. ``` ### 34.4.0 ``` ------- * 995: In MSVC support, add support for "Microsoft Visual Studio 2017" and "Microsoft Visual Studio Build Tools 2017". * 999 via 1007: Extend support for declarative package config in a setup.cfg file to include the options ``python_requires`` and ``py_modules``. ``` ### 34.3.3 ``` ------- * 967 (and 997): Explicitly import submodules of packaging to account for environments where the imports of those submodules is not implied by other behavior. ``` ### 34.3.2 ``` ------- * 993: Fix documentation upload by correcting rendering of content-type in _build_multipart on Python 3. ``` ### 34.3.1 ``` ------- * 988: Trap ``os.unlink`` same as ``os.remove`` in ``auto_chmod`` error handler. * 983: Fixes to invalid escape sequence deprecations on Python 3.6. ``` ### 34.3.0 ``` ------- * 941: In the upload command, if the username is blank, default to ``getpass.getuser()``. * 971: Correct distutils findall monkeypatch to match appropriate versions (namely Python 3.4.6). ``` ### 34.2.0 ``` ------- * 966: Add support for reading dist-info metadata and thus locating Distributions from zip files. * 968: Allow '+' and '!' in egg fragments so that it can take package names that contain PEP 440 conforming version specifiers. ``` ### 34.1.1 ``` ------- * 953: More aggressively employ the compatibility issue originally added in 706. ``` ### 34.1.0 ``` ------- * 930: ``build_info`` now accepts two new parameters to optimize and customize the building of C libraries. ``` ### 34.0.3 ``` ------- * 947: Loosen restriction on the version of six required, restoring compatibility with environments relying on six 1.6.0 and later. ``` ### 34.0.2 ``` ------- * 882: Ensure extras are honored when building the working set. * 913: Fix issue in develop if package directory has a trailing slash. ``` ### 34.0.1 ``` ------- * 935: Fix glob syntax in graft. ``` ### 34.0.0 ``` ------- * 581: Instead of vendoring the growing list of dependencies that Setuptools requires to function, Setuptools now requires these dependencies just like any other project. Unlike other projects, however, Setuptools cannot rely on ``setup_requires`` to demand the dependencies it needs to install because its own machinery would be necessary to pull those dependencies if not present (a bootstrapping problem). As a result, Setuptools no longer supports self upgrade or installation in the general case. Instead, users are directed to use pip to install and upgrade using the ``wheel`` distributions of setuptools. Users are welcome to contrive other means to install or upgrade Setuptools using other means, such as pre-installing the Setuptools dependencies with pip or a bespoke bootstrap tool, but such usage is not recommended and is not supported. As discovered in 940, not all versions of pip will successfully install Setuptools from its pre-built wheel. If you encounter issues with "No module named six" or "No module named packaging", especially following a line "Running setup.py egg_info for package setuptools", then your pip is not new enough. There's an additional issue in pip where setuptools is upgraded concurrently with other source packages, described in pip 4253. The proposed workaround is to always upgrade Setuptools first prior to upgrading other packages that would upgrade Setuptools. ``` ### 33.1.1 ``` ------- * 921: Correct issue where certifi fallback not being reached on Windows. ``` ### 33.1.0 ``` ------- Installation via pip, as indicated in the `Python Packaging User's Guide <https://packaging.python.org/installing/>`_, is the officially-supported mechanism for installing Setuptools, and this recommendation is now explicit in the much more concise README. Other edits and tweaks were made to the documentation. The codebase is unchanged. ``` ### 33.0.0 ``` ------- * 619: Removed support for the ``tag_svn_revision`` distribution option. If Subversion tagging support is still desired, consider adding the functionality to setuptools_svn in setuptools_svn 2. ``` ### 32.3.1 ``` ------- * 866: Use ``dis.Bytecode`` on Python 3.4 and later in ``setuptools.depends``. ``` ### 32.3.0 ``` ------- * 889: Backport proposed fix for disabling interpolation in distutils.Distribution.parse_config_files. ``` ### 32.2.0 ``` ------- * 884: Restore support for running the tests under `pytest-runner <https://github.com/pytest-dev/pytest-runner>`_ by ensuring that PYTHONPATH is honored in tests invoking a subprocess. ``` ### 32.1.3 ``` ------- * 706: Add rmtree compatibility shim for environments where rmtree fails when passed a unicode string. ``` ### 32.1.2 ``` ------- * 893: Only release sdist in zip format as warehouse now disallows releasing two different formats. ``` ### 32.1.1 ``` ------- * 704: More selectively ensure that 'rmtree' is not invoked with a byte string, enabling it to remove files that are non-ascii, even on Python 2. * 712: In 'sandbox.run_setup', ensure that ``__file__`` is always a ``str``, modeling the behavior observed by the interpreter when invoking scripts and modules. ``` ### 32.1.0 ``` ------- * 891: In 'test' command on test failure, raise DistutilsError, suppression invocation of subsequent commands. ``` ### 32.0.0 ``` ------- * 890: Revert 849. ``global-exclude .foo`` will not match all ``*.foo`` files any more. Package authors must add an explicit wildcard, such as ``global-exclude *.foo``, to match all ``.foo`` files. See 886, 849. ``` ### 31.0.1 ``` ------- * 885: Fix regression where 'pkg_resources._rebuild_mod_path' would fail when a namespace package's '__path__' was not a list with a sort attribute. ``` ### 31.0.0 ``` ------- * 250: Install '-nspkg.pth' files for packages installed with 'setup.py develop'. These .pth files allow namespace packages installed by pip or develop to co-mingle. This change required the removal of the change for 805 and pip 1924, introduced in 28.3.0 and implicated in 870, but means that namespace packages not in a site packages directory will no longer work on Python earlier than 3.5, whereas before they would work on Python not earlier than 3.3. ``` ### 30.4.0 ``` ------- * 879: For declarative config: - read_configuration() now accepts ignore_option_errors argument. This allows scraping tools to read metadata without a need to download entire packages. E.g. we can gather some stats right from GitHub repos just by downloading setup.cfg. - packages find: directive now supports fine tuning from a subsection. The same arguments as for find() are accepted. ``` ### 30.3.0 ``` ------- * 394 via 862: Added support for `declarative package config in a setup.cfg file <https://setuptools.readthedocs.io/en/latest/setuptools.htmlconfiguring-setup-using-setup-cfg-files>`_. ``` ### 30.2.1 ``` ------- * 850: In test command, invoke unittest.main with indication not to exit the process. ``` ### 30.2.0 ``` ------- * 854: Bump to vendored Packaging 16.8. ``` ### 30.1.0 ``` ------- * 846: Also trap 'socket.error' when opening URLs in package_index. * 849: Manifest processing now matches the filename pattern anywhere in the filename and not just at the start. Restores behavior found prior to 28.5.0. ``` ### 30.0.0 ``` ------- * 864: Drop support for Python 3.2. Systems requiring Python 3.2 support must use 'setuptools < 30'. * 825: Suppress warnings for single files. * 830 via 843: Once again restored inclusion of data files to sdists, but now trap TypeError caused by techniques employed rjsmin and similar. ``` ### 29.0.1 ``` ------- * 861: Re-release of v29.0.1 with the executable script launchers bundled. Now, launchers are included by default and users that want to disable this behavior must set the environment variable 'SETUPTOOLS_INSTALL_WINDOWS_SPECIFIC_FILES' to a false value like "false" or "0". ``` ### 29.0.0 ``` ------- * 841: Drop special exception for packages invoking win32com during the build/install process. See Distribute 118 for history. ``` ### 28.8.0 ``` ------- * 629: Per the discussion, refine the sorting to use version value order for more accurate detection of the latest available version when scanning for packages. See also 829. * 837: Rely on the config var "SO" for Python 3.3.0 only when determining the ext filename. ``` ### 28.7.1 ``` ------- * 827: Update PyPI root for dependency links. * 833: Backed out changes from 830 as the implementation seems to have problems in some cases. ``` ### 28.7.0 ``` ------- * 832: Moved much of the namespace package handling functionality into a separate module for re-use in something like 789. * 830: ``sdist`` command no longer suppresses the inclusion of data files, re-aligning with the expectation of distutils and addressing 274 and 521. ``` ### 28.6.1 ``` ------- * 816: Fix manifest file list order in tests. ``` ### 28.6.0 ``` ------- * 629: When scanning for packages, ``pkg_resources`` now ignores empty egg-info directories and gives precedence to packages whose versions are lexicographically greatest, a rough approximation for preferring the latest available version. ``` ### 28.5.0 ``` ------- * 810: Tests are now invoked with tox and not setup.py test. * 249 and 450 via 764: Avoid scanning the whole tree when building the manifest. Also fixes a long-standing bug where patterns in ``MANIFEST.in`` had implicit wildcard matching. This caused ``global-exclude .foo`` to exclude all ``*.foo`` files, but also ``global-exclude bar.py`` to exclude ``foo_bar.py``. ``` ### 28.4.0 ``` ------- * 732: Now extras with a hyphen are honored per PEP 426. * 811: Update to pyparsing 2.1.10. * Updated ``setuptools.command.sdist`` to re-use most of the functionality directly from ``distutils.command.sdist`` for the ``add_defaults`` method with strategic overrides. See 750 for rationale. * 760 via 762: Look for certificate bundle where SUSE Linux typically presents it. Use ``certifi.where()`` to locate the bundle. ``` ### 28.3.0 ``` ------- * 809: In ``find_packages()``, restore support for excluding a parent package without excluding a child package. * 805: Disable ``-nspkg.pth`` behavior on Python 3.3+ where PEP-420 functionality is adequate. Fixes pip 1924. ``` ### 28.1.0 ``` ------- * 803: Bump certifi to 2016.9.26. ``` ### 28.0.0 ``` ------- * 733: Do not search excluded directories for packages. This introduced a backwards incompatible change in ``find_packages()`` so that ``find_packages(exclude=['foo']) == []``, excluding subpackages of ``foo``. Previously, ``find_packages(exclude=['foo']) == ['foo.bar']``, even though the parent ``foo`` package was excluded. * 795: Bump certifi. * 719: Suppress decoding errors and instead log a warning when metadata cannot be decoded. ``` ### 27.3.1 ``` ------- * 790: In MSVC monkeypatching, explicitly patch each function by name in the target module instead of inferring the module from the function's ``__module__``. Improves compatibility with other packages that might have previously patched distutils functions (i.e. NumPy). ``` ### 27.3.0 ``` ------- * 794: In test command, add installed eggs to PYTHONPATH when invoking tests so that subprocesses will also have the dependencies available. Fixes `tox 330 <https://github.com/tox-dev/tox/issues/330>`_. * 795: Update vendored pyparsing 2.1.9. ``` ### 27.2.0 ``` ------- * 520 and 513: Suppress ValueErrors in fixup_namespace_packages when lookup fails. * Nicer, more consistent interfaces for msvc monkeypatching. ``` ### 27.1.2 ``` ------- * 779 via 781: Fix circular import. ``` ### 27.1.1 ``` ------- * 778: Fix MSVC monkeypatching. ``` ### 27.1.0 ``` ------- * Introduce the (private) ``monkey`` module to encapsulate the distutils monkeypatching behavior. ``` ### 27.0.0 ``` ------- * Now use Warehouse by default for ``upload``, patching ``distutils.config.PyPIRCCommand`` to affect default behavior. Any config in .pypirc should be updated to replace https://pypi.python.org/pypi/ with https://upload.pypi.org/legacy/ Similarly, any passwords stored in the keyring should be updated to use this new value for "system". The ``upload_docs`` command will continue to use the python.org site, but the command is now deprecated. Users are urged to use Read The Docs instead. * 776: Use EXT_SUFFIX for py_limited_api renaming. * 774 and 775: Use LegacyVersion from packaging when detecting numpy versions. ``` ### 26.1.1 ``` ------- * Re-release of 26.1.0 with pytest pinned to allow for automated deployment and thus proper packaging environment variables, fixing issues with missing executable launchers. ``` ### 26.1.0 ``` ------- * 763: ``pkg_resources.get_default_cache`` now defers to the `appdirs project <https://pypi.org/project/appdirs>`_ to resolve the cache directory. Adds a vendored dependency on appdirs to pkg_resources. ``` ### 26.0.0 ``` ------- * 748: By default, sdists are now produced in gzipped tarfile format by default on all platforms, adding forward compatibility for the same behavior in Python 3.6 (See Python 27819). * 459 via 736: On Windows with script launchers, sys.argv[0] now reflects the name of the entry point, consistent with the behavior in distlib and pip wrappers. * 752 via 753: When indicating ``py_limited_api`` to Extension, it must be passed as a keyword argument. ``` ### 25.4.0 ``` ------- * Add Extension(py_limited_api=True). When set to a truthy value, that extension gets a filename appropriate for code using Py_LIMITED_API. When used correctly this allows a single compiled extension to work on all future versions of CPython 3. The py_limited_api argument only controls the filename. To be compatible with multiple versions of Python 3, the C extension will also need to set -DPy_LIMITED_API=... and be modified to use only the functions in the limited API. ``` ### 25.3.0 ``` ------- * 739 Fix unquoted libpaths by fixing compatibility between ``numpy.distutils`` and ``distutils._msvccompiler`` for numpy < 1.11.2 (Fix issue 728, error also fixed in Numpy). * 731: Bump certifi. * Style updates. See 740, 741, 743, 744, 742, 747. * 735: include license file. ``` ### 25.2.0 ``` ------- * 612 via 730: Add a LICENSE file which needs to be provided by the terms of the MIT license. ``` ### 25.1.6 ``` ------- * 725: revert ``library_dir_option`` patch (Error is related to ``numpy.distutils`` and make errors on non Numpy users). ``` ### 25.1.5 ``` ------- * 720 * 723: Improve patch for ``library_dir_option``. ``` ### 25.1.4 ``` ------- * 717 * 713 * 707: Fix Python 2 compatibility for MSVC by catching errors properly. * 715: Fix unquoted libpaths by patching ``library_dir_option``. ``` ### 25.1.3 ``` ------- * 714 and 704: Revert fix as it breaks other components downstream that can't handle unicode. See 709, 710, and 712. ``` ### 25.1.2 ``` ------- * 704: Fix errors when installing a zip sdist that contained files named with non-ascii characters on Windows would crash the install when it attempted to clean up the build. * 646: MSVC compatibility - catch errors properly in RegistryInfo.lookup. * 702: Prevent UnboundLocalError when initial working_set is empty. ``` ### 25.1.1 ``` ------- * 686: Fix issue in sys.path ordering by pkg_resources when rewrite technique is "raw". * 699: Fix typo in msvc support. ``` ### 25.1.0 ``` ------- * 609: Setuptools will now try to download a distribution from the next possible download location if the first download fails. This means you can now specify multiple links as ``dependency_links`` and all links will be tried until a working download link is encountered. ``` ### 25.0.2 ``` ------- * 688: Fix AttributeError in setup.py when invoked not from the current directory. ``` ### 25.0.1 ``` ------- * Cleanup of setup.py script. * Fixed documentation builders by allowing setup.py to be imported without having bootstrapped the metadata. * More style cleanup. See 677, 678, 679, 681, 685. ``` ### 25.0.0 ``` ------- * 674: Default ``sys.path`` manipulation by easy-install.pth is now "raw", meaning that when writing easy-install.pth during any install operation, the ``sys.path`` will not be rewritten and will no longer give preference to easy_installed packages. To retain the old behavior when using any easy_install operation (including ``setup.py install`` when setuptools is present), set the environment variable: SETUPTOOLS_SYS_PATH_TECHNIQUE=rewrite This project hopes that that few if any environments find it necessary to retain the old behavior, and intends to drop support for it altogether in a future release. Please report any relevant concerns in the ticket for this change. ``` ### 24.3.1 ``` ------- * 398: Fix shebang handling on Windows in script headers where spaces in ``sys.executable`` would produce an improperly-formatted shebang header, introduced in 12.0 with the fix for 188. * 663, 670: More style updates. ``` ### 24.3.0 ``` ------- * 516: Disable ``os.link`` to avoid hard linking in ``sdist.make_distribution``, avoiding errors on systems that support hard links but not on the file system in which the build is occurring. ``` ### 24.2.1 ``` ------- * 667: Update Metadata-Version to 1.2 when ``python_requires`` is supplied. ``` ### 24.2.0 ``` ------- * 631: Add support for ``python_requires`` keyword. ``` ### 24.1.1 ``` ------- * More style updates. See 660, 661, 641. ``` ### 24.1.0 ``` ------- * 659: ``setup.py`` now will fail fast and with a helpful error message when the necessary metadata is missing. * More style updates. See 656, 635, 640, 644, 650, 652, and 655. ``` ### 24.0.3 ``` ------- * Updated style in much of the codebase to match community expectations. See 632, 633, 634, 637, 639, 638, 642, 648. ``` ### 24.0.2 ``` ------- * If MSVC++14 is needed ``setuptools.msvc`` now redirect user to Visual C++ Build Tools web page. ``` ### 24.0.1 ``` ------- * 625 and 626: Fixes on ``setuptools.msvc`` mainly for Python 2 and Linux. ``` ### 24.0.0 ``` ------- * Pull Request 174: Add more aggressive support for standalone Microsoft Visual C++ compilers in msvc9compiler patch. Particularly : Windows SDK 6.1 and 7.0 (MSVC++ 9.0), Windows SDK 7.1 (MSVC++ 10.0), Visual C++ Build Tools 2015 (MSVC++14) * Renamed ``setuptools.msvc9_support`` to ``setuptools.msvc``. ``` ### 23.2.1 ``` ------- Re-release of v23.2.0, which was missing the intended commits. * 623: Remove used of deprecated 'U' flag when reading manifests. ``` ### 23.1.0 ``` ------- * 619: Deprecated ``tag_svn_revision`` distribution option. ``` ### 23.0.0 ``` ------- * 611: Removed ARM executables for CLI and GUI script launchers on Windows. If this was a feature you cared about, please comment in the ticket. * 604: Removed docs building support. The project now relies on documentation hosted at https://setuptools.readthedocs.io/. ``` ### 22.0.5 ``` ------- * 604: Restore repository for upload_docs command to restore publishing of docs during release. ``` ### 22.0.4 ``` ------- * 589: Upload releases to pypi.io using the upload hostname and legacy path. ``` ### 22.0.3 ``` ------- * 589: Releases are now uploaded to pypi.io (Warehouse) even when releases are made on Twine via Travis. ``` ### 22.0.2 ``` ------- * 589: Releases are now uploaded to pypi.io (Warehouse). ``` ### 22.0.1 ``` ------- * 190: On Python 2, if unicode is passed for packages to ``build_py`` command, it will be handled just as with text on Python 3. ``` ### 22.0.0 ``` ------- Intended to be v21.3.0, but jaraco accidentally released as a major bump. * 598: Setuptools now lists itself first in the User-Agent for web requests, better following the guidelines in `RFC 7231 <https://tools.ietf.org/html/rfc7231section-5.5.3>`_. ``` ### 21.2.2 ``` ------- * Minor fixes to changelog and docs. ``` ### 21.2.1 ``` ------- * 261: Exclude directories when resolving globs in package_data. ``` ### 21.2.0 ``` ------- * 539: In the easy_install get_site_dirs, honor all paths found in ``site.getsitepackages``. ``` ### 21.1.0 ``` ------- * 572: In build_ext, now always import ``_CONFIG_VARS`` from ``distutils`` rather than from ``sysconfig`` to allow ``distutils.sysconfig.customize_compiler`` configure the OS X compiler for ``-dynamiclib``. ``` ### 21.0.0 ``` ------- * Removed ez_setup.py from Setuptools sdist. The bootstrap script will be main