7 * #2692: Globs are now sorted in 'license_files' restoring reproducibility by eliminating variance from disk order.
8 * #2714: Update to distutils at pypa/distutils@e2627b7.
9 * #2715: Removed reliance on deprecated ssl.match_hostname by removing the ssl support. Now any index operations rely on the native SSL implementation.
13 * #2604: Revamped the backward/cross tool compatibility section to remove
15 Add some examples and the version since when ``entry_points`` are
16 supported in declarative configuration.
17 Tried to make the reading flow a bit leaner, gather some informations
18 that were a bit dispersed.
27 * #2645: License files excluded via the ``MANIFEST.in`` but matched by either
28 the ``license_file`` (deprecated) or ``license_files`` options,
29 will be nevertheless included in the source distribution. - by :user:`cdce8p`
33 * #2628: Write long description in message payload of PKG-INFO file. - by :user:`cdce8p`
34 * #2645: Added ``License-File`` (multiple) to the output package metadata.
35 The field will contain the path of a license file, matched by the
36 ``license_file`` (deprecated) and ``license_files`` options,
37 relative to ``.dist-info``. - by :user:`cdce8p`
38 * #2678: Moved Setuptools' own entry points into declarative config.
39 * #2680: Vendored `more_itertools <https://pypi.org/project/more-itertools>`_ for Setuptools.
40 * #2681: Setuptools own setup.py no longer declares setup_requires, but instead expects wheel to be installed as declared by pyproject.toml.
44 * #2650: Updated the docs build tooling to support the latest version of
45 Towncrier and show the previews of not-yet-released setuptools versions
46 in the changelog -- :user:`webknjaz`
55 * #2640: Fixed handling of multiline license strings. - by :user:`cdce8p`
56 * #2641: Setuptools will now always try to use the latest supported
57 metadata version for ``PKG-INFO``. - by :user:`cdce8p`
66 * #2653: Incorporated assorted changes from pypa/distutils.
67 * #2657: Adopted docs from distutils.
68 * #2663: Added Visual Studio Express 2017 support -- by :user:`dofuuz`
72 * #2644: Fixed ``DeprecationWarning`` due to ``threading.Thread.setDaemon`` in tests -- by :user:`tirkarthi`
73 * #2654: Made the changelog generator compatible
74 with Towncrier >= 19.9 -- :user:`webknjaz`
75 * #2664: Relax the deprecation message in the distutils hack.
84 * #2620: The ``license_file`` option is now marked as deprecated.
85 Use ``license_files`` instead. -- by :user:`cdce8p`
89 * #2620: If neither ``license_file`` nor ``license_files`` is specified, the ``sdist``
90 option will now auto-include files that match the following patterns:
91 ``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS*``.
92 This matches the behavior of ``bdist_wheel``. -- by :user:`cdce8p`
96 * #2620: The ``license_file`` and ``license_files`` options now support glob patterns. -- by :user:`cdce8p`
97 * #2632: Implemented ``VendorImporter.find_spec()`` method to get rid
98 of ``ImportWarning`` that Python 3.10 emits when only the old-style
99 importer hooks are present -- by :user:`webknjaz`
101 Documentation changes
102 ^^^^^^^^^^^^^^^^^^^^^
103 * #2620: Added documentation for the ``license_files`` option. -- by :user:`cdce8p`
112 * #2566: Remove the deprecated ``bdist_wininst`` command. Binary packages should be built as wheels instead. -- by :user:`hroncok`
121 * #2608: Added informative error message to PEP 517 build failures owing to
122 an empty ``setup.py`` -- by :user:`layday`
128 No significant changes.
137 * #2595: Reduced scope of dash deprecation warning to Setuptools/distutils only -- by :user:`melissa-kun-li`
144 Documentation changes
145 ^^^^^^^^^^^^^^^^^^^^^
146 * #2584: Added ``sphinx-inline-tabs`` extension to allow for comparison of ``setup.py`` and its equivalent ``setup.cfg`` -- by :user:`amy-lei`
150 * #2592: Made option keys in the ``[metadata]`` section of ``setup.cfg`` case-sensitive. Users having
151 uppercase option spellings will get a warning suggesting to make them to lowercase
152 -- by :user:`melissa-kun-li`
161 * #1608: Removed the conversion of dashes to underscores in the :code:`extras_require` and :code:`data_files` of :code:`setup.cfg` to support the usage of dashes. Method will warn users when they use a dash-separated key which in the future will only allow an underscore. Note: the method performs the dash to underscore conversion to preserve compatibility, but future versions will no longer support it -- by :user:`melissa-kun-li`
170 * #2582: Simplified build-from-source story by providing bootstrapping metadata in a separate egg-info directory. Build requirements no longer include setuptools itself. Sdist once again includes the pyproject.toml. Project can no longer be installed from source on pip 19.x, but install from source is still supported on pip < 19 and pip >= 20 and install from wheel is still supported with pip >= 9.
174 * #1932: Handled :code:`AttributeError` by raising :code:`DistutilsSetupError` in :code:`dist.check_specifier()` when specifier is not a string -- by :user:`melissa-kun-li`
175 * #2570: Correctly parse cmdclass in setup.cfg.
177 Documentation changes
178 ^^^^^^^^^^^^^^^^^^^^^
179 * #2553: Added userguide example for markers in extras_require -- by :user:`pwoolvett`
188 * #1937: Preserved case-sensitivity of keys in setup.cfg so that entry point names are case-sensitive. Changed sensitivity of configparser. NOTE: Any projects relying on case-insensitivity will need to adapt to accept the original case as published. -- by :user:`melissa-kun-li`
189 * #2573: Fixed error in uploading a Sphinx doc with the :code:`upload_docs` command. An html builder will be used.
190 Note: :code:`upload_docs` is deprecated for PyPi, but is supported for other sites -- by :user:`melissa-kun-li`
199 * #1527: Removed bootstrap script. Now Setuptools requires pip or another pep517-compliant builder such as 'build' to build. Now Setuptools can be installed from Github main branch.
208 * #2537: Remove fallback support for fetch_build_eggs using easy_install. Now pip is required for setup_requires to succeed.
209 * #2544: Removed 'easy_install' top-level model (runpy entry point) and 'easy_install' console script.
210 * #2545: Removed support for eggsecutables.
214 * #2459: Tests now run in parallel via pytest-xdist, completing in about half the time. Special thanks to :user:`webknjaz` for hard work implementing test isolation. To run without parallelization, disable the plugin with ``tox -- -p no:xdist``.
223 * #2539: Fix AttributeError in Description validation.
232 * #1390: Validation of Description field now is more lenient, emitting a warning and mangling the value to be valid (replacing newlines with spaces).
241 * #2536: Reverted tag deduplication handling.
250 * #1390: Newlines in metadata description/Summary now trigger a ValueError.
251 * #2481: Define ``create_module()`` and ``exec_module()`` methods in ``VendorImporter``
252 to get rid of ``ImportWarning`` -- by :user:`hroncok`
253 * #2489: ``pkg_resources`` behavior for zipimport now matches the regular behavior, and finds
254 ``.egg-info`` (previoulsy would only find ``.dist-info``) -- by :user:`thatch`
255 * #2529: Fixed an issue where version tags may be added multiple times
264 * #2493: Use importlib.import_module() rather than the deprecated loader.load_module()
265 in pkg_resources namespace delaration -- by :user:`encukou`
267 Documentation changes
268 ^^^^^^^^^^^^^^^^^^^^^
269 * #2525: Fix typo in the document page about entry point. -- by :user:`jtr109`
273 * #2534: Avoid hitting network during test_easy_install.
282 * #2505: Disable inclusion of package data as it causes 'tests' to be included as data.
291 * #2534: Avoid hitting network during test_virtualenv.test_test_command.
300 * #2486: Project adopts jaraco/skeleton for shared package maintenance.
304 * #2477: Restore inclusion of rst files in sdist.
305 * #2484: Setuptools has replaced the master branch with the main branch.
306 * #2485: Fixed failing test when pip 20.3+ is present.
307 -- by :user:`yan12125`
308 * #2487: Fix tests with pytest 6.2
309 -- by :user:`yan12125`
318 * #2435: Require Python 3.6 or later.
320 Documentation changes
321 ^^^^^^^^^^^^^^^^^^^^^
322 * #2430: Fixed inconsistent RST title nesting levels caused by #2399
323 -- by :user:`webknjaz`
324 * #2430: Fixed a typo in Sphinx docs that made docs dev section disappear
325 as a result of PR #2426 -- by :user:`webknjaz`
329 * #2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils.
337 Documentation changes
338 ^^^^^^^^^^^^^^^^^^^^^
339 * #2394: Extended towncrier news template to include change note categories.
340 This allows to see what types of changes a given version introduces
341 -- by :user:`webknjaz`
342 * #2427: Started enforcing strict syntax and reference validation
343 in the Sphinx docs -- by :user:`webknjaz`
344 * #2428: Removed redundant Sphinx ``Makefile`` support -- by :user:`webknjaz`
348 * #2401: Enabled test results reporting in AppVeyor CI
349 -- by :user:`webknjaz`
350 * #2420: Replace Python 3.9.0 beta with 3.9.0 final on GitHub Actions.
351 * #2421: Python 3.9 Trove classifier got added to the dist metadata
352 -- by :user:`webknjaz`
360 Documentation changes
361 ^^^^^^^^^^^^^^^^^^^^^
362 * #2093: Finalized doc revamp.
363 * #2097: doc: simplify index and group deprecated files
364 * #2102: doc overhaul step 2: break main doc into multiple sections
365 * #2111: doc overhaul step 3: update userguide
366 * #2395: Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`
367 * #2395: Added an illustrative explanation about the change notes to fragments dir -- by :user:`webknjaz`
371 * #2379: Travis CI test suite now tests against PPC64.
372 * #2413: Suppress EOF errors (and other exceptions) when importing lib2to3.
382 * #2368: In distutils, restore support for monkeypatched CCompiler.spawn per pypa/distutils#15.
392 * #2355: When pip is imported as part of a build, leave distutils patched.
393 * #2380: There are some setuptools specific changes in the
394 ``setuptools.command.bdist_rpm`` module that are no longer needed, because
395 they are part of the ``bdist_rpm`` module in distutils in Python
396 3.5.0. Therefore, code was removed from ``setuptools.command.bdist_rpm``.
406 * #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.
416 * #2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils#9).
426 * #2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876.
436 * #2357: Restored Python 3.5 support in distutils.util for missing ``subprocess._optim_args_from_interpreter_flags``.
437 * #2358: Restored AIX support on Python 3.8 and earlier.
438 * #2361: Add Python 3.10 support to _distutils_hack. Get the 'Loader' abstract class
439 from importlib.abc rather than importlib.util.abc (alias removed in Python
450 * #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.
454 * #2334: In MSVC module, refine text in error message.
464 * #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.
474 * #2306: When running as a PEP 517 backend, setuptools does not try to install
475 ``setup_requires`` itself. They are reported as build requirements for the
486 * #2310: Updated vendored packaging version to 20.4.
494 Documentation changes
495 ^^^^^^^^^^^^^^^^^^^^^
496 * #2300: Improve the ``safe_version`` function documentation
500 * #2297: Once again, in stubs prefer exec_module to the deprecated load_module.
510 * #2316: Removed warning when ``distutils`` is imported before ``setuptools`` when ``distutils`` replacement is not enabled.
520 * #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.
530 * #2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn.
540 * #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.
550 * #2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state.
551 * #2249: Fix extension loading technique in stubs.
561 * #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.
571 * #2094: Removed pkg_resources.py2_warn module, which is no longer reachable.
581 * #2228: Applied fix for pypa/distutils#3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file.
591 * #2228: Disabled distutils adoption for now while emergent issues are addressed.
601 * #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.
605 * #2137: Removed (private) pkg_resources.RequirementParseError, now replaced by packaging.requirements.InvalidRequirement. Kept the name for compatibility, but users should catch InvalidRequirement instead.
606 * #2180: Update vendored packaging in pkg_resources to 19.2.
610 * #2199: Fix exception causes all over the codebase by using ``raise new_exception from old_exception``
620 * #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.
621 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)``.
631 * #2071: Replaced references to the deprecated imp package with references to importlib
641 * #1973: Removed ``pkg_resources.py31compat.makedirs`` in favor of the stdlib. Use ``os.makedirs()`` instead.
642 * #2198: Restore ``__requires__`` directive in easy-install wrapper scripts.
652 * #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.
656 * #2195: Fix broken entry points generated by easy-install (pip editable installs).
666 * #2194: Editable-installed entry points now load significantly faster on Python versions 3.8+.
667 * #1471: Incidentally fixed by #2194 on Python 3.8 or when importlib_metadata is present.
675 Documentation changes
676 ^^^^^^^^^^^^^^^^^^^^^
677 * #2156: Update mailing list pointer in developer docs
679 Incorporate changes from v44.1.1:
680 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
682 * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.
692 * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.
702 * #2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages.
712 * #2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should use ``setuptools<45``.
716 * #1700: Document all supported keywords by migrating the ones from distutils.
726 * #1753: ``attr:`` now extracts variables through rudimentary examination of the AST,
727 thereby supporting modules with third-party imports. If examining the AST
728 fails to find the variable, ``attr:`` falls back to the old behavior of
729 importing the module. Works on Python 3 only.
735 No significant changes.
745 * #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.
749 * #2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards.
750 * #2105: Filter ``2to3`` deprecation warnings from ``TestDevelop.test_2to3_user_mode``.
760 * #2040: Deprecated the ``bdist_wininst`` command. Binary packages should be built as wheels instead.
761 * #2062: Change 'Mac OS X' to 'macOS' in code.
762 * #2075: Stop recognizing files ending with ``.dist-info`` as distribution metadata.
763 * #2086: Deprecate 'use_2to3' functionality. Packagers are encouraged to use single-source solutions or build tool chains to manage conversions outside of setuptools.
765 Documentation changes
766 ^^^^^^^^^^^^^^^^^^^^^
767 * #1698: Added documentation for ``build_meta`` (a bare minimum, not completed).
771 * #2082: Filter ``lib2to3`` ``PendingDeprecationWarning`` and ``DeprecationWarning`` in tests,
772 because ``lib2to3`` is `deprecated in Python 3.9 <https://bugs.python.org/issue40360>`_.
778 No significant changes.
788 * #1458: Added template for reporting Python 2 incompatibilities.
794 No significant changes.
804 * #308: Allow version number normalization to be bypassed by wrapping in a 'setuptools.sic()' call.
805 * #1424: Prevent keeping files mode for package_data build. It may break a build if user's package data has read only flag.
806 * #1431: In ``easy_install.check_site_dir``, ensure the installation directory exists.
807 * #1563: In ``pkg_resources`` prefer ``find_spec`` (PEP 451) to ``find_module``.
809 Incorporate changes from v44.1.0:
810 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
812 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
813 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
814 * #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.
824 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
825 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
826 * #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.
836 * #65: Once again as in 3.0, removed the Features feature.
840 * #1890: Fix vendored dependencies so importing ``setuptools.extern.some_module`` gives the same object as ``setuptools._vendor.some_module``. This makes Metadata picklable again.
841 * #1899: Test suite now fails on warnings.
843 Documentation changes
844 ^^^^^^^^^^^^^^^^^^^^^
845 * #2011: Fix broken link to distutils docs on package_data
849 * #1991: Include pkg_resources test data in sdist, so tests can be executed from it.
859 * #1557: Deprecated eggsecutable scripts and updated docs.
860 * #1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+
870 * #1905: Fixed defect in _imp, introduced in 41.6.0 when the 'tests' directory is not present.
871 * #1941: Improve editable installs with PEP 518 build isolation:
873 * The ``--user`` option is now always available. A warning is issued if the user site directory is not available.
874 * The error shown when the install directory is not in ``PYTHONPATH`` has been turned into a warning.
875 * #1981: Setuptools now declares its ``tests`` and ``docs`` dependencies in metadata (extras).
876 * #1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9).
880 * #1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info.
890 * #1458: Add minimum sunset date and preamble to Python 2 warning.
891 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
892 * #1974: Add Python 3 Only Trove Classifier and remove universal wheel declaration for more complete transition from Python 2.
902 * #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.
906 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
916 * #1908: Drop support for Python 3.4.
926 * #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.
930 * #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.
939 * #1921: Fix support for easy_install's ``find-links`` option in ``setup.cfg``.
940 * #1922: Build dependencies (setup_requires and tests_require) now install transitive dependencies indicated by extras.
950 * #1918: Fix regression in handling wheels compatibility tags.
960 * #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:
961 * support for ``python_requires``
962 * better support for wheels (proper handling of priority with respect to PEP 425 tags)
963 * PEP 517/518 support
964 * eggs are not supported
965 * no support for the ``allow_hosts`` easy_install option (``index_url``/``find_links`` are still honored)
966 * pip environment variables are honored (and take precedence over easy_install options)
967 * #1898: Removed the "upload" and "register" commands in favor of `twine <https://pypi.org/p/twine>`_.
971 * #1767: Add support for the ``license_files`` option in ``setup.cfg`` to automatically
972 include multiple license files in a source distribution.
973 * #1829: Update handling of wheels compatibility tags:
974 * add support for manylinux2010
975 * fix use of removed 'm' ABI flag in Python 3.8 on Windows
976 * #1861: Fix empty namespace package installation from wheel.
977 * #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.
987 * #479: Replace usage of deprecated ``imp`` module with local re-implementation in ``setuptools._imp``.
997 * #1891: Fix code for detecting Visual Studio's version on Windows under Python 2.
1007 * #1811: Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019.
1008 * #1814: Fix ``pkg_resources.Requirement`` hash/equality implementation: take PEP 508 direct URL into account.
1009 * #1824: Fix tests when running under ``python3.10``.
1010 * #1878: Formally deprecated the ``test`` command, with the recommendation that users migrate to ``tox``.
1012 Documentation changes
1013 ^^^^^^^^^^^^^^^^^^^^^
1014 * #1860: Update documentation to mention the egg format is not supported by pip and dependency links support was dropped starting with pip 19.0.
1015 * #1862: Drop ez_setup documentation: deprecated for some time (last updated in 2016), and still relying on easy_install (deprecated too).
1016 * #1868: Drop most documentation references to (deprecated) EasyInstall.
1017 * #1884: Added a trove classifier to document support for Python 3.8.
1021 * #1886: Added Python 3.8 release to the Travis test matrix.
1031 * #1847: In declarative config, now traps errors when invalid ``python_requires`` values are supplied.
1041 * #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+.
1045 * #1858: Fixed failing integration test triggered by 'long_description_content_type' in packaging.
1055 * #479: Remove some usage of the deprecated ``imp`` module.
1059 * #1565: Changed html_sidebars from string to list of string as per
1060 https://www.sphinx-doc.org/en/master/changes.html#id58
1070 * #1697: Moved most of the constants from setup.py to setup.cfg
1071 * #1749: Fixed issue with the PEP 517 backend where building a source distribution would fail if any tarball existed in the destination directory.
1072 * #1750: Fixed an issue with PEP 517 backend where wheel builds would fail if the destination directory did not already exist.
1073 * #1756: Force metadata-version >= 1.2. when project urls are present.
1074 * #1769: Improve ``package_data`` check: ensure the dictionary values are lists/tuples of strings.
1075 * #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.
1076 * #1790: Added the file path to the error message when a ``UnicodeDecodeError`` occurs while reading a metadata file.
1078 Documentation changes
1079 ^^^^^^^^^^^^^^^^^^^^^
1080 * #1776: Use license classifiers rather than the license field.
1090 * #1671: Fixed issue with the PEP 517 backend that prevented building a wheel when the ``dist/`` directory contained existing ``.whl`` files.
1091 * #1709: In test.paths_on_python_path, avoid adding unnecessary duplicates to the PYTHONPATH.
1092 * #1741: In package_index, now honor "current directory" during a checkout of git and hg repositories under Windows
1102 * #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.
1112 * #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.
1113 * #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.
1114 * #1664: Added the path to the ``PKG-INFO`` or ``METADATA`` file in the exception
1115 text when the ``Version:`` header can't be found.
1117 Documentation changes
1118 ^^^^^^^^^^^^^^^^^^^^^
1119 * #1705: Removed some placeholder documentation sections referring to deprecated features.
1129 * #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``.
1130 * #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.
1131 * #1536: ``setuptools`` will now automatically include licenses if ``setup.cfg`` contains a ``license_file`` attribute, unless this file is manually excluded inside ``MANIFEST.in``.
1141 * #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.
1151 * #1666: Restore port in URL handling in package_index.
1161 * #1660: On Python 2, when reading config files, downcast options from text to bytes to satisfy distutils expectations.
1171 * #1551: File inputs for the ``license`` field in ``setup.cfg`` files now explicitly raise an error.
1175 * #1180: Add support for non-ASCII in setup.cfg (#1062). Add support for native strings on some parameters (#1136).
1176 * #1499: ``setuptools.package_index`` no longer relies on the deprecated ``urllib.parse.splituser`` per Python #27485.
1177 * #1544: Added tests for PackageIndex.download (for git URLs).
1178 * #1625: In PEP 517 build_meta builder, ensure that sdists are built as gztar per the spec.
1188 * #1594: PEP 517 backend no longer declares setuptools as a dependency as it can be assumed.
1198 * #1592: Fix invalid dependency on external six module (instead of vendored version).
1208 * #1590: Fixed regression where packages without ``author`` or ``author_email`` fields generated malformed package metadata.
1218 * #1541: Officially deprecated the ``requires`` parameter in ``setup()``.
1222 * #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.
1223 * #1545: Changed the warning class of all deprecation warnings; deprecation warning classes are no longer derived from ``DeprecationWarning`` and are thus visible by default.
1224 * #1554: ``build_meta.build_sdist`` now includes ``setup.py`` in source distributions by default.
1225 * #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.
1227 Documentation changes
1228 ^^^^^^^^^^^^^^^^^^^^^
1229 * #1395: Changed Pyrex references to Cython in the documentation.
1230 * #1456: Documented that the ``rpmbuild`` packages is required for the ``bdist_rpm`` command.
1231 * #1537: Documented how to use ``setup.cfg`` for ``src/ layouts``
1232 * #1539: Added minimum version column in ``setup.cfg`` metadata table.
1233 * #1552: Fixed a minor typo in the python 2/3 compatibility documentation.
1234 * #1553: Updated installation instructions to point to ``pip install`` instead of ``ez_setup.py``.
1235 * #1560: Updated ``setuptools`` distribution documentation to remove some outdated information.
1236 * #1564: Documented ``setup.cfg`` minimum version for version and project_urls.
1240 * #1533: Restricted the ``recursive-include setuptools/_vendor`` to contain only .py and .txt files.
1241 * #1572: Added the ``concurrent.futures`` backport ``futures`` to the Python 2.7 test suite requirements.
1251 * #1335: In ``pkg_resources.normalize_path``, fix issue on Cygwin when cwd contains symlinks.
1252 * #1502: Deprecated support for downloads from Subversion in package_index/easy_install.
1253 * #1517: Dropped use of six.u in favor of ``u""`` literals.
1254 * #1520: Added support for ``data_files`` in ``setup.cfg``.
1256 Documentation changes
1257 ^^^^^^^^^^^^^^^^^^^^^
1258 * #1525: Fixed rendering of the deprecation warning in easy_install doc.
1268 * #1480: Bump vendored pyparsing in pkg_resources to 2.2.1.
1278 * #1497: Updated gitignore in repo.
1288 * #1480: Bump vendored pyparsing to 2.2.1.
1298 * #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).
1308 * #1402: Fixed a bug with namespace packages under Python 3.6 when one package in
1309 current directory hides another which is installed.
1310 * #1427: Set timestamp of ``.egg-info`` directory whenever ``egg_info`` command is run.
1311 * #1474: ``build_meta.get_requires_for_build_sdist`` now does not include the ``wheel`` package anymore.
1312 * #1486: Suppress warnings in pkg_resources.handle_ns.
1316 * #1479: Remove internal use of six.binary_type.
1326 * #1466: Fix handling of Unicode arguments in PEP 517 backend
1336 * #1465: Fix regression with ``egg_info`` command when tagging is used.
1346 * #1410: Deprecated ``upload`` and ``register`` commands.
1347 * #1312: Introduced find_namespace_packages() to find PEP 420 namespace packages.
1348 * #1420: Added find_namespace: directive to config parser.
1349 * #1418: Solved race in when creating egg cache directories.
1350 * #1450: Upgraded vendored PyParsing from 2.1.10 to 2.2.0.
1351 * #1451: Upgraded vendored appdirs from 1.4.0 to 1.4.3.
1352 * #1388: Fixed "Microsoft Visual C++ Build Tools" link in exception when Visual C++ not found.
1353 * #1389: Added support for scripts which have unicode content.
1354 * #1416: Moved several Python version checks over to using ``six.PY2`` and ``six.PY3``.
1358 * #1441: Removed spurious executable permissions from files that don't need them.
1368 * #1342: Drop support for Python 3.3.
1372 * #1366: In package_index, fixed handling of encoded entities in URLs.
1373 * #1383: In pkg_resources VendorImporter, avoid removing packages imported from the root.
1375 Documentation changes
1376 ^^^^^^^^^^^^^^^^^^^^^
1377 * #1379: Minor doc fixes after actually using the new release process.
1378 * #1385: Removed section on non-package data files.
1379 * #1403: Fix developer's guide.
1383 * #1404: Fix PEP 518 configuration: set build requirements in ``pyproject.toml`` to ``["wheel"]``.
1393 * #1359: Support using "file:" to load a PEP 440-compliant package version from
1395 * #1360: Fixed issue with a mismatch between the name of the package and the
1396 name of the .dist-info file in wheel files
1397 * #1364: Add ``__dir__()`` implementation to ``pkg_resources.Distribution()`` that
1398 includes the attributes in the ``_provider`` instance variable.
1399 * #1365: Take the package_dir option into account when loading the version from
1402 Documentation changes
1403 ^^^^^^^^^^^^^^^^^^^^^
1404 * #1353: Added coverage badge to README.
1405 * #1356: Made small fixes to the developer guide documentation.
1406 * #1357: Fixed warnings in documentation builds and started enforcing that the
1407 docs build without warnings in tox.
1408 * #1376: Updated release process docs.
1412 * #1343: The ``setuptools`` specific ``long_description_content_type``,
1413 ``project_urls`` and ``provides_extras`` fields are now set consistently
1414 after any ``distutils`` ``setup_keywords`` calls, allowing them to override
1416 * #1352: Added ``tox`` environment for documentation builds.
1417 * #1354: Added ``towncrier`` for changelog management.
1418 * #1355: Add PR template.
1419 * #1368: Fixed tests which failed without network connectivity.
1420 * #1369: Added unit tests for PEP 425 compatibility tags support.
1421 * #1372: Stop testing Python 3.3 in Travis CI, now that the latest version of
1422 ``wheel`` no longer installs on it.
1427 * #1340: Update all PyPI URLs to reflect the switch to the
1428 new Warehouse codebase.
1429 * #1337: In ``pkg_resources``, now support loading resources
1430 for modules loaded by the ``SourcelessFileLoader``.
1431 * #1332: Silence spurious wheel related warnings on Windows.
1436 * #1297: Restore Unicode handling for Maintainer fields in
1442 * #1296: Setuptools now vendors its own direct dependencies, no
1443 longer relying on the dependencies as vendored by pkg_resources.
1445 * #296: Removed long-deprecated support for iteration on
1446 Version objects as returned by ``pkg_resources.parse_version``.
1447 Removed the ``SetuptoolsVersion`` and
1448 ``SetuptoolsLegacyVersion`` names as well. They should not
1449 have been used, but if they were, replace with
1450 ``Version`` and ``LegacyVersion`` from ``packaging.version``.
1455 * #1288: Add support for maintainer in PKG-INFO.
1460 * #1292: Avoid generating ``Provides-Extra`` in metadata when
1461 no extra is present (but environment markers are).
1466 * #1286: Add support for Metadata 2.1 (PEP 566).
1471 * #1285: Fixed RuntimeError in pkg_resources.parse_requirements
1472 on Python 3.7 (stemming from PEP 479).
1477 * #1271: Revert to Cython legacy ``build_ext`` behavior for
1483 * #1229: Expand imports in ``build_ext`` to refine detection of
1484 Cython availability.
1486 * #1270: When Cython is available, ``build_ext`` now uses the
1492 * #1257: In bdist_egg.scan_module, fix ValueError on Python 3.7.
1497 * #1231: Removed warning when PYTHONDONTWRITEBYTECODE is enabled.
1502 * #1210: Add support for PEP 345 Project-URL metadata.
1503 * #1207: Add support for ``long_description_type`` to setup.cfg
1504 declarative config as intended and documented.
1509 * #1232: Fix trailing slash handling in ``pkg_resources.ZipProvider``.
1514 * #1220: Fix ``data_files`` handling when installing from wheel.
1519 * fix Travis' Python 3.3 job.
1524 * #1214: fix handling of namespace packages when installing
1530 * #1212: fix encoding handling of metadata when installing
1536 * #1200: easy_install now support installing from wheels:
1537 they will be installed as standalone unzipped eggs.
1542 * #1208: Improve error message when failing to locate scripts
1543 in egg-info metadata.
1548 * #458: In order to support deterministic builds, Setuptools no
1549 longer allows packages to declare ``install_requires`` as
1550 unordered sequences (sets or dicts).
1555 * #878: Drop support for Python 2.6. Python 2.6 users should
1556 rely on 'setuptools < 37dev'.
1561 * #1190: In SSL support for package index operations, use SNI
1567 * #1175: Bug fixes to ``build_meta`` module.
1572 * #701: Fixed duplicate test discovery on Python 3.
1577 * #1193: Avoid test failures in bdist_egg when
1578 PYTHONDONTWRITEBYTECODE is set.
1583 * #1054: Support ``setup_requires`` in ``setup.cfg`` files.
1588 * #1132: Removed redundant and costly serialization/parsing step
1589 in ``EntryPoint.__init__``.
1591 * #844: ``bdist_egg --exclude-source-files`` now tested and works
1597 * #1143: Added ``setuptools.build_meta`` module, an implementation
1598 of PEP-517 for Setuptools-defined packages.
1600 * #1143: Added ``dist_info`` command for producing dist_info
1606 * #170: When working with Mercurial checkouts, use Windows-friendly
1607 syntax for suppressing output.
1609 * Inspired by #1134, performed substantial refactoring of
1610 ``pkg_resources.find_on_path`` to facilitate an optimization
1611 for paths with many non-version entries.
1616 * #1075: Add new ``Description-Content-Type`` metadata field. `See here for
1617 documentation on how to use this field.
1618 <https://packaging.python.org/specifications/#description-content-type>`_
1620 * #1068: Sort files and directories when building eggs for
1621 deterministic order.
1623 * #196: Remove caching of easy_install command in fetch_build_egg.
1624 Fixes issue where ``pytest-runner-N.N`` would satisfy the installation
1627 * #1129: Fix working set dependencies handling when replacing conflicting
1628 distributions (e.g. when using ``setup_requires`` with a conflicting
1629 transitive dependency, fix #1124).
1631 * #1133: Improved handling of README files extensions and added
1632 Markdown to the list of searched READMES.
1634 * #1135: Improve performance of pkg_resources import by not invoking
1635 ``access`` or ``stat`` and using ``os.listdir`` instead.
1640 * #1131: Make possible using several files within ``file:`` directive
1641 in metadata.long_description in ``setup.cfg``.
1646 * fix #1105: Fix handling of requirements with environment
1647 markers when declared in ``setup.cfg`` (same treatment as
1653 * #462: Don't assume a directory is an egg by the ``.egg``
1659 * #1093: Fix test command handler with extras_require.
1660 * #1112, #1091, #1115: Now using Trusty containers in
1661 Travis for CI and CD.
1666 * #1092: ``pkg_resources`` now uses ``inspect.getmro`` to
1667 resolve classes in method resolution order.
1672 * #1102: Restore behavior for empty extras.
1677 * #1099: Revert commit a3ec721, restoring intended purpose of
1678 extras as part of a requirement declaration.
1685 * support extras specifiers in install_requires requirements
1690 * #1081: Environment markers indicated in ``install_requires``
1691 are now processed and treated as nameless ``extras_require``
1692 with markers, allowing their metadata in requires.txt to be
1693 correctly generated.
1695 * #1053: Tagged commits are now released using Travis-CI
1696 build stages, meaning releases depend on passing tests on
1697 all supported Python versions (Linux) and not just the latest
1703 * #1083: Correct ``py31compat.makedirs`` to correctly honor
1704 ``exist_ok`` parameter.
1705 * #1083: Also use makedirs compatibility throughout setuptools.
1710 * #1083: Avoid race condition on directory creation in
1711 ``pkg_resources.ensure_directory``.
1713 * Removed deprecation of and restored support for
1714 ``upload_docs`` command for sites other than PyPI.
1715 Only warehouse is dropping support, but services like
1716 `devpi <http://doc.devpi.net/latest/>`_ continue to
1717 support docs built by setuptools' plugins. See
1718 `this comment <https://bitbucket.org/hpk42/devpi/issues/388/support-rtd-model-for-building-uploading#comment-34292423>`_
1719 for more context on the motivation for this change.
1724 * #1042: Fix import in py27compat module that still
1725 referenced six directly, rather than through the externs
1726 module (vendored packages hook).
1731 * #980 and others: Once again, Setuptools vendors all
1732 of its dependencies. It seems to be the case that in
1733 the Python ecosystem, all build tools must run without
1734 any dependencies (build, runtime, or otherwise). At
1735 such a point that a mechanism exists that allows
1736 build tools to have dependencies, Setuptools will adopt
1742 * #1015: Fix test failures on Python 3.7.
1744 * #1024: Add workaround for Jython #2581 in monkey module.
1749 * #992: Revert change introduced in v34.4.1, now
1752 * #1016: Revert change introduced in v35.0.0 per #1014,
1753 referencing #436. The approach had unintended
1754 consequences, causing sdist installs to be missing
1760 * #436: In egg_info.manifest_maker, no longer read
1761 the file list from the manifest file, and instead
1762 re-build it on each build. In this way, files removed
1763 from the specification will not linger in the manifest.
1764 As a result, any files manually added to the manifest
1765 will be removed on subsequent egg_info invocations.
1766 No projects should be manually adding files to the
1767 manifest and should instead use MANIFEST.in or SCM
1768 file finders to force inclusion of files in the manifest.
1773 * #1008: In MSVC support, use always the last version available for Windows SDK and UCRT SDK.
1775 * #1008: In MSVC support, fix "vcruntime140.dll" returned path with Visual Studio 2017.
1777 * #992: In msvc.msvc9_query_vcvarsall, ensure the
1778 returned dicts have str values and not Unicode for
1779 compatibility with os.environ.
1784 * #995: In MSVC support, add support for "Microsoft Visual Studio 2017" and "Microsoft Visual Studio Build Tools 2017".
1786 * #999 via #1007: Extend support for declarative package
1787 config in a setup.cfg file to include the options
1788 ``python_requires`` and ``py_modules``.
1793 * #967 (and #997): Explicitly import submodules of
1794 packaging to account for environments where the imports
1795 of those submodules is not implied by other behavior.
1800 * #993: Fix documentation upload by correcting
1801 rendering of content-type in _build_multipart
1807 * #988: Trap ``os.unlink`` same as ``os.remove`` in
1808 ``auto_chmod`` error handler.
1810 * #983: Fixes to invalid escape sequence deprecations on
1816 * #941: In the upload command, if the username is blank,
1817 default to ``getpass.getuser()``.
1819 * #971: Correct distutils findall monkeypatch to match
1820 appropriate versions (namely Python 3.4.6).
1825 * #966: Add support for reading dist-info metadata and
1826 thus locating Distributions from zip files.
1828 * #968: Allow '+' and '!' in egg fragments
1829 so that it can take package names that contain
1830 PEP 440 conforming version specifiers.
1835 * #953: More aggressively employ the compatibility issue
1836 originally added in #706.
1841 * #930: ``build_info`` now accepts two new parameters
1842 to optimize and customize the building of C libraries.
1847 * #947: Loosen restriction on the version of six required,
1848 restoring compatibility with environments relying on
1849 six 1.6.0 and later.
1854 * #882: Ensure extras are honored when building the
1856 * #913: Fix issue in develop if package directory has
1862 * #935: Fix glob syntax in graft.
1867 * #581: Instead of vendoring the growing list of
1868 dependencies that Setuptools requires to function,
1869 Setuptools now requires these dependencies just like
1870 any other project. Unlike other projects, however,
1871 Setuptools cannot rely on ``setup_requires`` to
1872 demand the dependencies it needs to install because
1873 its own machinery would be necessary to pull those
1874 dependencies if not present (a bootstrapping problem).
1875 As a result, Setuptools no longer supports self upgrade or
1876 installation in the general case. Instead, users are
1877 directed to use pip to install and upgrade using the
1878 ``wheel`` distributions of setuptools.
1880 Users are welcome to contrive other means to install
1881 or upgrade Setuptools using other means, such as
1882 pre-installing the Setuptools dependencies with pip
1883 or a bespoke bootstrap tool, but such usage is not
1884 recommended and is not supported.
1886 As discovered in #940, not all versions of pip will
1887 successfully install Setuptools from its pre-built
1888 wheel. If you encounter issues with "No module named
1889 six" or "No module named packaging", especially
1890 following a line "Running setup.py egg_info for package
1891 setuptools", then your pip is not new enough.
1893 There's an additional issue in pip where setuptools
1894 is upgraded concurrently with other source packages,
1895 described in pip #4253. The proposed workaround is to
1896 always upgrade Setuptools first prior to upgrading
1897 other packages that would upgrade Setuptools.
1902 * #921: Correct issue where certifi fallback not being
1908 Installation via pip, as indicated in the `Python Packaging
1909 User's Guide <https://packaging.python.org/installing/>`_,
1910 is the officially-supported mechanism for installing
1911 Setuptools, and this recommendation is now explicit in the
1912 much more concise README.
1914 Other edits and tweaks were made to the documentation. The
1915 codebase is unchanged.
1920 * #619: Removed support for the ``tag_svn_revision``
1921 distribution option. If Subversion tagging support is
1922 still desired, consider adding the functionality to
1923 setuptools_svn in setuptools_svn #2.
1928 * #866: Use ``dis.Bytecode`` on Python 3.4 and later in
1929 ``setuptools.depends``.
1934 * #889: Backport proposed fix for disabling interpolation in
1935 distutils.Distribution.parse_config_files.
1940 * #884: Restore support for running the tests under
1941 `pytest-runner <https://github.com/pytest-dev/pytest-runner>`_
1942 by ensuring that PYTHONPATH is honored in tests invoking
1948 * #706: Add rmtree compatibility shim for environments where
1949 rmtree fails when passed a unicode string.
1954 * #893: Only release sdist in zip format as warehouse now
1955 disallows releasing two different formats.
1960 * #704: More selectively ensure that 'rmtree' is not invoked with
1961 a byte string, enabling it to remove files that are non-ascii,
1964 * #712: In 'sandbox.run_setup', ensure that ``__file__`` is
1965 always a ``str``, modeling the behavior observed by the
1966 interpreter when invoking scripts and modules.
1971 * #891: In 'test' command on test failure, raise DistutilsError,
1972 suppression invocation of subsequent commands.
1977 * #890: Revert #849. ``global-exclude .foo`` will not match all
1978 ``*.foo`` files any more. Package authors must add an explicit
1979 wildcard, such as ``global-exclude *.foo``, to match all
1980 ``.foo`` files. See #886, #849.
1985 * #885: Fix regression where 'pkg_resources._rebuild_mod_path'
1986 would fail when a namespace package's '__path__' was not
1987 a list with a sort attribute.
1992 * #250: Install '-nspkg.pth' files for packages installed
1993 with 'setup.py develop'. These .pth files allow
1994 namespace packages installed by pip or develop to
1995 co-mingle. This change required the removal of the
1996 change for #805 and pip #1924, introduced in 28.3.0 and implicated
1997 in #870, but means that namespace packages not in a
1998 site packages directory will no longer work on Python
1999 earlier than 3.5, whereas before they would work on
2000 Python not earlier than 3.3.
2005 * #879: For declarative config:
2007 - 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.
2009 - packages find: directive now supports fine tuning from a subsection. The same arguments as for find() are accepted.
2014 * #394 via #862: Added support for `declarative package
2015 config in a setup.cfg file
2016 <https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files>`_.
2021 * #850: In test command, invoke unittest.main with
2022 indication not to exit the process.
2027 * #854: Bump to vendored Packaging 16.8.
2032 * #846: Also trap 'socket.error' when opening URLs in
2035 * #849: Manifest processing now matches the filename
2036 pattern anywhere in the filename and not just at the
2037 start. Restores behavior found prior to 28.5.0.
2042 * #864: Drop support for Python 3.2. Systems requiring
2043 Python 3.2 support must use 'setuptools < 30'.
2045 * #825: Suppress warnings for single files.
2047 * #830 via #843: Once again restored inclusion of data
2048 files to sdists, but now trap TypeError caused by
2049 techniques employed rjsmin and similar.
2054 * #861: Re-release of v29.0.1 with the executable script
2055 launchers bundled. Now, launchers are included by default
2056 and users that want to disable this behavior must set the
2057 environment variable
2058 'SETUPTOOLS_INSTALL_WINDOWS_SPECIFIC_FILES' to
2059 a false value like "false" or "0".
2064 * #841: Drop special exception for packages invoking
2065 win32com during the build/install process. See
2066 Distribute #118 for history.
2071 * #629: Per the discussion, refine the sorting to use version
2072 value order for more accurate detection of the latest
2073 available version when scanning for packages. See also
2076 * #837: Rely on the config var "SO" for Python 3.3.0 only
2077 when determining the ext filename.
2082 * #827: Update PyPI root for dependency links.
2084 * #833: Backed out changes from #830 as the implementation
2085 seems to have problems in some cases.
2090 * #832: Moved much of the namespace package handling
2091 functionality into a separate module for re-use in something
2093 * #830: ``sdist`` command no longer suppresses the inclusion
2094 of data files, re-aligning with the expectation of distutils
2095 and addressing #274 and #521.
2100 * #816: Fix manifest file list order in tests.
2105 * #629: When scanning for packages, ``pkg_resources`` now
2106 ignores empty egg-info directories and gives precedence to
2107 packages whose versions are lexicographically greatest,
2108 a rough approximation for preferring the latest available
2114 * #810: Tests are now invoked with tox and not setup.py test.
2115 * #249 and #450 via #764: Avoid scanning the whole tree
2116 when building the manifest. Also fixes a long-standing bug
2117 where patterns in ``MANIFEST.in`` had implicit wildcard
2118 matching. This caused ``global-exclude .foo`` to exclude
2119 all ``*.foo`` files, but also ``global-exclude bar.py`` to
2120 exclude ``foo_bar.py``.
2125 * #732: Now extras with a hyphen are honored per PEP 426.
2126 * #811: Update to pyparsing 2.1.10.
2127 * Updated ``setuptools.command.sdist`` to re-use most of
2128 the functionality directly from ``distutils.command.sdist``
2129 for the ``add_defaults`` method with strategic overrides.
2130 See #750 for rationale.
2131 * #760 via #762: Look for certificate bundle where SUSE
2132 Linux typically presents it. Use ``certifi.where()`` to locate
2138 * #809: In ``find_packages()``, restore support for excluding
2139 a parent package without excluding a child package.
2141 * #805: Disable ``-nspkg.pth`` behavior on Python 3.3+ where
2142 PEP-420 functionality is adequate. Fixes pip #1924.
2147 * #803: Bump certifi to 2016.9.26.
2152 * #733: Do not search excluded directories for packages.
2153 This introduced a backwards incompatible change in ``find_packages()``
2154 so that ``find_packages(exclude=['foo']) == []``, excluding subpackages of ``foo``.
2155 Previously, ``find_packages(exclude=['foo']) == ['foo.bar']``,
2156 even though the parent ``foo`` package was excluded.
2158 * #795: Bump certifi.
2160 * #719: Suppress decoding errors and instead log a warning
2161 when metadata cannot be decoded.
2166 * #790: In MSVC monkeypatching, explicitly patch each
2167 function by name in the target module instead of inferring
2168 the module from the function's ``__module__``. Improves
2169 compatibility with other packages that might have previously
2170 patched distutils functions (i.e. NumPy).
2175 * #794: In test command, add installed eggs to PYTHONPATH
2176 when invoking tests so that subprocesses will also have the
2177 dependencies available. Fixes `tox 330
2178 <https://github.com/tox-dev/tox/issues/330>`_.
2180 * #795: Update vendored pyparsing 2.1.9.
2185 * #520 and #513: Suppress ValueErrors in fixup_namespace_packages
2188 * Nicer, more consistent interfaces for msvc monkeypatching.
2193 * #779 via #781: Fix circular import.
2198 * #778: Fix MSVC monkeypatching.
2203 * Introduce the (private) ``monkey`` module to encapsulate
2204 the distutils monkeypatching behavior.
2209 * Now use Warehouse by default for
2210 ``upload``, patching ``distutils.config.PyPIRCCommand`` to
2211 affect default behavior.
2213 Any config in .pypirc should be updated to replace
2215 https://pypi.python.org/pypi/
2219 https://upload.pypi.org/legacy/
2221 Similarly, any passwords stored in the keyring should be
2222 updated to use this new value for "system".
2224 The ``upload_docs`` command will continue to use the python.org
2225 site, but the command is now deprecated. Users are urged to use
2226 Read The Docs instead.
2228 * #776: Use EXT_SUFFIX for py_limited_api renaming.
2230 * #774 and #775: Use LegacyVersion from packaging when
2231 detecting numpy versions.
2236 * Re-release of 26.1.0 with pytest pinned to allow for automated
2237 deployment and thus proper packaging environment variables,
2238 fixing issues with missing executable launchers.
2243 * #763: ``pkg_resources.get_default_cache`` now defers to the
2244 `appdirs project <https://pypi.org/project/appdirs>`_ to
2245 resolve the cache directory. Adds a vendored dependency on
2246 appdirs to pkg_resources.
2251 * #748: By default, sdists are now produced in gzipped tarfile
2252 format by default on all platforms, adding forward compatibility
2253 for the same behavior in Python 3.6 (See Python #27819).
2255 * #459 via #736: On Windows with script launchers,
2256 sys.argv[0] now reflects
2257 the name of the entry point, consistent with the behavior in
2258 distlib and pip wrappers.
2260 * #752 via #753: When indicating ``py_limited_api`` to Extension,
2261 it must be passed as a keyword argument.
2266 * Add Extension(py_limited_api=True). When set to a truthy value,
2267 that extension gets a filename appropriate for code using Py_LIMITED_API.
2268 When used correctly this allows a single compiled extension to work on
2269 all future versions of CPython 3.
2270 The py_limited_api argument only controls the filename. To be
2271 compatible with multiple versions of Python 3, the C extension
2272 will also need to set -DPy_LIMITED_API=... and be modified to use
2273 only the functions in the limited API.
2278 * #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).
2280 * #731: Bump certifi.
2282 * Style updates. See #740, #741, #743, #744, #742, #747.
2284 * #735: include license file.
2289 * #612 via #730: Add a LICENSE file which needs to be provided by the terms of
2295 * #725: revert ``library_dir_option`` patch (Error is related to ``numpy.distutils`` and make errors on non Numpy users).
2301 * #723: Improve patch for ``library_dir_option``.
2308 * #707: Fix Python 2 compatibility for MSVC by catching errors properly.
2309 * #715: Fix unquoted libpaths by patching ``library_dir_option``.
2314 * #714 and #704: Revert fix as it breaks other components
2315 downstream that can't handle unicode. See #709, #710,
2321 * #704: Fix errors when installing a zip sdist that contained
2322 files named with non-ascii characters on Windows would
2323 crash the install when it attempted to clean up the build.
2324 * #646: MSVC compatibility - catch errors properly in
2325 RegistryInfo.lookup.
2326 * #702: Prevent UnboundLocalError when initial working_set
2332 * #686: Fix issue in sys.path ordering by pkg_resources when
2333 rewrite technique is "raw".
2334 * #699: Fix typo in msvc support.
2339 * #609: Setuptools will now try to download a distribution from
2340 the next possible download location if the first download fails.
2341 This means you can now specify multiple links as ``dependency_links``
2342 and all links will be tried until a working download link is encountered.
2347 * #688: Fix AttributeError in setup.py when invoked not from
2348 the current directory.
2353 * Cleanup of setup.py script.
2355 * Fixed documentation builders by allowing setup.py
2356 to be imported without having bootstrapped the
2359 * More style cleanup. See #677, #678, #679, #681, #685.
2364 * #674: Default ``sys.path`` manipulation by easy-install.pth
2365 is now "raw", meaning that when writing easy-install.pth
2366 during any install operation, the ``sys.path`` will not be
2367 rewritten and will no longer give preference to easy_installed
2370 To retain the old behavior when using any easy_install
2371 operation (including ``setup.py install`` when setuptools is
2372 present), set the environment variable:
2374 SETUPTOOLS_SYS_PATH_TECHNIQUE=rewrite
2376 This project hopes that that few if any environments find it
2377 necessary to retain the old behavior, and intends to drop
2378 support for it altogether in a future release. Please report
2379 any relevant concerns in the ticket for this change.
2384 * #398: Fix shebang handling on Windows in script
2385 headers where spaces in ``sys.executable`` would
2386 produce an improperly-formatted shebang header,
2387 introduced in 12.0 with the fix for #188.
2389 * #663, #670: More style updates.
2394 * #516: Disable ``os.link`` to avoid hard linking
2395 in ``sdist.make_distribution``, avoiding errors on
2396 systems that support hard links but not on the
2397 file system in which the build is occurring.
2402 * #667: Update Metadata-Version to 1.2 when
2403 ``python_requires`` is supplied.
2408 * #631: Add support for ``python_requires`` keyword.
2413 * More style updates. See #660, #661, #641.
2418 * #659: ``setup.py`` now will fail fast and with a helpful
2419 error message when the necessary metadata is missing.
2420 * More style updates. See #656, #635, #640,
2421 #644, #650, #652, and #655.
2426 * Updated style in much of the codebase to match
2427 community expectations. See #632, #633, #634,
2428 #637, #639, #638, #642, #648.
2433 * If MSVC++14 is needed ``setuptools.msvc`` now redirect
2434 user to Visual C++ Build Tools web page.
2439 * #625 and #626: Fixes on ``setuptools.msvc`` mainly
2440 for Python 2 and Linux.
2445 * Pull Request #174: Add more aggressive support for
2446 standalone Microsoft Visual C++ compilers in
2447 msvc9compiler patch.
2448 Particularly : Windows SDK 6.1 and 7.0
2449 (MSVC++ 9.0), Windows SDK 7.1 (MSVC++ 10.0),
2450 Visual C++ Build Tools 2015 (MSVC++14)
2451 * Renamed ``setuptools.msvc9_support`` to
2452 ``setuptools.msvc``.
2457 Re-release of v23.2.0, which was missing the intended
2460 * #623: Remove used of deprecated 'U' flag when reading
2466 * #619: Deprecated ``tag_svn_revision`` distribution
2472 * #611: Removed ARM executables for CLI and GUI script
2473 launchers on Windows. If this was a feature you cared
2474 about, please comment in the ticket.
2475 * #604: Removed docs building support. The project
2476 now relies on documentation hosted at
2477 https://setuptools.readthedocs.io/.
2482 * #604: Restore repository for upload_docs command
2483 to restore publishing of docs during release.
2488 * #589: Upload releases to pypi.io using the upload
2489 hostname and legacy path.
2494 * #589: Releases are now uploaded to pypi.io (Warehouse)
2495 even when releases are made on Twine via Travis.
2500 * #589: Releases are now uploaded to pypi.io (Warehouse).
2505 * #190: On Python 2, if unicode is passed for packages to
2506 ``build_py`` command, it will be handled just as with
2512 Intended to be v21.3.0, but jaraco accidentally released as
2515 * #598: Setuptools now lists itself first in the User-Agent
2516 for web requests, better following the guidelines in
2518 <https://tools.ietf.org/html/rfc7231#section-5.5.3>`_.
2523 * Minor fixes to changelog and docs.
2528 * #261: Exclude directories when resolving globs in
2534 * #539: In the easy_install get_site_dirs, honor all
2535 paths found in ``site.getsitepackages``.
2540 * #572: In build_ext, now always import ``_CONFIG_VARS``
2541 from ``distutils`` rather than from ``sysconfig``
2542 to allow ``distutils.sysconfig.customize_compiler``
2543 configure the OS X compiler for ``-dynamiclib``.
2548 * Removed ez_setup.py from Setuptools sdist. The
2549 bootstrap script will be maintained in its own
2550 branch and should be generally be retrieved from
2551 its canonical location at
2552 https://bootstrap.pypa.io/ez_setup.py.
2557 * #553: egg_info section is now generated in a
2558 deterministic order, matching the order generated
2559 by earlier versions of Python. Except on Python 2.6,
2560 order is preserved when existing settings are present.
2561 * #556: Update to Packaging 16.7, restoring support
2562 for deprecated ``python_implmentation`` marker.
2563 * #555: Upload command now prompts for a password
2564 when uploading to PyPI (or other repository) if no
2565 password is present in .pypirc or in the keyring.
2570 * #548: Update certify version to 2016.2.28
2571 * #545: Safely handle deletion of non-zip eggs in rotate
2577 * Issue #544: Fix issue with extra environment marker
2578 processing in WorkingSet due to refactor in v20.7.0.
2583 * Issue #543: Re-release so that latest release doesn't
2584 cause déjà vu with distribute and setuptools 0.7 in
2590 * Refactored extra environment marker processing
2592 * Issue #533: Fixed intermittent test failures.
2593 * Issue #536: In msvc9_support, trap additional exceptions
2594 that might occur when importing
2595 ``distutils.msvc9compiler`` in mingw environments.
2596 * Issue #537: Provide better context when package
2597 metadata fails to decode in UTF-8.
2602 * Issue #523: Restored support for environment markers,
2603 now honoring 'extra' environment markers.
2608 * Issue #523: Disabled support for environment markers
2609 introduced in v20.5.
2614 * Issue #503: Restore support for PEP 345 environment
2615 markers by updating to Packaging 16.6.
2620 * New release process that relies on
2621 `bumpversion <https://github.com/peritus/bumpversion>`_
2622 and Travis CI for continuous deployment.
2623 * Project versioning semantics now follow
2624 `semver <https://semver.org>`_ precisely.
2625 The 'v' prefix on version numbers now also allows
2626 version numbers to be referenced in the changelog,
2627 e.g. http://setuptools.readthedocs.io/en/latest/history.html#v20-6-0.
2632 * BB Pull Request #185, #470: Add support for environment markers
2633 in requirements in install_requires, setup_requires,
2634 tests_require as well as adding a test for the existing
2635 extra_requires machinery.
2640 * Issue #422: Moved hosting to
2641 `Github <https://github.com/pypa/setuptools>`_
2642 from `Bitbucket <https://bitbucket.org/pypa/setuptools>`_.
2643 Issues have been migrated, though all issues and comments
2644 are attributed to bb-migration. So if you have a particular
2645 issue or issues to which you've been subscribed, you will
2646 want to "watch" the equivalent issue in Github.
2647 The Bitbucket project will be retained for the indefinite
2648 future, but Github now hosts the canonical project repository.
2653 * Issue #519: Remove import hook when reloading the
2654 ``pkg_resources`` module.
2655 * BB Pull Request #184: Update documentation in ``pkg_resources``
2656 around new ``Requirement`` implementation.
2661 * BB Pull Request #179: ``pkg_resources.Requirement`` objects are
2662 now a subclass of ``packaging.requirements.Requirement``,
2663 allowing any environment markers and url (if any) to be
2664 affiliated with the requirement
2665 * BB Pull Request #179: Restore use of RequirementParseError
2666 exception unintentionally dropped in 20.2.
2671 * Issue #502: Correct regression in parsing of multiple
2672 version specifiers separated by commas and spaces.
2677 * Issue #499: Restore compatibility for legacy versions
2678 by bumping to packaging 16.4.
2683 * Changelog now includes release dates and links to PEPs.
2684 * BB Pull Request #173: Replace dual PEP 345 _markerlib implementation
2685 and PEP 426 implementation of environment marker support from
2686 packaging 16.1 and PEP 508. Fixes Issue #122.
2687 See also BB Pull Request #175, BB Pull Request #168, and
2688 BB Pull Request #164. Additionally:
2690 - ``Requirement.parse`` no longer retains the order of extras.
2691 - ``parse_requirements`` now requires that all versions be
2692 PEP-440 compliant, as revealed in #499. Packages released
2693 with invalid local versions should be re-released using
2694 the proper local version syntax, e.g. ``mypkg-1.0+myorg.1``.
2699 * Update ``upload_docs`` command to also honor keyring
2700 for password resolution.
2705 * Added support for using passwords from keyring in the upload
2706 command. See `the upload docs
2707 <https://setuptools.readthedocs.io/en/latest/setuptools.html#upload-upload-source-and-or-egg-distributions-to-pypi>`_
2713 * Issue #118: Once again omit the package metadata (egg-info)
2714 from the list of outputs in ``--record``. This version of setuptools
2715 can no longer be used to upgrade pip earlier than 6.0.
2720 * Off-project PR: `0dcee79 <https://github.com/pypa/setuptools/commit/0dcee791dfdcfacddaaec79b29f30a347a147413>`_ and `f9bd9b9 <https://github.com/pypa/setuptools/commit/f9bd9b9f5df54ef5a0bf8d16c3a889ab8c640580>`_
2721 For FreeBSD, also `honor root certificates from ca_root_nss <https://github.com/pypa/setuptools/commit/3ae46c30225eb46e1f5aada1a19e88b79f04dc72>`_.
2726 * Issue #491: Correct regression incurred in 19.4 where
2727 a double-namespace package installed using pip would
2733 * Restore compatibility for PyPy 3 compatibility lost in
2734 19.4.1 addressing Issue #487.
2735 * ``setuptools.launch`` shim now loads scripts in a new
2736 namespace, avoiding getting relative imports from
2737 the setuptools package on Python 2.
2742 * Added a new entry script ``setuptools.launch``,
2743 implementing the shim found in
2744 ``pip.util.setuptools_build``. Use this command to launch
2745 distutils-only packages under setuptools in the same way that
2746 pip does, causing the setuptools monkeypatching of distutils
2747 to be invoked prior to invoking a script. Useful for debugging
2748 or otherwise installing a distutils-only package under
2749 setuptools when pip isn't available or otherwise does not
2750 expose the desired functionality. For example::
2752 $ python -m setuptools.launch setup.py develop
2754 * Issue #488: Fix dual manifestation of Extension class in
2755 extension packages installed as dependencies when Cython
2761 * Issue #486: Correct TypeError when getfilesystemencoding
2763 * Issue #139: Clarified the license as MIT.
2764 * BB Pull Request #169: Removed special handling of command
2765 spec in scripts for Jython.
2770 * Issue #487: Use direct invocation of ``importlib.machinery``
2771 in ``pkg_resources`` to avoid missing detection on relevant
2777 * Issue #341: Correct error in path handling of package data
2778 files in ``build_py`` command when package is empty.
2779 * Distribute #323, Issue #141, Issue #207, and
2780 BB Pull Request #167: Another implementation of
2781 ``pkg_resources.WorkingSet`` and ``pkg_resources.Distribution``
2782 that supports replacing an extant package with a new one,
2783 allowing for setup_requires dependencies to supersede installed
2784 packages for the session.
2789 * Issue #229: Implement new technique for readily incorporating
2790 dependencies conditionally from vendored copies or primary
2791 locations. Adds a new dependency on six.
2796 * BB Pull Request #163: Add get_command_list method to Distribution.
2797 * BB Pull Request #162: Add missing whitespace to multiline string
2803 * Issue #476: Cast version to string (using default encoding)
2804 to avoid creating Unicode types on Python 2 clients.
2805 * Issue #477: In Powershell downloader, use explicit rendering
2806 of strings, rather than rely on ``repr``, which can be
2807 incorrect (especially on Python 2).
2812 * Issue #215: The bootstrap script ``ez_setup.py`` now
2813 automatically detects
2814 the latest version of setuptools (using PyPI JSON API) rather
2815 than hard-coding a particular value.
2816 * Issue #475: Fix incorrect usage in _translate_metadata2.
2821 * Issue #442: Use RawConfigParser for parsing .pypirc file.
2822 Interpolated values are no longer honored in .pypirc files.
2827 * Issue #440: Prevent infinite recursion when a SandboxViolation
2828 or other UnpickleableException occurs in a sandbox context
2829 with setuptools hidden. Fixes regression introduced in Setuptools
2835 * Deprecated ``egg_info.get_pkg_info_revision``.
2836 * Issue #471: Don't rely on repr for an HTML attribute value in
2838 * Issue #419: Avoid errors in FileMetadata when the metadata directory
2840 * Issue #472: Remove deprecated use of 'U' in mode parameter
2846 * Issue #469: Refactored logic for Issue #419 fix to re-use metadata
2847 loading from Provider.
2852 * Update dependency on certify.
2853 * BB Pull Request #160: Improve detection of gui script in
2854 ``easy_install._adjust_header``.
2855 * Made ``test.test_args`` a non-data property; alternate fix
2856 for the issue reported in BB Pull Request #155.
2857 * Issue #453: In ``ez_setup`` bootstrap module, unload all
2858 ``pkg_resources`` modules following download.
2859 * BB Pull Request #158: Honor PEP-488 when excluding
2860 files for namespace packages.
2861 * Issue #419 and BB Pull Request #144: Add experimental support for
2862 reading the version info from distutils-installed metadata rather
2863 than using the version in the filename.
2868 * Issue #464: Correct regression in invocation of superclass on old-style
2874 * Issue #439: When installing entry_point scripts under development,
2875 omit the version number of the package, allowing any version of the
2881 * In preparation for dropping support for Python 3.2, a warning is
2882 now logged when pkg_resources is imported on Python 3.2 or earlier
2884 * `Add support for python_platform_implementation environment marker
2885 <https://github.com/pypa/setuptools/commit/94416707fd59a65f4a8f7f70541d6b3fc018b626>`_.
2886 * `Fix dictionary mutation during iteration
2887 <https://github.com/pypa/setuptools/commit/57ebfa41e0f96b97e599ecd931b7ae8a143e096e>`_.
2892 * Issue #446: Test command now always invokes unittest, even
2893 if no test suite is supplied.
2898 * Correct another regression in setuptools.findall
2899 where the fix for Python #12885 was lost.
2904 * Issue #425: Correct regression in setuptools.findall.
2909 * BB Pull Request #135: Setuptools now allows disabling of
2910 the manipulation of the sys.path
2911 during the processing of the easy-install.pth file. To do so, set
2912 the environment variable ``SETUPTOOLS_SYS_PATH_TECHNIQUE`` to
2913 anything but "rewrite" (consider "raw"). During any install operation
2914 with manipulation disabled, setuptools packages will be appended to
2917 Future versions may change the default behavior to disable
2918 manipulation. If so, the default behavior can be retained by setting
2919 the variable to "rewrite".
2921 * Issue #257: ``easy_install --version`` now shows more detail
2922 about the installation location and Python version.
2924 * Refactor setuptools.findall in preparation for re-submission
2930 * Issue #412: More efficient directory search in ``find_packages``.
2935 * Upgrade to vendored packaging 15.3.
2940 * Issue #401: Fix failure in test suite.
2945 * Dropped support for builds with Pyrex. Only Cython is supported.
2946 * Issue #288: Detect Cython later in the build process, after
2947 ``setup_requires`` dependencies are resolved.
2948 Projects backed by Cython can now be readily built
2949 with a ``setup_requires`` dependency. For example::
2951 ext = setuptools.Extension('mylib', ['src/CythonStuff.pyx', 'src/CStuff.c'])
2955 setup_requires=['cython'],
2958 For compatibility with older versions of setuptools, packagers should
2959 still include ``src/CythonMod.c`` in the source distributions or
2960 require that Cython be present before building source distributions.
2961 However, for systems with this build of setuptools, Cython will be
2962 downloaded on demand.
2963 * Issue #396: Fixed test failure on OS X.
2964 * BB Pull Request #136: Remove excessive quoting from shebang headers
2970 * Backed out unintended changes to pkg_resources, restoring removal of
2971 deprecated imp module (`ref
2972 <https://bitbucket.org/pypa/setuptools/commits/f572ec9563d647fa8d4ffc534f2af8070ea07a8b#comment-1881283>`_).
2977 * Issue #380: Add support for range operators on environment
2983 * Issue #378: Do not use internal importlib._bootstrap module.
2984 * Issue #390: Disallow console scripts with path separators in
2985 the name. Removes unintended functionality and brings behavior
2986 into parity with pip.
2991 * BB Pull Request #130: Better error messages for errors in
2992 parsed requirements.
2993 * BB Pull Request #133: Removed ``setuptools.tests`` from the
2995 * BB Pull Request #129: Address deprecation warning due to usage
3001 * Issue #373: Provisionally expose
3002 ``pkg_resources._initialize_master_working_set``, allowing for
3003 imperative re-initialization of the master working set.
3008 * Updated to Packaging 15.1 to address Packaging #28.
3009 * Fix ``setuptools.sandbox._execfile()`` with Python 3.1.
3014 * BB Pull Request #126: DistributionNotFound message now lists the package or
3015 packages that required it. E.g.::
3017 pkg_resources.DistributionNotFound: The 'colorama>=0.3.1' distribution was not found and is required by smlib.log.
3019 Note that zc.buildout once dependended on the string rendering of this
3020 message to determine the package that was not found. This expectation
3021 has since been changed, but older versions of buildout may experience
3022 problems. See Buildout #242 for details.
3027 * Issue #307: Removed PEP-440 warning during parsing of versions
3028 in ``pkg_resources.Distribution``.
3029 * Issue #364: Replace deprecated usage with recommended usage of
3030 ``EntryPoint.load``.
3035 * Issue #254: When creating temporary egg cache on Unix, use mode 755
3036 for creating the directory to avoid the subsequent warning if
3037 the directory is group writable.
3042 * Issue #137: Update ``Distribution.hashcmp`` so that Distributions with
3043 None for pyversion or platform can be compared against Distributions
3044 defining those attributes.
3049 * Issue #360: Removed undesirable behavior from test runs, preventing
3050 write tests and installation to system site packages.
3055 * BB Pull Request #125: Add ``__ne__`` to Requirement class.
3056 * Various refactoring of easy_install.
3061 * Bootstrap script now accepts ``--to-dir`` to customize save directory or
3062 allow for re-use of existing repository of setuptools versions. See
3063 BB Pull Request #112 for background.
3064 * Issue #285: ``easy_install`` no longer will default to installing
3065 packages to the "user site packages" directory if it is itself installed
3066 there. Instead, the user must pass ``--user`` in all cases to install
3067 packages to the user site packages.
3068 This behavior now matches that of "pip install". To configure
3069 an environment to always install to the user site packages, consider
3070 using the "install-dir" and "scripts-dir" parameters to easy_install
3071 through an appropriate distutils config file.
3076 * Issue #359: Include pytest.ini in the sdist so invocation of py.test on the
3077 sdist honors the pytest configuration.
3082 Re-release of 13.0. Intermittent connectivity issues caused the release
3083 process to fail and PyPI uploads no longer accept files for 13.0.
3088 * Issue #356: Back out BB Pull Request #119 as it requires Setuptools 10 or later
3089 as the source during an upgrade.
3090 * Removed build_py class from setup.py. According to 892f439d216e, this
3091 functionality was added to support upgrades from old Distribute versions,
3097 * BB Pull Request #119: Restore writing of ``setup_requires`` to metadata
3098 (previously added in 8.4 and removed in 9.0).
3103 * Documentation is now linked using the rst.linker package.
3104 * Fix ``setuptools.command.easy_install.extract_wininst_cfg()``
3105 with Python 2.6 and 2.7.
3106 * Issue #354. Added documentation on building setuptools
3112 * Issue #345: Unload all modules under pkg_resources during
3113 ``ez_setup.use_setuptools()``.
3114 * Issue #336: Removed deprecation from ``ez_setup.use_setuptools``,
3115 as it is clearly still used by buildout's bootstrap. ``ez_setup``
3116 remains deprecated for use by individual packages.
3117 * Simplified implementation of ``ez_setup.use_setuptools``.
3122 * BB Pull Request #118: Soften warning for non-normalized versions in
3128 * Issue #339: Correct Attribute reference in ``cant_write_to_target``.
3129 * Issue #336: Deprecated ``ez_setup.use_setuptools``.
3134 * Issue #335: Fix script header generation on Windows.
3139 * Fixed incorrect class attribute in ``install_scripts``. Tests would be nice.
3144 * Issue #331: Fixed ``install_scripts`` command on Windows systems corrupting
3150 * Restore ``setuptools.command.easy_install.sys_executable`` for pbr
3151 compatibility. For the future, tools should construct a CommandSpec
3157 * Issue #188: Setuptools now support multiple entities in the value for
3158 ``build.executable``, such that an executable of "/usr/bin/env my-python" may
3159 be specified. This means that systems with a specified executable whose name
3160 has spaces in the path must be updated to escape or quote that value.
3161 * Deprecated ``easy_install.ScriptWriter.get_writer``, replaced by ``.best()``
3162 with slightly different semantics (no force_windows flag).
3167 * Issue #327: Formalize and restore support for any printable character in an
3173 * Expose ``EntryPoint.resolve`` in place of EntryPoint._load, implementing the
3174 simple, non-requiring load. Deprecated all uses of ``EntryPoint._load``
3175 except for calling with no parameters, which is just a shortcut for
3176 ``ep.require(); ep.resolve();``.
3178 Apps currently invoking ``ep.load(require=False)`` should instead do the
3179 following if wanting to avoid the deprecating warning::
3181 getattr(ep, "resolve", lambda: ep.load(require=False))()
3186 * Pip #2326: Report deprecation warning at stacklevel 2 for easier diagnosis.
3191 * Issue #281: Since Setuptools 6.1 (Issue #268), a ValueError would be raised
3192 in certain cases where VersionConflict was raised with two arguments, which
3193 occurred in ``pkg_resources.WorkingSet.find``. This release adds support
3194 for indicating the dependent packages while maintaining support for
3195 a VersionConflict when no dependent package context is known. New unit tests
3196 now capture the expected interface.
3201 * Interop #3: Upgrade to Packaging 15.0; updates to PEP 440 so that >1.7 does
3202 not exclude 1.7.1 but does exclude 1.7.0 and 1.7.0.post1.
3207 * Issue #323: Fix regression in entry point name parsing.
3212 * Deprecated use of EntryPoint.load(require=False). Passing a boolean to a
3213 function to select behavior is an anti-pattern. Instead use
3214 ``Entrypoint._load()``.
3215 * Substantial refactoring of all unit tests. Tests are now much leaner and
3216 re-use a lot of fixtures and contexts for better clarity of purpose.
3221 * Issue #320: Added a compatibility implementation of
3222 ``sdist._default_revctrl``
3223 so that systems relying on that interface do not fail (namely, Ubuntu 12.04
3224 and similar Debian releases).
3229 * Issue #319: Fixed issue installing pure distutils packages.
3234 * Issue #313: Removed built-in support for subversion. Projects wishing to
3235 retain support for subversion will need to use a third party library. The
3236 extant implementation is being ported to `setuptools_svn
3237 <https://pypi.org/project/setuptools_svn/>`_.
3238 * Issue #315: Updated setuptools to hide its own loaded modules during
3239 installation of another package. This change will enable setuptools to
3240 upgrade (or downgrade) itself even when its own metadata and implementation
3246 * Prefer vendored packaging library `as recommended
3247 <https://github.com/pypa/setuptools/commit/170657b68f4b92e7e1bf82f5e19a831f5744af67>`_.
3252 * Issue #312: Restored presence of pkg_resources API tests (doctest) to sdist.
3257 * Issue #314: Disabled support for ``setup_requires`` metadata to avoid issue
3258 where Setuptools was unable to upgrade over earlier versions.
3263 * BB Pull Request #106: Now write ``setup_requires`` metadata.
3268 * Issue #311: Decoupled pkg_resources from setuptools once again.
3269 ``pkg_resources`` is now a package instead of a module.
3274 * Issue #306: Suppress warnings about Version format except in select scenarios
3275 (such as installation).
3280 * BB Pull Request #85: Search egg-base when adding egg-info to manifest.
3285 * Upgrade ``packaging`` to 14.5, giving preference to "rc" as designator for
3286 release candidates over "c".
3287 * PEP-440 warnings are now raised as their own class,
3288 ``pkg_resources.PEP440Warning``, instead of RuntimeWarning.
3289 * Disabled warnings on empty versions.
3294 * Upgrade ``packaging`` to 14.4, fixing an error where there is a
3295 different result for if 2.0.5 is contained within >2.0dev and >2.0.dev even
3296 though normalization rules should have made them equal.
3297 * Issue #296: Add warning when a version is parsed as legacy. This warning will
3298 make it easier for developers to recognize deprecated version numbers.
3303 * Issue #296: Restored support for ``__hash__`` on parse_version results.
3308 * Issue #296: Restored support for ``__getitem__`` and sort operations on
3309 parse_version result.
3314 * Issue #296: Restore support for iteration over parse_version result, but
3315 deprecated that usage with a warning. Fixes failure with buildout.
3320 * Implement PEP 440 within
3321 pkg_resources and setuptools. This change
3322 deprecates some version numbers such that they will no longer be installable
3323 without using the ``===`` escape hatch. See `the changes to test_resources
3324 <https://bitbucket.org/pypa/setuptools/commits/dcd552da643c4448056de84c73d56da6d70769d5#chg-setuptools/tests/test_resources.py>`_
3325 for specific examples of version numbers and specifiers that are no longer
3326 supported. Setuptools now "vendors" the `packaging
3327 <https://github.com/pypa/packaging>`_ library.
3332 * Issue #80, Issue #209: Eggs that are downloaded for ``setup_requires``,
3333 ``test_requires``, etc. are now placed in a ``./.eggs`` directory instead of
3334 directly in the current directory. This choice of location means the files
3335 can be readily managed (removed, ignored). Additionally,
3336 later phases or invocations of setuptools will not detect the package as
3337 already installed and ignore it for permanent install (See #209).
3339 This change is indicated as backward-incompatible as installations that
3340 depend on the installation in the current directory will need to account for
3341 the new location. Systems that ignore ``*.egg`` will probably need to be
3342 adapted to ignore ``.eggs``. The files will need to be manually moved or
3343 will be retrieved again. Most use cases will require no attention.
3348 * Issue #268: When resolving package versions, a VersionConflict now reports
3349 which package previously required the conflicting version.
3354 * Issue #262: Fixed regression in pip install due to egg-info directories
3355 being omitted. Re-opens Issue #118.
3360 * Issue #259: Fixed regression with namespace package handling on ``single
3361 version, externally managed`` installs.
3366 * Issue #100: When building a distribution, Setuptools will no longer match
3367 default files using platform-dependent case sensitivity, but rather will
3368 only match the files if their case matches exactly. As a result, on Windows
3369 and other case-insensitive file systems, files with names such as
3370 'readme.txt' or 'README.TXT' will be omitted from the distribution and a
3371 warning will be issued indicating that 'README.txt' was not found. Other
3372 filenames affected are:
3377 - setup.py (or the script name)
3380 Any users producing distributions with filenames that match those above
3381 case-insensitively, but not case-sensitively, should rename those files in
3382 their repository for better portability.
3383 * BB Pull Request #72: When using ``single_version_externally_managed``, the
3384 exclusion list now includes Python 3.2 ``__pycache__`` entries.
3385 * BB Pull Request #76 and BB Pull Request #78: lines in top_level.txt are now
3386 ordered deterministically.
3387 * Issue #118: The egg-info directory is now no longer included in the list
3389 * Issue #258: Setuptools now patches distutils msvc9compiler to
3390 recognize the specially-packaged compiler package for easy extension module
3391 support on Python 2.6, 2.7, and 3.2.
3396 * Issue #237: ``pkg_resources`` now uses explicit detection of Python 2 vs.
3397 Python 3, supporting environments where builtins have been patched to make
3398 Python 3 look more like Python 2.
3403 * Issue #240: Based on real-world performance measures against 5.4, zip
3404 manifests are now cached in all circumstances. The
3405 ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` environment variable is no longer
3406 relevant. The observed "memory increase" referenced in the 5.4 release
3407 notes and detailed in Issue #154 was likely not an increase over the status
3408 quo, but rather only an increase over not storing the zip info at all.
3413 * Issue #242: Use absolute imports in svn_utils to avoid issues if the
3414 installing package adds an xml module to the path.
3419 * Issue #239: Fix typo in 5.5 such that fix did not take.
3424 * Issue #239: Setuptools now includes the setup_requires directive on
3425 Distribution objects and validates the syntax just like install_requires
3426 and tests_require directives.
3431 * Issue #236: Corrected regression in execfile implementation for Python 2.6.
3436 * Python #7776: (ssl_support) Correct usage of host for validation when
3437 tunneling for HTTPS.
3442 * Issue #154: ``pkg_resources`` will now cache the zip manifests rather than
3443 re-processing the same file from disk multiple times, but only if the
3444 environment variable ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` is set. Clients
3445 that package many modules in the same zip file will see some improvement
3446 in startup time by enabling this feature. This feature is not enabled by
3447 default because it causes a substantial increase in memory usage.
3452 * Issue #185: Make svn tagging work on the new style SVN metadata.
3454 * Prune revision control directories (e.g .svn) from base path
3455 as well as sub-directories.
3460 * Added a `Developer Guide
3461 <https://setuptools.readthedocs.io/en/latest/developer-guide.html>`_ to the official
3463 * Some code refactoring and cleanup was done with no intended behavioral
3465 * During install_egg_info, the generated lines for namespace package .pth
3466 files are now processed even during a dry run.
3471 * Issue #202: Implemented more robust cache invalidation for the ZipImporter,
3472 building on the work in Issue #168. Special thanks to Jurko Gospodnetic and
3478 * Issue #220: Restored script templates.
3483 * Renamed script templates to end with .tmpl now that they no longer need
3484 to be processed by 2to3. Fixes spurious syntax errors during build/install.
3489 * Issue #218: Re-release of 3.8.1 to signal that it supersedes 4.x.
3490 * Incidentally, script templates were updated not to include the triple-quote
3493 3.7.1 and 3.8.1 and 4.0.1
3494 -------------------------
3496 * Issue #213: Use legacy StringIO behavior for compatibility under pbr.
3497 * Issue #218: Setuptools 3.8.1 superseded 4.0.1, and 4.x was removed
3498 from the available versions to install.
3503 * Issue #210: ``setup.py develop`` now copies scripts in binary mode rather
3504 than text mode, matching the behavior of the ``install`` command.
3509 * Extend Issue #197 workaround to include all Python 3 versions prior to
3515 * Issue #193: Improved handling of Unicode filenames when building manifests.
3520 * Issue #203: Honor proxy settings for Powershell downloader in the bootstrap
3526 * Issue #168: More robust handling of replaced zip files and stale caches.
3527 Fixes ZipImportError complaining about a 'bad local header'.
3532 * Issue #199: Restored ``install._install`` for compatibility with earlier
3538 * Issue #195: Follow symbolic links in find_packages (restoring behavior
3540 * Issue #197: On Python 3.1, PKG-INFO is now saved in a UTF-8 encoding instead
3541 of ``sys.getpreferredencoding`` to match the behavior on Python 2.6-3.4.
3542 * Issue #192: Preferred bootstrap location is now
3543 https://bootstrap.pypa.io/ez_setup.py (mirrored from former location).
3548 * Issue #184: Correct failure where find_package over-matched packages
3549 when directory traversal isn't short-circuited.
3554 * Issue #183: Really fix test command with Python 3.1.
3559 * Issue #183: Fix additional regression in test command on Python 3.1.
3564 * Issue #180: Fix regression in test command not caught by py.test-run tests.
3569 * Issue #176: Add parameter to the test command to support a custom test
3570 runner: --test-runner or -r.
3571 * Issue #177: Now assume most common invocation to install command on
3572 platforms/environments without stack support (issuing a warning). Setuptools
3573 now installs naturally on IronPython. Behavior on CPython should be
3579 * Add ``include`` parameter to ``setuptools.find_packages()``.
3584 * BB Pull Request #39: Add support for C++ targets from Cython ``.pyx`` files.
3585 * Issue #162: Update dependency on certifi to 1.0.1.
3586 * Issue #164: Update dependency on wincertstore to 0.2.
3591 * Issue #161: Restore Features functionality to allow backward compatibility
3592 (for Features) until the uses of that functionality is sufficiently removed.
3597 * Correct typo in previous bugfix.
3602 * Issue #157: Restore support for Python 2.6 in bootstrap script where
3603 ``zipfile.ZipFile`` does not yet have support for context managers.
3608 * Issue #125: Prevent Subversion support from creating a ~/.subversion
3609 directory just for checking the presence of a Subversion repository.
3610 * Issue #12: Namespace packages are now imported lazily. That is, the mere
3611 declaration of a namespace package in an egg on ``sys.path`` no longer
3612 causes it to be imported when ``pkg_resources`` is imported. Note that this
3613 change means that all of a namespace package's ``__init__.py`` files must
3614 include a ``declare_namespace()`` call in order to ensure that they will be
3615 handled properly at runtime. In 2.x it was possible to get away without
3616 including the declaration, but only at the cost of forcing namespace
3617 packages to be imported early, which 3.0 no longer does.
3618 * Issue #148: When building (bdist_egg), setuptools no longer adds
3619 ``__init__.py`` files to namespace packages. Any packages that rely on this
3620 behavior will need to create ``__init__.py`` files and include the
3621 ``declare_namespace()``.
3622 * Issue #7: Setuptools itself is now distributed as a zip archive in addition to
3623 tar archive. ez_setup.py now uses zip archive. This approach avoids the potential
3624 security vulnerabilities presented by use of tar archives in ez_setup.py.
3625 It also leverages the security features added to ZipFile.extract in Python 2.7.4.
3626 * Issue #65: Removed deprecated Features functionality.
3627 * BB Pull Request #28: Remove backport of ``_bytecode_filenames`` which is
3628 available in Python 2.6 and later, but also has better compatibility with
3629 Python 3 environments.
3630 * Issue #156: Fix spelling of __PYVENV_LAUNCHER__ variable.
3635 * Issue #141: Restored fix for allowing setup_requires dependencies to
3636 override installed dependencies during setup.
3637 * Issue #128: Fixed issue where only the first dependency link was honored
3638 in a distribution where multiple dependency links were supplied.
3643 * Issue #144: Read long_description using codecs module to avoid errors
3644 installing on systems where LANG=C.
3649 * Issue #139: Fix regression in re_finder for CVS repos (and maybe Git repos
3655 * Issue #129: Suppress inspection of ``*.whl`` files when searching for files
3656 in a zip-imported file.
3657 * Issue #131: Fix RuntimeError when constructing an egg fetcher.
3662 * Fix NameError during installation with Python implementations (e.g. Jython)
3663 not containing parser module.
3664 * Fix NameError in ``sdist:re_finder``.
3669 * Issue #124: Fixed error in list detection in upload_docs.
3674 * Issue #121: Exempt lib2to3 pickled grammars from DirectorySandbox.
3675 * Issue #41: Dropped support for Python 2.4 and Python 2.5. Clients requiring
3676 setuptools for those versions of Python should use setuptools 1.x.
3677 * Removed ``setuptools.command.easy_install.HAS_USER_SITE``. Clients
3678 expecting this boolean variable should use ``site.ENABLE_USER_SITE``
3680 * Removed ``pkg_resources.ImpWrapper``. Clients that expected this class
3681 should use ``pkgutil.ImpImporter`` instead.
3686 * Issue #116: Correct TypeError when reading a local package index on Python
3692 * Issue #114: Use ``sys.getfilesystemencoding`` for decoding config in
3693 ``bdist_wininst`` distributions.
3695 * Issue #105 and Issue #113: Establish a more robust technique for
3696 determining the terminal encoding::
3698 1. Try ``getpreferredencoding``
3699 2. If that returns US_ASCII or None, try the encoding from
3700 ``getdefaultlocale``. If that encoding was a "fallback" because Python
3701 could not figure it out from the environment or OS, encoding remains
3703 3. If the encoding is resolved, then make sure Python actually implements
3705 4. On the event of an error or unknown codec, revert to fallbacks
3706 (UTF-8 on Darwin, ASCII on everything else).
3707 5. On the encoding is 'mac-roman' on Darwin, use UTF-8 as 'mac-roman' was
3708 a bug on older Python releases.
3710 On a side note, it would seem that the encoding only matters for when SVN
3711 does not yet support ``--xml`` and when getting repository and svn version
3712 numbers. The ``--xml`` technique should yield UTF-8 according to some
3713 messages on the SVN mailing lists. So if the version numbers are always
3714 7-bit ASCII clean, it may be best to only support the file parsing methods
3715 for legacy SVN releases and support for SVN without the subprocess command
3716 would simple go away as support for the older SVNs does.
3721 * Issue #27: ``easy_install`` will now use credentials from .pypirc if
3722 present for connecting to the package index.
3723 * BB Pull Request #21: Omit unwanted newlines in ``package_index._encode_auth``
3724 when the username/password pair length indicates wrapping.
3729 * Issue #99: Fix filename encoding issues in SVN support.
3734 * Remove exuberant warning in SVN support when SVN is not used.
3739 * Address security vulnerability in SSL match_hostname check as reported in
3741 * Prefer `backports.ssl_match_hostname
3742 <https://pypi.org/project/backports.ssl_match_hostname/>`_ for backport
3743 implementation if present.
3744 * Correct NameError in ``ssl_support`` module (``socket.error``).
3749 * Issue #26: Add support for SVN 1.7. Special thanks to Philip Thiem for the
3751 * Issue #93: Wheels are now distributed with every release. Note that as
3752 reported in Issue #108, as of Pip 1.4, scripts aren't installed properly
3753 from wheels. Therefore, if using Pip to install setuptools from a wheel,
3754 the ``easy_install`` command will not be available.
3755 * Setuptools "natural" launcher support, introduced in 1.0, is now officially
3761 * Fixed behavior of NameError handling in 'script template (dev).py' (script
3762 launcher for 'develop' installs).
3763 * ``ez_setup.py`` now ensures partial downloads are cleaned up following
3765 * Distribute #363 and Issue #55: Skip an sdist test that fails on locales
3771 * Distribute #349: ``sandbox.execfile`` now opens the target file in binary
3772 mode, thus honoring a BOM in the file when compiled.
3777 * Issue #69: Second attempt at fix (logic was reversed).
3782 * Issue #77: Fix error in upload command (Python 2.4).
3787 * Fix NameError in previous patch.
3792 * Issue #69: Correct issue where 404 errors are returned for URLs with
3793 fragments in them (such as #egg=).
3798 * Issue #75: Add ``--insecure`` option to ez_setup.py to accommodate
3799 environments where a trusted SSL connection cannot be validated.
3800 * Issue #76: Fix AttributeError in upload command with Python 2.4.
3805 * Issue #71 (Distribute #333): EasyInstall now puts less emphasis on the
3806 condition when a host is blocked via ``--allow-hosts``.
3807 * Issue #72: Restored Python 2.4 compatibility in ``ez_setup.py``.
3812 * Issue #60: On Windows, Setuptools supports deferring to another launcher,
3813 such as Vinay Sajip's `pylauncher <https://bitbucket.org/pypa/pylauncher>`_
3814 (included with Python 3.3) to launch console and GUI scripts and not install
3815 its own launcher executables. This experimental functionality is currently
3816 only enabled if the ``SETUPTOOLS_LAUNCHER`` environment variable is set to
3817 "natural". In the future, this behavior may become default, but only after
3818 it has matured and seen substantial adoption. The ``SETUPTOOLS_LAUNCHER``
3819 also accepts "executable" to force the default behavior of creating launcher
3821 * Issue #63: Bootstrap script (ez_setup.py) now prefers Powershell, curl, or
3822 wget for retrieving the Setuptools tarball for improved security of the
3823 install. The script will still fall back to a simple ``urlopen`` on
3824 platforms that do not have these tools.
3825 * Issue #65: Deprecated the ``Features`` functionality.
3826 * Issue #52: In ``VerifyingHTTPSConn``, handle a tunnelled (proxied)
3829 Backward-Incompatible Changes
3830 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3832 This release includes a couple of backward-incompatible changes, but most if
3833 not all users will find 1.0 a drop-in replacement for 0.9.
3835 * Issue #50: Normalized API of environment marker support. Specifically,
3836 removed line number and filename from SyntaxErrors when returned from
3837 ``pkg_resources.invalid_marker``. Any clients depending on the specific
3838 string representation of exceptions returned by that function may need to
3839 be updated to account for this change.
3840 * Issue #50: SyntaxErrors generated by ``pkg_resources.invalid_marker`` are
3841 normalized for cross-implementation consistency.
3842 * Removed ``--ignore-conflicts-at-my-risk`` and ``--delete-conflicting``
3843 options to easy_install. These options have been deprecated since 0.6a11.
3848 * Issue #53: Fix NameErrors in ``_vcs_split_rev_from_url``.
3853 * Issue #49: Correct AttributeError on PyPy where a hashlib.HASH object does
3854 not have a ``.name`` attribute.
3855 * Issue #34: Documentation now refers to bootstrap script in code repository
3856 referenced by bookmark.
3857 * Add underscore-separated keys to environment markers (markerlib).
3862 * Issue #44: Test failure on Python 2.4 when MD5 hash doesn't have a ``.name``
3868 * Python #17980: Fix security vulnerability in SSL certificate validation.
3873 * Issue #43: Fix issue (introduced in 0.9.1) with version resolution when
3874 upgrading over other releases of Setuptools.
3879 * Issue #42: Fix new ``AttributeError`` introduced in last fix.
3884 * Issue #42: Fix regression where blank checksums would trigger an
3890 * Distribute #386: Allow other positional and keyword arguments to os.open.
3891 * Corrected dependency on certifi mis-referenced in 0.9.
3896 * ``package_index`` now validates hashes other than MD5 in download links.
3901 * Code base now runs on Python 2.4 - Python 3.3 without Python 2to3
3907 * Distribute #375: Yet another fix for yet another regression.
3912 * Distribute #375: Repair AttributeError created in last release (redo).
3913 * Issue #30: Added test for get_cache_path.
3918 * Distribute #375: Repair AttributeError created in last release.
3923 * Issue #21: Restore Python 2.4 compatibility in ``test_easy_install``.
3924 * Distribute #375: Merged additional warning from Distribute 0.6.46.
3925 * Now honor the environment variable
3926 ``SETUPTOOLS_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT`` in addition to the now
3927 deprecated ``DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT``.
3932 * Issue #20: Fix comparison of parsed SVN version on Python 3.
3937 * Issue #1: Disable installation of Windows-specific files on non-Windows systems.
3938 * Use new sysconfig module with Python 2.7 or >=3.2.
3943 * Issue #14: Use markerlib when the ``parser`` module is not available.
3944 * Issue #10: ``ez_setup.py`` now uses HTTPS to download setuptools from PyPI.
3949 * Fix NameError (Issue #3) again - broken in bad merge.
3954 * Merged Setuptools and Distribute. See docs/merge.txt for details.
3956 Added several features that were slated for setuptools 0.6c12:
3958 * Index URL now defaults to HTTPS.
3959 * Added experimental environment marker support. Now clients may designate a
3960 PEP-426 environment marker for "extra" dependencies. Setuptools uses this
3961 feature in ``setup.py`` for optional SSL and certificate validation support
3962 on older platforms. Based on Distutils-SIG discussions, the syntax is
3963 somewhat tentative. There should probably be a PEP with a firmer spec before
3964 the feature should be considered suitable for use.
3965 * Added support for SSL certificate validation when installing packages from
3971 * Issue #3: Fixed NameError in SSL support.
3976 * Move warning check in ``get_cache_path`` to follow the directory creation
3977 to avoid errors when the cache path does not yet exist. Fixes the error
3978 reported in Distribute #375.
3983 * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
3989 * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
3995 * Distribute #375: Issue a warning if the PYTHON_EGG_CACHE or otherwise
3996 customized egg cache location specifies a directory that's group- or
4002 * Distribute #379: ``distribute_setup.py`` now traps VersionConflict as well,
4003 restoring ability to upgrade from an older setuptools version.
4008 * ``distribute_setup.py`` has been updated to allow Setuptools 0.7 to
4009 satisfy use_setuptools.
4014 * Distribute #378: Restore support for Python 2.4 Syntax (regression in 0.6.42).
4019 * External links finder no longer yields duplicate links.
4020 * Distribute #337: Moved site.py to setuptools/site-patch.py (graft of very old
4021 patch from setuptools trunk which inspired PR #31).
4026 * Distribute #27: Use public api for loading resources from zip files rather than
4027 the private method ``_zip_directory_cache``.
4028 * Added a new function ``easy_install.get_win_launcher`` which may be used by
4029 third-party libraries such as buildout to get a suitable script launcher.
4034 * Distribute #376: brought back cli.exe and gui.exe that were deleted in the
4040 * Add support for console launchers on ARM platforms.
4041 * Fix possible issue in GUI launchers where the subsystem was not supplied to
4043 * Launcher build script now refactored for robustness.
4044 * Distribute #375: Resources extracted from a zip egg to the file system now also
4045 check the contents of the file against the zip contents during each
4046 invocation of get_resource_filename.
4051 * Distribute #371: The launcher manifest file is now installed properly.
4056 * Distribute #143: Launcher scripts, including easy_install itself, are now
4057 accompanied by a manifest on 32-bit Windows environments to avoid the
4058 Installer Detection Technology and thus undesirable UAC elevation described
4059 in `this Microsoft article
4060 <http://technet.microsoft.com/en-us/library/cc709628%28WS.10%29.aspx>`_.
4065 * BB Pull Request #35: In Buildout #64, it was reported that
4066 under Python 3, installation of distutils scripts could attempt to copy
4067 the ``__pycache__`` directory as a file, causing an error, apparently only
4068 under Windows. Easy_install now skips all directories when processing
4075 Note this release is backward-incompatible with distribute 0.6.23-0.6.34 in
4076 how it parses version numbers.
4078 * Distribute #278: Restored compatibility with distribute 0.6.22 and setuptools
4079 0.6. Updated the documentation to match more closely with the version
4080 parsing as intended in setuptools 0.6.
4085 * Distribute #341: 0.6.33 fails to build under Python 2.4.
4090 * Fix 2 errors with Jython 2.5.
4091 * Fix 1 failure with Jython 2.5 and 2.7.
4092 * Disable workaround for Jython scripts on Linux systems.
4093 * Distribute #336: ``setup.py`` no longer masks failure exit code when tests fail.
4094 * Fix issue in pkg_resources where try/except around a platform-dependent
4095 import would trigger hook load failures on Mercurial. See pull request 32
4097 * Distribute #341: Fix a ResourceWarning.
4102 * Fix test suite with Python 2.6.
4103 * Fix some DeprecationWarnings and ResourceWarnings.
4104 * Distribute #335: Backed out ``setup_requires`` superceding installed requirements
4105 until regression can be addressed.
4110 * Distribute #303: Make sure the manifest only ever contains UTF-8 in Python 3.
4111 * Distribute #329: Properly close files created by tests for compatibility with
4113 * Work around Jython #1980 and Jython #1981.
4114 * Distribute #334: Provide workaround for packages that reference ``sys.__stdout__``
4115 such as numpy does. This change should address
4116 `virtualenv #359 <https://github.com/pypa/virtualenv/issues/359>`_ as long
4117 as the system encoding is UTF-8 or the IO encoding is specified in the
4120 PYTHONIOENCODING=utf8 pip install numpy
4122 * Fix for encoding issue when installing from Windows executable on Python 3.
4123 * Distribute #323: Allow ``setup_requires`` requirements to supercede installed
4124 requirements. Added some new keyword arguments to existing pkg_resources
4125 methods. Also had to updated how __path__ is handled for namespace packages
4126 to ensure that when a new egg distribution containing a namespace package is
4127 placed on sys.path, the entries in __path__ are found in the same order they
4128 would have been in had that egg been on the path when pkg_resources was
4134 * Distribute #328: Clean up temporary directories in distribute_setup.py.
4135 * Fix fatal bug in distribute_setup.py.
4140 * BB Pull Request #14: Honor file permissions in zip files.
4141 * Distribute #327: Merged pull request #24 to fix a dependency problem with pip.
4142 * Merged pull request #23 to fix https://github.com/pypa/virtualenv/issues/301.
4143 * If Sphinx is installed, the ``upload_docs`` command now runs ``build_sphinx``
4144 to produce uploadable documentation.
4145 * Distribute #326: ``upload_docs`` provided mangled auth credentials under Python 3.
4146 * Distribute #320: Fix check for "createable" in distribute_setup.py.
4147 * Distribute #305: Remove a warning that was triggered during normal operations.
4148 * Distribute #311: Print metadata in UTF-8 independent of platform.
4149 * Distribute #303: Read manifest file with UTF-8 encoding under Python 3.
4150 * Distribute #301: Allow to run tests of namespace packages when using 2to3.
4151 * Distribute #304: Prevent import loop in site.py under Python 3.3.
4152 * Distribute #283: Reenable scanning of ``*.pyc`` / ``*.pyo`` files on Python 3.3.
4153 * Distribute #299: The develop command didn't work on Python 3, when using 2to3,
4154 as the egg link would go to the Python 2 source. Linking to the 2to3'd code
4155 in build/lib makes it work, although you will have to rebuild the module
4157 * Distribute #306: Even if 2to3 is used, we build in-place under Python 2.
4158 * Distribute #307: Prints the full path when .svn/entries is broken.
4159 * Distribute #313: Support for sdist subcommands (Python 2.7)
4160 * Distribute #314: test_local_index() would fail an OS X.
4161 * Distribute #310: Non-ascii characters in a namespace __init__.py causes errors.
4162 * Distribute #218: Improved documentation on behavior of ``package_data`` and
4163 ``include_package_data``. Files indicated by ``package_data`` are now included
4165 * ``distribute_setup.py`` now allows a ``--download-base`` argument for retrieving
4166 distribute from a specified location.
4171 * Distribute #294: setup.py can now be invoked from any directory.
4172 * Scripts are now installed honoring the umask.
4173 * Added support for .dist-info directories.
4174 * Distribute #283: Fix and disable scanning of ``*.pyc`` / ``*.pyo`` files on
4180 * Support current snapshots of CPython 3.3.
4181 * Distribute now recognizes README.rst as a standard, default readme file.
4182 * Exclude 'encodings' modules when removing modules from sys.modules.
4183 Workaround for #285.
4184 * Distribute #231: Don't fiddle with system python when used with buildout
4190 * Distribute #183: Symlinked files are now extracted from source distributions.
4191 * Distribute #227: Easy_install fetch parameters are now passed during the
4192 installation of a source distribution; now fulfillment of setup_requires
4193 dependencies will honor the parameters passed to easy_install.
4198 * Distribute #258: Workaround a cache issue
4199 * Distribute #260: distribute_setup.py now accepts the --user parameter for
4200 Python 2.6 and later.
4201 * Distribute #262: package_index.open_with_auth no longer throws LookupError
4203 * Distribute #269: AttributeError when an exception occurs reading Manifest.in
4204 on late releases of Python.
4205 * Distribute #272: Prevent TypeError when namespace package names are unicode
4206 and single-install-externally-managed is used. Also fixes PIP issue
4208 * Distribute #273: Legacy script launchers now install with Python2/3 support.
4213 * Distribute #249: Added options to exclude 2to3 fixers
4218 * Distribute #244: Fixed a test
4219 * Distribute #243: Fixed a test
4220 * Distribute #239: Fixed a test
4221 * Distribute #240: Fixed a test
4222 * Distribute #241: Fixed a test
4223 * Distribute #237: Fixed a test
4224 * Distribute #238: easy_install now uses 64bit executable wrappers on 64bit Python
4225 * Distribute #208: Fixed parsed_versions, it now honors post-releases as noted in the documentation
4226 * Distribute #207: Windows cli and gui wrappers pass CTRL-C to child python process
4227 * Distribute #227: easy_install now passes its arguments to setup.py bdist_egg
4228 * Distribute #225: Fixed a NameError on Python 2.5, 2.4
4233 * Distribute #225: FIxed a regression on py2.4
4238 * Distribute #135: Include url in warning when processing URLs in package_index.
4239 * Distribute #212: Fix issue where easy_instal fails on Python 3 on windows installer.
4240 * Distribute #213: Fix typo in documentation.
4245 * Distribute #206: AttributeError: 'HTTPMessage' object has no attribute 'getheaders'
4250 * Distribute #210: Fixed a regression introduced by Distribute #204 fix.
4255 * Support 'DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT' environment
4256 variable to allow to disable installation of easy_install-${version} script.
4257 * Support Python >=3.1.4 and >=3.2.1.
4258 * Distribute #204: Don't try to import the parent of a namespace package in
4260 * Distribute #196: Tolerate responses with multiple Content-Length headers
4261 * Distribute #205: Sandboxing doesn't preserve working_set. Leads to setup_requires
4267 * Builds sdist gztar even on Windows (avoiding Distribute #193).
4268 * Distribute #192: Fixed metadata omitted on Windows when package_dir
4269 specified with forward-slash.
4270 * Distribute #195: Cython build support.
4271 * Distribute #200: Issues with recognizing 64-bit packages on Windows.
4276 * Fixed typo in bdist_egg
4277 * Several issues under Python 3 has been solved.
4278 * Distribute #146: Fixed missing DLL files after easy_install of windows exe package.
4283 * Distribute #170: Fixed unittest failure. Thanks to Toshio.
4284 * Distribute #171: Fixed race condition in unittests cause deadlocks in test suite.
4285 * Distribute #143: Fixed a lookup issue with easy_install.
4286 Thanks to David and Zooko.
4287 * Distribute #174: Fixed the edit mode when its used with setuptools itself
4292 * Distribute #160: 2.7 gives ValueError("Invalid IPv6 URL")
4293 * Distribute #150: Fixed using ~/.local even in a --no-site-packages virtualenv
4294 * Distribute #163: scan index links before external links, and don't use the md5 when
4295 comparing two distributions
4300 * Distribute #149: Fixed various failures on 2.3/2.4
4305 * Found another case of SandboxViolation - fixed
4306 * Distribute #15 and Distribute #48: Introduced a socket timeout of 15 seconds on url openings
4307 * Added indexsidebar.html into MANIFEST.in
4308 * Distribute #108: Fixed TypeError with Python3.1
4309 * Distribute #121: Fixed --help install command trying to actually install.
4310 * Distribute #112: Added an os.makedirs so that Tarek's solution will work.
4311 * Distribute #133: Added --no-find-links to easy_install
4312 * Added easy_install --user
4313 * Distribute #100: Fixed develop --user not taking '.' in PYTHONPATH into account
4314 * Distribute #134: removed spurious UserWarnings. Patch by VanLindberg
4315 * Distribute #138: cant_write_to_target error when setup_requires is used.
4316 * Distribute #147: respect the sys.dont_write_bytecode flag
4321 * Reverted change made for the DistributionNotFound exception because
4322 zc.buildout uses the exception message to get the name of the
4328 * Distribute #90: unknown setuptools version can be added in the working set
4329 * Distribute #87: setupt.py doesn't try to convert distribute_setup.py anymore
4330 Initial Patch by arfrever.
4331 * Distribute #89: added a side bar with a download link to the doc.
4332 * Distribute #86: fixed missing sentence in pkg_resources doc.
4333 * Added a nicer error message when a DistributionNotFound is raised.
4334 * Distribute #80: test_develop now works with Python 3.1
4335 * Distribute #93: upload_docs now works if there is an empty sub-directory.
4336 * Distribute #70: exec bit on non-exec files
4337 * Distribute #99: now the standalone easy_install command doesn't uses a
4338 "setup.cfg" if any exists in the working directory. It will use it
4339 only if triggered by ``install_requires`` from a setup.py call
4340 (install, develop, etc).
4341 * Distribute #101: Allowing ``os.devnull`` in Sandbox
4342 * Distribute #92: Fixed the "no eggs" found error with MacPort
4343 (platform.mac_ver() fails)
4344 * Distribute #103: test_get_script_header_jython_workaround not run
4345 anymore under py3 with C or POSIX local. Contributed by Arfrever.
4346 * Distribute #104: removed the assertion when the installation fails,
4347 with a nicer message for the end user.
4348 * Distribute #100: making sure there's no SandboxViolation when
4349 the setup script patches setuptools.
4354 * Added "check_packages" in dist. (added in Setuptools 0.6c11)
4355 * Fixed the DONT_PATCH_SETUPTOOLS state.
4360 * Distribute #58: Added --user support to the develop command
4361 * Distribute #11: Generated scripts now wrap their call to the script entry point
4362 in the standard "if name == 'main'"
4363 * Added the 'DONT_PATCH_SETUPTOOLS' environment variable, so virtualenv
4364 can drive an installation that doesn't patch a global setuptools.
4365 * Reviewed unladen-swallow specific change from
4366 http://code.google.com/p/unladen-swallow/source/detail?spec=svn875&r=719
4367 and determined that it no longer applies. Distribute should work fine with
4368 Unladen Swallow 2009Q3.
4369 * Distribute #21: Allow PackageIndex.open_url to gracefully handle all cases of a
4370 httplib.HTTPException instead of just InvalidURL and BadStatusLine.
4371 * Removed virtual-python.py from this distribution and updated documentation
4372 to point to the actively maintained virtualenv instead.
4373 * Distribute #64: use_setuptools no longer rebuilds the distribute egg every
4375 * use_setuptools now properly respects the requested version
4376 * use_setuptools will no longer try to import a distribute egg for the
4377 wrong Python version
4378 * Distribute #74: no_fake should be True by default.
4379 * Distribute #72: avoid a bootstrapping issue with easy_install -U
4384 * Unified the bootstrap file so it works on both py2.x and py3k without 2to3
4385 (patch by Holger Krekel)
4390 * Distribute #65: cli.exe and gui.exe are now generated at build time,
4391 depending on the platform in use.
4393 * Distribute #67: Fixed doc typo (PEP 381/PEP 382).
4395 * Distribute no longer shadows setuptools if we require a 0.7-series
4396 setuptools. And an error is raised when installing a 0.7 setuptools with
4399 * When run from within buildout, no attempt is made to modify an existing
4400 setuptools egg, whether in a shared egg directory or a system setuptools.
4402 * Fixed a hole in sandboxing allowing builtin file to write outside of
4408 * Added the generation of ``distribute_setup_3k.py`` during the release.
4409 This closes Distribute #52.
4411 * Added an upload_docs command to easily upload project documentation to
4412 PyPI's https://pythonhosted.org. This close issue Distribute #56.
4414 * Fixed a bootstrap bug on the use_setuptools() API.
4422 * Fixed a bunch of calls to file() that caused crashes on Python 3.
4427 * Fixed a bug in sorting that caused bootstrap to fail on Python 3.
4435 * Added Python 3 support; see docs/python3.txt.
4436 This closes Old Setuptools #39.
4438 * Added option to run 2to3 automatically when installing on Python 3.
4439 This closes issue Distribute #31.
4441 * Fixed invalid usage of requirement.parse, that broke develop -d.
4442 This closes Old Setuptools #44.
4444 * Fixed script launcher for 64-bit Windows.
4445 This closes Old Setuptools #2.
4447 * KeyError when compiling extensions.
4448 This closes Old Setuptools #41.
4453 * Fixed bootstrap not working on Windows. This closes issue Distribute #49.
4455 * Fixed 2.6 dependencies. This closes issue Distribute #50.
4457 * Make sure setuptools is patched when running through easy_install
4458 This closes Old Setuptools #40.
4466 * package_index.urlopen now catches BadStatusLine and malformed url errors.
4467 This closes Distribute #16 and Distribute #18.
4469 * zip_ok is now False by default. This closes Old Setuptools #33.
4471 * Fixed invalid URL error catching. Old Setuptools #20.
4473 * Fixed invalid bootstraping with easy_install installation (Distribute #40).
4474 Thanks to Florian Schulze for the help.
4476 * Removed buildout/bootstrap.py. A new repository will create a specific
4477 bootstrap.py script.
4483 * The bootstrap process leave setuptools alone if detected in the system
4484 and --root or --prefix is provided, but is not in the same location.
4485 This closes Distribute #10.
4493 * Packages required at build time where not fully present at install time.
4494 This closes Distribute #12.
4496 * Protected against failures in tarfile extraction. This closes Distribute #10.
4498 * Made Jython api_tests.txt doctest compatible. This closes Distribute #7.
4500 * sandbox.py replaced builtin type file with builtin function open. This
4501 closes Distribute #6.
4503 * Immediately close all file handles. This closes Distribute #3.
4505 * Added compatibility with Subversion 1.6. This references Distribute #1.
4510 * Avoid a call to /usr/bin/sw_vers on OSX and use the official platform API
4511 instead. Based on a patch from ronaldoussoren. This closes issue #5.
4513 * Fixed a SandboxViolation for mkdir that could occur in certain cases.
4514 This closes Distribute #13.
4516 * Allow to find_on_path on systems with tight permissions to fail gracefully.
4517 This closes Distribute #9.
4519 * Corrected inconsistency between documentation and code of add_entry.
4520 This closes Distribute #8.
4522 * Immediately close all file handles. This closes Distribute #3.
4527 * Immediately close all file handles. This closes Distribute #3.
4532 * Fixed a missing files problem when using Windows source distributions on
4533 non-Windows platforms, due to distutils not handling manifest file line
4536 * Updated Pyrex support to work with Pyrex 0.9.6 and higher.
4538 * Minor changes for Jython compatibility, including skipping tests that can't
4541 * Fixed not installing eggs in ``install_requires`` if they were also used for
4542 ``setup_requires`` or ``tests_require``.
4544 * Fixed not fetching eggs in ``install_requires`` when running tests.
4546 * Allow ``ez_setup.use_setuptools()`` to upgrade existing setuptools
4547 installations when called from a standalone ``setup.py``.
4549 * Added a warning if a namespace package is declared, but its parent package
4550 is not also declared as a namespace.
4552 * Support Subversion 1.5
4554 * Removed use of deprecated ``md5`` module if ``hashlib`` is available
4556 * Fixed ``bdist_wininst upload`` trying to upload the ``.exe`` twice
4558 * Fixed ``bdist_egg`` putting a ``native_libs.txt`` in the source package's
4559 ``.egg-info``, when it should only be in the built egg's ``EGG-INFO``.
4561 * Ensure that _full_name is set on all shared libs before extensions are
4562 checked for shared lib usage. (Fixes a bug in the experimental shared
4563 library build support.)
4565 * Fix to allow unpacked eggs containing native libraries to fail more
4566 gracefully under Google App Engine (with an ``ImportError`` loading the
4567 C-based module, instead of getting a ``NameError``).
4569 * Fixed ``win32.exe`` support for .pth files, so unnecessary directory nesting
4570 is flattened out in the resulting egg. (There was a case-sensitivity
4571 problem that affected some distributions, notably ``pywin32``.)
4573 * Prevent ``--help-commands`` and other junk from showing under Python 2.5
4574 when running ``easy_install --help``.
4576 * Fixed GUI scripts sometimes not executing on Windows
4578 * Fixed not picking up dependency links from recursive dependencies.
4580 * Only make ``.py``, ``.dll`` and ``.so`` files executable when unpacking eggs
4582 * Changes for Jython compatibility
4584 * Improved error message when a requirement is also a directory name, but the
4585 specified directory is not a source package.
4587 * Fixed ``--allow-hosts`` option blocking ``file:`` URLs
4589 * Fixed HTTP SVN detection failing when the page title included a project
4590 name (e.g. on SourceForge-hosted SVN)
4592 * Fix Jython script installation to handle ``#!`` lines better when
4593 ``sys.executable`` is a script.
4595 * Removed use of deprecated ``md5`` module if ``hashlib`` is available
4597 * Keep site directories (e.g. ``site-packages``) from being included in
4603 * Fixed ``distutils.filelist.findall()`` crashing on broken symlinks, and
4604 ``egg_info`` command failing on new, uncommitted SVN directories.
4606 * Fix import problems with nested namespace packages installed via
4607 ``--root`` or ``--single-version-externally-managed``, due to the
4608 parent package not having the child package as an attribute.
4610 * ``ftp:`` download URLs now work correctly.
4612 * The default ``--index-url`` is now ``https://pypi.python.org/simple``, to use
4613 the Python Package Index's new simpler (and faster!) REST API.
4618 * Added ``--egg-path`` option to ``develop`` command, allowing you to force
4619 ``.egg-link`` files to use relative paths (allowing them to be shared across
4620 platforms on a networked drive).
4622 * Fix not building binary RPMs correctly.
4624 * Fix "eggsecutables" (such as setuptools' own egg) only being runnable with
4625 bash-compatible shells.
4627 * Fix ``#!`` parsing problems in Windows ``.exe`` script wrappers, when there
4628 was whitespace inside a quoted argument or at the end of the ``#!`` line
4629 (a regression introduced in 0.6c4).
4631 * Fix ``test`` command possibly failing if an older version of the project
4632 being tested was installed on ``sys.path`` ahead of the test source
4635 * Fix ``find_packages()`` treating ``ez_setup`` and directories with ``.`` in
4636 their names as packages.
4638 * EasyInstall no longer aborts the installation process if a URL it wants to
4639 retrieve can't be downloaded, unless the URL is an actual package download.
4640 Instead, it issues a warning and tries to keep going.
4642 * Fixed distutils-style scripts originally built on Windows having their line
4643 endings doubled when installed on any platform.
4645 * Added ``--local-snapshots-ok`` flag, to allow building eggs from projects
4646 installed using ``setup.py develop``.
4648 * Fixed not HTML-decoding URLs scraped from web pages
4653 * Fix uploaded ``bdist_rpm`` packages being described as ``bdist_egg``
4654 packages under Python versions less than 2.5.
4656 * Fix uploaded ``bdist_wininst`` packages being described as suitable for
4657 "any" version by Python 2.5, even if a ``--target-version`` was specified.
4659 * Fixed ``.dll`` files on Cygwin not having executable permissions when an egg
4660 is installed unzipped.
4665 * Overhauled Windows script wrapping to support ``bdist_wininst`` better.
4666 Scripts installed with ``bdist_wininst`` will always use ``#!python.exe`` or
4667 ``#!pythonw.exe`` as the executable name (even when built on non-Windows
4668 platforms!), and the wrappers will look for the executable in the script's
4669 parent directory (which should find the right version of Python).
4671 * Fix ``upload`` command not uploading files built by ``bdist_rpm`` or
4672 ``bdist_wininst`` under Python 2.3 and 2.4.
4674 * Add support for "eggsecutable" headers: a ``#!/bin/sh`` script that is
4675 prepended to an ``.egg`` file to allow it to be run as a script on Unix-ish
4676 platforms. (This is mainly so that setuptools itself can have a single-file
4677 installer on Unix, without doing multiple downloads, dealing with firewalls,
4680 * Fix problem with empty revision numbers in Subversion 1.4 ``entries`` files
4682 * Use cross-platform relative paths in ``easy-install.pth`` when doing
4683 ``develop`` and the source directory is a subdirectory of the installation
4686 * Fix a problem installing eggs with a system packaging tool if the project
4687 contained an implicit namespace package; for example if the ``setup()``
4688 listed a namespace package ``foo.bar`` without explicitly listing ``foo``
4689 as a namespace package.
4691 * Added support for HTTP "Basic" authentication using ``http://user:pass@host``
4692 URLs. If a password-protected page contains links to the same host (and
4693 protocol), those links will inherit the credentials used to access the
4696 * Removed all special support for Sourceforge mirrors, as Sourceforge's
4697 mirror system now works well for non-browser downloads.
4699 * Fixed not recognizing ``win32.exe`` installers that included a custom
4702 * Fixed not allowing ``os.open()`` of paths outside the sandbox, even if they
4703 are opened read-only (e.g. reading ``/dev/urandom`` for random numbers, as
4704 is done by ``os.urandom()`` on some platforms).
4706 * Fixed a problem with ``.pth`` testing on Windows when ``sys.executable``
4707 has a space in it (e.g., the user installed Python to a ``Program Files``
4713 * Fixed breakages caused by Subversion 1.4's new "working copy" format
4715 * You can once again use "python -m easy_install" with Python 2.4 and above.
4717 * Python 2.5 compatibility fixes added.
4722 * The ``ez_setup`` module displays the conflicting version of setuptools (and
4723 its installation location) when a script requests a version that's not
4726 * Running ``setup.py develop`` on a setuptools-using project will now install
4727 setuptools if needed, instead of only downloading the egg.
4729 * Windows script wrappers now support quoted arguments and arguments
4730 containing spaces. (Patch contributed by Jim Fulton.)
4732 * The ``ez_setup.py`` script now actually works when you put a setuptools
4733 ``.egg`` alongside it for bootstrapping an offline machine.
4735 * A writable installation directory on ``sys.path`` is no longer required to
4736 download and extract a source distribution using ``--editable``.
4738 * Generated scripts now use ``-x`` on the ``#!`` line when ``sys.executable``
4739 contains non-ASCII characters, to prevent deprecation warnings about an
4740 unspecified encoding when the script is run.
4745 * Fixed ``AttributeError`` when trying to download a ``setup_requires``
4746 dependency when a distribution lacks a ``dependency_links`` setting.
4748 * Made ``zip-safe`` and ``not-zip-safe`` flag files contain a single byte, so
4749 as to play better with packaging tools that complain about zero-length
4752 * Made ``setup.py develop`` respect the ``--no-deps`` option, which it
4753 previously was ignoring.
4755 * Support ``extra_path`` option to ``setup()`` when ``install`` is run in
4756 backward-compatibility mode.
4758 * Source distributions now always include a ``setup.cfg`` file that explicitly
4759 sets ``egg_info`` options such that they produce an identical version number
4760 to the source distribution's version number. (Previously, the default
4761 version number could be different due to the use of ``--tag-date``, or if
4762 the version was overridden on the command line that built the source
4765 * EasyInstall now includes setuptools version information in the
4766 ``User-Agent`` string sent to websites it visits.
4771 * Fix ``register`` not obeying name/version set by ``egg_info`` command, if
4772 ``egg_info`` wasn't explicitly run first on the same command line.
4774 * Added ``--no-date`` and ``--no-svn-revision`` options to ``egg_info``
4775 command, to allow suppressing tags configured in ``setup.cfg``.
4777 * Fixed redundant warnings about missing ``README`` file(s); it should now
4778 appear only if you are actually a source distribution.
4780 * Fix creating Python wrappers for non-Python scripts
4782 * Fix ``ftp://`` directory listing URLs from causing a crash when used in the
4783 "Home page" or "Download URL" slots on PyPI.
4785 * Fix ``sys.path_importer_cache`` not being updated when an existing zipfile
4786 or directory is deleted/overwritten.
4788 * Fix not recognizing HTML 404 pages from package indexes.
4790 * Allow ``file://`` URLs to be used as a package index. URLs that refer to
4791 directories will use an internally-generated directory listing if there is
4792 no ``index.html`` file in the directory.
4794 * Allow external links in a package index to be specified using
4795 ``rel="homepage"`` or ``rel="download"``, without needing the old
4796 PyPI-specific visible markup.
4798 * Suppressed warning message about possibly-misspelled project name, if an egg
4799 or link for that project name has already been seen.
4804 * Fix ``bdist_egg`` not including files in subdirectories of ``.egg-info``.
4806 * Allow ``.py`` files found by the ``include_package_data`` option to be
4807 automatically included. Remove duplicate data file matches if both
4808 ``include_package_data`` and ``package_data`` are used to refer to the same
4811 * Fix local ``--find-links`` eggs not being copied except with
4814 * Fix sometimes not detecting local packages installed outside of "site"
4817 * Fix mysterious errors during initial ``setuptools`` install, caused by
4818 ``ez_setup`` trying to run ``easy_install`` twice, due to a code fallthru
4819 after deleting the egg from which it's running.
4824 * Don't install or update a ``site.py`` patch when installing to a
4825 ``PYTHONPATH`` directory with ``--multi-version``, unless an
4826 ``easy-install.pth`` file is already in use there.
4828 * Construct ``.pth`` file paths in such a way that installing an egg whose
4829 name begins with ``import`` doesn't cause a syntax error.
4831 * Fixed a bogus warning message that wasn't updated since the 0.5 versions.
4836 * Strip ``module`` from the end of compiled extension modules when computing
4837 the name of a ``.py`` loader/wrapper. (Python's import machinery ignores
4838 this suffix when searching for an extension module.)
4840 * Better ambiguity management: accept ``#egg`` name/version even if processing
4841 what appears to be a correctly-named distutils file, and ignore ``.egg``
4842 files with no ``-``, since valid Python ``.egg`` files always have a version
4843 number (but Scheme eggs often don't).
4845 * Support ``file://`` links to directories in ``--find-links``, so that
4846 easy_install can build packages from local source checkouts.
4848 * Added automatic retry for Sourceforge mirrors. The new download process is
4849 to first just try dl.sourceforge.net, then randomly select mirror IPs and
4850 remove ones that fail, until something works. The removed IPs stay removed
4851 for the remainder of the run.
4853 * Ignore bdist_dumb distributions when looking at download URLs.
4858 * Added ``test_loader`` keyword to support custom test loaders
4860 * Added ``setuptools.file_finders`` entry point group to allow implementing
4861 revision control plugins.
4863 * Added ``--identity`` option to ``upload`` command.
4865 * Added ``dependency_links`` to allow specifying URLs for ``--find-links``.
4867 * Enhanced test loader to scan packages as well as modules, and call
4868 ``additional_tests()`` if present to get non-unittest tests.
4870 * Support namespace packages in conjunction with system packagers, by omitting
4871 the installation of any ``__init__.py`` files for namespace packages, and
4872 adding a special ``.pth`` file to create a working package in
4875 * Made ``--single-version-externally-managed`` automatic when ``--root`` is
4876 used, so that most system packagers won't require special support for
4879 * Fixed ``setup_requires``, ``tests_require``, etc. not using ``setup.cfg`` or
4880 other configuration files for their option defaults when installing, and
4881 also made the install use ``--multi-version`` mode so that the project
4882 directory doesn't need to support .pth files.
4884 * ``MANIFEST.in`` is now forcibly closed when any errors occur while reading
4885 it. Previously, the file could be left open and the actual error would be
4886 masked by problems trying to remove the open file on Windows systems.
4888 * Process ``dependency_links.txt`` if found in a distribution, by adding the
4889 URLs to the list for scanning.
4891 * Use relative paths in ``.pth`` files when eggs are being installed to the
4892 same directory as the ``.pth`` file. This maximizes portability of the
4893 target directory when building applications that contain eggs.
4895 * Added ``easy_install-N.N`` script(s) for convenience when using multiple
4898 * Added automatic handling of installation conflicts. Eggs are now shifted to
4899 the front of sys.path, in an order consistent with where they came from,
4900 making EasyInstall seamlessly co-operate with system package managers.
4902 The ``--delete-conflicting`` and ``--ignore-conflicts-at-my-risk`` options
4903 are now no longer necessary, and will generate warnings at the end of a
4904 run if you use them.
4906 * Don't recursively traverse subdirectories given to ``--find-links``.
4911 * Fixed the ``develop`` command ignoring ``--find-links``.
4913 * Added exhaustive testing of the install directory, including a spawn test
4914 for ``.pth`` file support, and directory writability/existence checks. This
4915 should virtually eliminate the need to set or configure ``--site-dirs``.
4917 * Added ``--prefix`` option for more do-what-I-mean-ishness in the absence of
4920 * Enhanced ``PYTHONPATH`` support so that you don't have to put any eggs on it
4921 manually to make it work. ``--multi-version`` is no longer a silent
4922 default; you must explicitly use it if installing to a non-PYTHONPATH,
4923 non-"site" directory.
4925 * Expand ``$variables`` used in the ``--site-dirs``, ``--build-directory``,
4926 ``--install-dir``, and ``--script-dir`` options, whether on the command line
4927 or in configuration files.
4929 * Improved SourceForge mirror processing to work faster and be less affected
4930 by transient HTML changes made by SourceForge.
4932 * PyPI searches now use the exact spelling of requirements specified on the
4933 command line or in a project's ``install_requires``. Previously, a
4934 normalized form of the name was used, which could lead to unnecessary
4935 full-index searches when a project's name had an underscore (``_``) in it.
4937 * EasyInstall can now download bare ``.py`` files and wrap them in an egg,
4938 as long as you include an ``#egg=name-version`` suffix on the URL, or if
4939 the ``.py`` file is listed as the "Download URL" on the project's PyPI page.
4940 This allows third parties to "package" trivial Python modules just by
4941 linking to them (e.g. from within their own PyPI page or download links
4944 * The ``--always-copy`` option now skips "system" and "development" eggs since
4945 they can't be reliably copied. Note that this may cause EasyInstall to
4946 choose an older version of a package than what you expected, or it may cause
4947 downloading and installation of a fresh version of what's already installed.
4949 * The ``--find-links`` option previously scanned all supplied URLs and
4950 directories as early as possible, but now only directories and direct
4951 archive links are scanned immediately. URLs are not retrieved unless a
4952 package search was already going to go online due to a package not being
4953 available locally, or due to the use of the ``--update`` or ``-U`` option.
4955 * Fixed the annoying ``--help-commands`` wart.
4960 * The ``sdist`` command no longer uses the traditional ``MANIFEST`` file to
4961 create source distributions. ``MANIFEST.in`` is still read and processed,
4962 as are the standard defaults and pruning. But the manifest is built inside
4963 the project's ``.egg-info`` directory as ``SOURCES.txt``, and it is rebuilt
4964 every time the ``egg_info`` command is run.
4966 * Added the ``include_package_data`` keyword to ``setup()``, allowing you to
4967 automatically include any package data listed in revision control or
4970 * Added the ``exclude_package_data`` keyword to ``setup()``, allowing you to
4971 trim back files included via the ``package_data`` and
4972 ``include_package_data`` options.
4974 * Fixed ``--tag-svn-revision`` not working when run from a source
4977 * Added warning for namespace packages with missing ``declare_namespace()``
4979 * Added ``tests_require`` keyword to ``setup()``, so that e.g. packages
4980 requiring ``nose`` to run unit tests can make this dependency optional
4981 unless the ``test`` command is run.
4983 * Made all commands that use ``easy_install`` respect its configuration
4984 options, as this was causing some problems with ``setup.py install``.
4986 * Added an ``unpack_directory()`` driver to ``setuptools.archive_util``, so
4987 that you can process a directory tree through a processing filter as if it
4988 were a zipfile or tarfile.
4990 * Added an internal ``install_egg_info`` command to use as part of old-style
4991 ``install`` operations, that installs an ``.egg-info`` directory with the
4994 * Added a ``--single-version-externally-managed`` option to the ``install``
4995 command so that you can more easily wrap a "flat" egg in a system package.
4997 * Enhanced ``bdist_rpm`` so that it installs single-version eggs that
4998 don't rely on a ``.pth`` file. The ``--no-egg`` option has been removed,
4999 since all RPMs are now built in a more backwards-compatible format.
5001 * Support full roundtrip translation of eggs to and from ``bdist_wininst``
5002 format. Running ``bdist_wininst`` on a setuptools-based package wraps the
5003 egg in an .exe that will safely install it as an egg (i.e., with metadata
5004 and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
5005 back into an ``.egg`` file or directory and install it as such.
5007 * Fixed ``.pth`` file processing picking up nested eggs (i.e. ones inside
5008 "baskets") when they weren't explicitly listed in the ``.pth`` file.
5010 * If more than one URL appears to describe the exact same distribution, prefer
5011 the shortest one. This helps to avoid "table of contents" CGI URLs like the
5014 * Quote arguments to python.exe (including python's path) to avoid problems
5015 when Python (or a script) is installed in a directory whose name contains
5018 * Support full roundtrip translation of eggs to and from ``bdist_wininst``
5019 format. Running ``bdist_wininst`` on a setuptools-based package wraps the
5020 egg in an .exe that will safely install it as an egg (i.e., with metadata
5021 and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
5022 back into an ``.egg`` file or directory and install it as such.
5027 * Fixed some problems building extensions when Pyrex was installed, especially
5028 with Python 2.4 and/or packages using SWIG.
5030 * Made ``develop`` command accept all the same options as ``easy_install``,
5031 and use the ``easy_install`` command's configuration settings as defaults.
5033 * Made ``egg_info --tag-svn-revision`` fall back to extracting the revision
5034 number from ``PKG-INFO`` in case it is being run on a source distribution of
5035 a snapshot taken from a Subversion-based project.
5037 * Automatically detect ``.dll``, ``.so`` and ``.dylib`` files that are being
5038 installed as data, adding them to ``native_libs.txt`` automatically.
5040 * Fixed some problems with fresh checkouts of projects that don't include
5041 ``.egg-info/PKG-INFO`` under revision control and put the project's source
5042 code directly in the project directory. If such a package had any
5043 requirements that get processed before the ``egg_info`` command can be run,
5044 the setup scripts would fail with a "Missing 'Version:' header and/or
5045 PKG-INFO file" error, because the egg runtime interpreted the unbuilt
5046 metadata in a directory on ``sys.path`` (i.e. the current directory) as
5047 being a corrupted egg. Setuptools now monkeypatches the distribution
5048 metadata cache to pretend that the egg has valid version information, until
5049 it has a chance to make it actually be so (via the ``egg_info`` command).
5051 * Update for changed SourceForge mirror format
5053 * Fixed not installing dependencies for some packages fetched via Subversion
5055 * Fixed dependency installation with ``--always-copy`` not using the same
5056 dependency resolution procedure as other operations.
5058 * Fixed not fully removing temporary directories on Windows, if a Subversion
5059 checkout left read-only files behind
5061 * Fixed some problems building extensions when Pyrex was installed, especially
5062 with Python 2.4 and/or packages using SWIG.
5067 * Fixed not being able to install Windows script wrappers using Python 2.3
5072 * Added support for "traditional" PYTHONPATH-based non-root installation, and
5073 also the convenient ``virtual-python.py`` script, based on a contribution
5074 by Ian Bicking. The setuptools egg now contains a hacked ``site`` module
5075 that makes the PYTHONPATH-based approach work with .pth files, so that you
5076 can get the full EasyInstall feature set on such installations.
5078 * Added ``--no-deps`` and ``--allow-hosts`` options.
5080 * Improved Windows ``.exe`` script wrappers so that the script can have the
5081 same name as a module without confusing Python.
5083 * Changed dependency processing so that it's breadth-first, allowing a
5084 depender's preferences to override those of a dependee, to prevent conflicts
5085 when a lower version is acceptable to the dependee, but not the depender.
5086 Also, ensure that currently installed/selected packages aren't given
5087 precedence over ones desired by a package being installed, which could
5088 cause conflict errors.
5093 * Fixed missing gui/cli .exe files in distribution. Fixed bugs in tests.
5098 * Added ``gui_scripts`` entry point group to allow installing GUI scripts
5099 on Windows and other platforms. (The special handling is only for Windows;
5100 other platforms are treated the same as for ``console_scripts``.)
5102 * Improved error message when trying to use old ways of running
5103 ``easy_install``. Removed the ability to run via ``python -m`` or by
5104 running ``easy_install.py``; ``easy_install`` is the command to run on all
5105 supported platforms.
5107 * Improved wrapper script generation and runtime initialization so that a
5108 VersionConflict doesn't occur if you later install a competing version of a
5109 needed package as the default version of that package.
5111 * Fixed a problem parsing version numbers in ``#egg=`` links.
5116 * Added ``console_scripts`` entry point group to allow installing scripts
5117 without the need to create separate script files. On Windows, console
5118 scripts get an ``.exe`` wrapper so you can just type their name. On other
5119 platforms, the scripts are written without a file extension.
5121 * EasyInstall can now install "console_scripts" defined by packages that use
5122 ``setuptools`` and define appropriate entry points. On Windows, console
5123 scripts get an ``.exe`` wrapper so you can just type their name. On other
5124 platforms, the scripts are installed without a file extension.
5126 * Using ``python -m easy_install`` or running ``easy_install.py`` is now
5127 DEPRECATED, since an ``easy_install`` wrapper is now available on all
5133 * Added support for building "old-style" RPMs that don't install an egg for
5134 the target package, using a ``--no-egg`` option.
5136 * The ``build_ext`` command now works better when using the ``--inplace``
5137 option and multiple Python versions. It now makes sure that all extensions
5138 match the current Python version, even if newer copies were built for a
5139 different Python version.
5141 * The ``upload`` command no longer attaches an extra ``.zip`` when uploading
5142 eggs, as PyPI now supports egg uploads without trickery.
5144 * The ``ez_setup`` script/module now displays a warning before downloading
5145 the setuptools egg, and attempts to check the downloaded egg against an
5146 internal MD5 checksum table.
5148 * Fixed the ``--tag-svn-revision`` option of ``egg_info`` not finding the
5149 latest revision number; it was using the revision number of the directory
5150 containing ``setup.py``, not the highest revision number in the project.
5152 * Added ``eager_resources`` setup argument
5154 * The ``sdist`` command now recognizes Subversion "deleted file" entries and
5155 does not include them in source distributions.
5157 * ``setuptools`` now embeds itself more thoroughly into the distutils, so that
5158 other distutils extensions (e.g. py2exe, py2app) will subclass setuptools'
5159 versions of things, rather than the native distutils ones.
5161 * Added ``entry_points`` and ``setup_requires`` arguments to ``setup()``;
5162 ``setup_requires`` allows you to automatically find and download packages
5163 that are needed in order to *build* your project (as opposed to running it).
5165 * ``setuptools`` now finds its commands, ``setup()`` argument validators, and
5166 metadata writers using entry points, so that they can be extended by
5167 third-party packages. See `Creating distutils Extensions
5168 <https://setuptools.readthedocs.io/en/latest/setuptools.html#creating-distutils-extensions>`_
5171 * The vestigial ``depends`` command has been removed. It was never finished
5172 or documented, and never would have worked without EasyInstall - which it
5173 pre-dated and was never compatible with.
5175 * EasyInstall now does MD5 validation of downloads from PyPI, or from any link
5176 that has an "#md5=..." trailer with a 32-digit lowercase hex md5 digest.
5178 * EasyInstall now handles symlinks in target directories by removing the link,
5179 rather than attempting to overwrite the link's destination. This makes it
5180 easier to set up an alternate Python "home" directory (as described in
5181 the Non-Root Installation section of the docs).
5183 * Added support for handling MacOS platform information in ``.egg`` filenames,
5184 based on a contribution by Kevin Dangoor. You may wish to delete and
5185 reinstall any eggs whose filename includes "darwin" and "Power_Macintosh",
5186 because the format for this platform information has changed so that minor
5187 OS X upgrades (such as 10.4.1 to 10.4.2) do not cause eggs built with a
5188 previous OS version to become obsolete.
5190 * easy_install's dependency processing algorithms have changed. When using
5191 ``--always-copy``, it now ensures that dependencies are copied too. When
5192 not using ``--always-copy``, it tries to use a single resolution loop,
5193 rather than recursing.
5195 * Fixed installing extra ``.pyc`` or ``.pyo`` files for scripts with ``.py``
5198 * Added ``--site-dirs`` option to allow adding custom "site" directories.
5199 Made ``easy-install.pth`` work in platform-specific alternate site
5200 directories (e.g. ``~/Library/Python/2.x/site-packages`` on Mac OS X).
5202 * If you manually delete the current version of a package, the next run of
5203 EasyInstall against the target directory will now remove the stray entry
5204 from the ``easy-install.pth`` file.
5206 * EasyInstall now recognizes URLs with a ``#egg=project_name`` fragment ID
5207 as pointing to the named project's source checkout. Such URLs have a lower
5208 match precedence than any other kind of distribution, so they'll only be
5209 used if they have a higher version number than any other available
5210 distribution, or if you use the ``--editable`` option. The ``#egg``
5211 fragment can contain a version if it's formatted as ``#egg=proj-ver``,
5212 where ``proj`` is the project name, and ``ver`` is the version number. You
5213 *must* use the format for these values that the ``bdist_egg`` command uses;
5214 i.e., all non-alphanumeric runs must be condensed to single underscore
5217 * Added the ``--editable`` option; see Editing and Viewing Source Packages
5218 in the docs. Also, slightly changed the behavior of the
5219 ``--build-directory`` option.
5221 * Fixed the setup script sandbox facility not recognizing certain paths as
5222 valid on case-insensitive platforms.
5227 * The zip-safety scanner now checks for modules that might be used with
5228 ``python -m``, and marks them as unsafe for zipping, since Python 2.4 can't
5229 handle ``-m`` on zipped modules.
5231 * Fix ``python -m easy_install`` not working due to setuptools being installed
5232 as a zipfile. Update safety scanner to check for modules that might be used
5233 as ``python -m`` scripts.
5235 * Misc. fixes for win32.exe support, including changes to support Python 2.4's
5236 changed ``bdist_wininst`` format.
5241 * Fix breakage of the "develop" command that was caused by the addition of
5242 ``--always-unzip`` to the ``easy_install`` command.
5247 * Put the ``easy_install`` module back in as a module, as it's needed for
5248 ``python -m`` to run it!
5250 * Allow ``--find-links/-f`` to accept local directories or filenames as well
5256 * Include ``svn:externals`` directories in source distributions as well as
5257 normal subversion-controlled files and directories.
5259 * Added ``exclude=patternlist`` option to ``setuptools.find_packages()``
5261 * Changed --tag-svn-revision to include an "r" in front of the revision number
5262 for better readability.
5264 * Added ability to build eggs without including source files (except for any
5265 scripts, of course), using the ``--exclude-source-files`` option to
5268 * ``setup.py install`` now automatically detects when an "unmanaged" package
5269 or module is going to be on ``sys.path`` ahead of a package being installed,
5270 thereby preventing the newer version from being imported. If this occurs,
5271 a warning message is output to ``sys.stderr``, but installation proceeds
5272 anyway. The warning message informs the user what files or directories
5273 need deleting, and advises them they can also use EasyInstall (with the
5274 ``--delete-conflicting`` option) to do it automatically.
5276 * The ``egg_info`` command now adds a ``top_level.txt`` file to the metadata
5277 directory that lists all top-level modules and packages in the distribution.
5278 This is used by the ``easy_install`` command to find possibly-conflicting
5279 "unmanaged" packages when installing the distribution.
5281 * Added ``zip_safe`` and ``namespace_packages`` arguments to ``setup()``.
5282 Added package analysis to determine zip-safety if the ``zip_safe`` flag
5283 is not given, and advise the author regarding what code might need changing.
5285 * Fixed the swapped ``-d`` and ``-b`` options of ``bdist_egg``.
5287 * EasyInstall now automatically detects when an "unmanaged" package or
5288 module is going to be on ``sys.path`` ahead of a package you're installing,
5289 thereby preventing the newer version from being imported. By default, it
5290 will abort installation to alert you of the problem, but there are also
5291 new options (``--delete-conflicting`` and ``--ignore-conflicts-at-my-risk``)
5292 available to change the default behavior. (Note: this new feature doesn't
5293 take effect for egg files that were built with older ``setuptools``
5294 versions, because they lack the new metadata file required to implement it.)
5296 * The ``easy_install`` distutils command now uses ``DistutilsError`` as its
5297 base error type for errors that should just issue a message to stderr and
5298 exit the program without a traceback.
5300 * EasyInstall can now be given a path to a directory containing a setup
5301 script, and it will attempt to build and install the package there.
5303 * EasyInstall now performs a safety analysis on module contents to determine
5304 whether a package is likely to run in zipped form, and displays
5305 information about what modules may be doing introspection that would break
5306 when running as a zipfile.
5308 * Added the ``--always-unzip/-Z`` option, to force unzipping of packages that
5309 would ordinarily be considered safe to unzip, and changed the meaning of
5310 ``--zip-ok/-z`` to "always leave everything zipped".
5315 * The "egg_info" command now always sets the distribution metadata to "safe"
5316 forms of the distribution name and version, so that distribution files will
5317 be generated with parseable names (i.e., ones that don't include '-' in the
5318 name or version). Also, this means that if you use the various ``--tag``
5319 options of "egg_info", any distributions generated will use the tags in the
5320 version, not just egg distributions.
5322 * Added support for defining command aliases in distutils configuration files,
5323 under the "[aliases]" section. To prevent recursion and to allow aliases to
5324 call the command of the same name, a given alias can be expanded only once
5325 per command-line invocation. You can define new aliases with the "alias"
5326 command, either for the local, global, or per-user configuration.
5328 * Added "rotate" command to delete old distribution files, given a set of
5329 patterns to match and the number of files to keep. (Keeps the most
5330 recently-modified distribution files matching each pattern.)
5332 * Added "saveopts" command that saves all command-line options for the current
5333 invocation to the local, global, or per-user configuration file. Useful for
5334 setting defaults without having to hand-edit a configuration file.
5336 * Added a "setopt" command that sets a single option in a specified distutils
5339 * There is now a separate documentation page for setuptools; revision
5340 history that's not specific to EasyInstall has been moved to that page.
5345 * Added "upload" support for egg and source distributions, including a bug
5346 fix for "upload" and a temporary workaround for lack of .egg support in
5352 * Beefed up the "sdist" command so that if you don't have a MANIFEST.in, it
5353 will include all files under revision control (CVS or Subversion) in the
5354 current directory, and it will regenerate the list every time you create a
5355 source distribution, not just when you tell it to. This should make the
5356 default "do what you mean" more often than the distutils' default behavior
5357 did, while still retaining the old behavior in the presence of MANIFEST.in.
5359 * Fixed the "develop" command always updating .pth files, even if you
5360 specified ``-n`` or ``--dry-run``.
5362 * Slightly changed the format of the generated version when you use
5363 ``--tag-build`` on the "egg_info" command, so that you can make tagged
5364 revisions compare *lower* than the version specified in setup.py (e.g. by
5365 using ``--tag-build=dev``).
5370 * Added ``develop`` command to ``setuptools``-based packages. This command
5371 installs an ``.egg-link`` pointing to the package's source directory, and
5372 script wrappers that ``execfile()`` the source versions of the package's
5373 scripts. This lets you put your development checkout(s) on sys.path without
5374 having to actually install them. (To uninstall the link, use
5375 use ``setup.py develop --uninstall``.)
5377 * Added ``egg_info`` command to ``setuptools``-based packages. This command
5378 just creates or updates the "projectname.egg-info" directory, without
5379 building an egg. (It's used by the ``bdist_egg``, ``test``, and ``develop``
5382 * Enhanced the ``test`` command so that it doesn't install the package, but
5383 instead builds any C extensions in-place, updates the ``.egg-info``
5384 metadata, adds the source directory to ``sys.path``, and runs the tests
5385 directly on the source. This avoids an "unmanaged" installation of the
5386 package to ``site-packages`` or elsewhere.
5388 * Made ``easy_install`` a standard ``setuptools`` command, moving it from
5389 the ``easy_install`` module to ``setuptools.command.easy_install``. Note
5390 that if you were importing or extending it, you must now change your imports
5391 accordingly. ``easy_install.py`` is still installed as a script, but not as
5397 * Setup scripts using setuptools can now list their dependencies directly in
5398 the setup.py file, without having to manually create a ``depends.txt`` file.
5399 The ``install_requires`` and ``extras_require`` arguments to ``setup()``
5400 are used to create a dependencies file automatically. If you are manually
5401 creating ``depends.txt`` right now, please switch to using these setup
5402 arguments as soon as practical, because ``depends.txt`` support will be
5403 removed in the 0.6 release cycle. For documentation on the new arguments,
5404 see the ``setuptools.dist.Distribution`` class.
5406 * Setup scripts using setuptools now always install using ``easy_install``
5407 internally, for ease of uninstallation and upgrading.
5409 * Added ``--always-copy/-a`` option to always copy needed packages to the
5410 installation directory, even if they're already present elsewhere on
5411 sys.path. (In previous versions, this was the default behavior, but now
5412 you must request it.)
5414 * Added ``--upgrade/-U`` option to force checking PyPI for latest available
5415 version(s) of all packages requested by name and version, even if a matching
5416 version is available locally.
5418 * Added automatic installation of dependencies declared by a distribution
5419 being installed. These dependencies must be listed in the distribution's
5420 ``EGG-INFO`` directory, so the distribution has to have declared its
5421 dependencies by using setuptools. If a package has requirements it didn't
5422 declare, you'll still have to deal with them yourself. (E.g., by asking
5423 EasyInstall to find and install them.)
5425 * Added the ``--record`` option to ``easy_install`` for the benefit of tools
5426 that run ``setup.py install --record=filename`` on behalf of another
5432 * Fixed not setting script permissions to allow execution.
5434 * Improved sandboxing so that setup scripts that want a temporary directory
5435 (e.g. pychecker) can still run in the sandbox.
5440 * Fix stupid stupid refactoring-at-the-last-minute typos. :(
5445 * Added support for "self-installation" bootstrapping. Packages can now
5446 include ``ez_setup.py`` in their source distribution, and add the following
5447 to their ``setup.py``, in order to automatically bootstrap installation of
5448 setuptools as part of their setup process::
5450 from ez_setup import use_setuptools
5453 from setuptools import setup
5456 * Added support for converting ``.win32.exe`` installers to eggs on the fly.
5457 EasyInstall will now recognize such files by name and install them.
5459 * Fixed a problem with picking the "best" version to install (versions were
5460 being sorted as strings, rather than as parsed values)
5465 * Added support for the distutils "verbose/quiet" and "dry-run" options, as
5466 well as the "optimize" flag.
5468 * Support downloading packages that were uploaded to PyPI (by scanning all
5469 links on package pages, not just the homepage/download links).
5474 * Add progress messages to the search/download process so that you can tell
5475 what URLs it's reading to find download links. (Hopefully, this will help
5476 people report out-of-date and broken links to package authors, and to tell
5477 when they've asked for a package that doesn't exist.)
5482 * Added ``ez_setup.py`` installer/bootstrap script to make initial setuptools
5483 installation easier, and to allow distributions using setuptools to avoid
5484 having to include setuptools in their source distribution.
5486 * All downloads are now managed by the ``PackageIndex`` class (which is now
5487 subclassable and replaceable), so that embedders can more easily override
5488 download logic, give download progress reports, etc. The class has also
5489 been moved to the new ``setuptools.package_index`` module.
5491 * The ``Installer`` class no longer handles downloading, manages a temporary
5492 directory, or tracks the ``zip_ok`` option. Downloading is now handled
5493 by ``PackageIndex``, and ``Installer`` has become an ``easy_install``
5494 command class based on ``setuptools.Command``.
5496 * There is a new ``setuptools.sandbox.run_setup()`` API to invoke a setup
5497 script in a directory sandbox, and a new ``setuptools.archive_util`` module
5498 with an ``unpack_archive()`` API. These were split out of EasyInstall to
5499 allow reuse by other tools and applications.
5501 * ``setuptools.Command`` now supports reinitializing commands using keyword
5502 arguments to set/reset options. Also, ``Command`` subclasses can now set
5503 their ``command_consumes_arguments`` attribute to ``True`` in order to
5504 receive an ``args`` option containing the rest of the command line.
5506 * Added support for installing scripts
5508 * Added support for setting options via distutils configuration files, and
5509 using distutils' default options as a basis for EasyInstall's defaults.
5511 * Renamed ``--scan-url/-s`` to ``--find-links/-f`` to free up ``-s`` for the
5512 script installation directory option.
5514 * Use ``urllib2`` instead of ``urllib``, to allow use of ``https:`` URLs if
5515 Python includes SSL support.
5520 * Added ``--scan-url`` and ``--index-url`` options, to scan download pages
5521 and search PyPI for needed packages.
5526 * Restrict ``--build-directory=DIR/-b DIR`` option to only be used with single
5527 URL installs, to avoid running the wrong setup.py.
5532 * Added ``--build-directory=DIR/-b DIR`` option.
5534 * Added "installation report" that explains how to use 'require()' when doing
5535 a multiversion install or alternate installation directory.
5537 * Added SourceForge mirror auto-select (Contributed by Ian Bicking)
5539 * Added "sandboxing" that stops a setup script from running if it attempts to
5540 write to the filesystem outside of the build area
5542 * Added more workarounds for packages with quirky ``install_data`` hacks
5547 * Added new options to ``bdist_egg`` to allow tagging the egg's version number
5548 with a subversion revision number, the current date, or an explicit tag
5549 value. Run ``setup.py bdist_egg --help`` to get more information.
5551 * Added subversion download support for ``svn:`` and ``svn+`` URLs, as well as
5552 automatic recognition of HTTP subversion URLs (Contributed by Ian Bicking)
projects / platform / upstream / python3-setuptools.git / blob