7 * #2497: Officially deprecated PEP 440 non-compliant versions.
11 * #2932: Removed the deprecated ``data_files`` option from the example in the
12 declarative configuration docs -- by :user:`abravalheri`
13 * #2932: Change type of ``data_files`` option from ``dict`` to ``section`` in
14 declarative configuration docs (to match previous example) -- by
24 * #917: ``setup.py install`` and ``easy_install`` commands are now officially deprecated. Use other standards-based installers (like pip) and builders (like build). Workloads reliant on this behavior should pin to this major version of Setuptools.
25 * #1988: Deprecated the ``bdist_rpm`` command. Binary packages should be built as wheels instead.
27 * #2785: Replace ``configparser``'s ``readfp`` with ``read_file``, deprecated since Python 3.2.
29 * #2823: Officially deprecated support for ``setup_requires``. Users are encouraged instead to migrate to PEP 518 ``build-system.requires`` in ``pyproject.toml``. Users reliant on ``setup_requires`` should consider pinning to this major version to avoid disruption.
33 * #2762: Changed codecov.yml to configure the threshold to be lower
34 -- by :user:`tanvimoharir`
43 * #2757: Add windows arm64 launchers for scripts generated by easy_install.
44 * #2800: Added ``--owner`` and ``--group`` options to the ``sdist`` command,
45 for specifying file ownership within the produced tarball (similarly
46 to the corresponding distutils ``sdist`` options).
50 * #2792: Document how the legacy and non-legacy versions are compared, and reference to the `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_ scheme.
59 * #2796: Merge with pypa/distutils@02e9f65ab0
68 * #2773: Retain case in setup.cfg during sdist.
77 * #2777: Build does not fail fast when ``use_2to3`` is supplied but set to a false value.
86 * #2769: Build now fails fast when ``use_2to3`` is supplied.
95 * #2765: In Distribution.finalize_options, suppress known removed entry points to avoid issues with older Setuptools.
104 * #2086: Removed support for 2to3 during builds. Projects should port to a unified codebase or pin to an older version of Setuptools using PEP 518 build-requires.
106 Documentation changes
107 ^^^^^^^^^^^^^^^^^^^^^
108 * #2746: add python_requires example
117 * #2712: Added implicit globbing support for `[options.data_files]` values.
119 Documentation changes
120 ^^^^^^^^^^^^^^^^^^^^^
121 * #2737: fix various syntax and style errors in code snippets in docs
130 * #2722: Added support for ``SETUPTOOLS_EXT_SUFFIX`` environment variable to override the suffix normally detected from the ``sysconfig`` module.
139 * #2465: Documentation is now published using the Furo theme.
148 * #2724: Added detection of Windows ARM64 build environments using the ``VSCMD_ARG_TGT_ARCH`` environment variable.
157 * #2692: Globs are now sorted in 'license_files' restoring reproducibility by eliminating variance from disk order.
158 * #2714: Update to distutils at pypa/distutils@e2627b7.
159 * #2715: Removed reliance on deprecated ssl.match_hostname by removing the ssl support. Now any index operations rely on the native SSL implementation.
161 Documentation changes
162 ^^^^^^^^^^^^^^^^^^^^^
163 * #2604: Revamped the backward/cross tool compatibility section to remove
165 Add some examples and the version since when ``entry_points`` are
166 supported in declarative configuration.
167 Tried to make the reading flow a bit leaner, gather some informations
168 that were a bit dispersed.
177 * #2645: License files excluded via the ``MANIFEST.in`` but matched by either
178 the ``license_file`` (deprecated) or ``license_files`` options,
179 will be nevertheless included in the source distribution. - by :user:`cdce8p`
183 * #2628: Write long description in message payload of PKG-INFO file. - by :user:`cdce8p`
184 * #2645: Added ``License-File`` (multiple) to the output package metadata.
185 The field will contain the path of a license file, matched by the
186 ``license_file`` (deprecated) and ``license_files`` options,
187 relative to ``.dist-info``. - by :user:`cdce8p`
188 * #2678: Moved Setuptools' own entry points into declarative config.
189 * #2680: Vendored `more_itertools <https://pypi.org/project/more-itertools>`_ for Setuptools.
190 * #2681: Setuptools own setup.py no longer declares setup_requires, but instead expects wheel to be installed as declared by pyproject.toml.
194 * #2650: Updated the docs build tooling to support the latest version of
195 Towncrier and show the previews of not-yet-released setuptools versions
196 in the changelog -- :user:`webknjaz`
205 * #2640: Fixed handling of multiline license strings. - by :user:`cdce8p`
206 * #2641: Setuptools will now always try to use the latest supported
207 metadata version for ``PKG-INFO``. - by :user:`cdce8p`
216 * #2653: Incorporated assorted changes from pypa/distutils.
217 * #2657: Adopted docs from distutils.
218 * #2663: Added Visual Studio Express 2017 support -- by :user:`dofuuz`
222 * #2644: Fixed ``DeprecationWarning`` due to ``threading.Thread.setDaemon`` in tests -- by :user:`tirkarthi`
223 * #2654: Made the changelog generator compatible
224 with Towncrier >= 19.9 -- :user:`webknjaz`
225 * #2664: Relax the deprecation message in the distutils hack.
234 * #2620: The ``license_file`` option is now marked as deprecated.
235 Use ``license_files`` instead. -- by :user:`cdce8p`
239 * #2620: If neither ``license_file`` nor ``license_files`` is specified, the ``sdist``
240 option will now auto-include files that match the following patterns:
241 ``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS*``.
242 This matches the behavior of ``bdist_wheel``. -- by :user:`cdce8p`
246 * #2620: The ``license_file`` and ``license_files`` options now support glob patterns. -- by :user:`cdce8p`
247 * #2632: Implemented ``VendorImporter.find_spec()`` method to get rid
248 of ``ImportWarning`` that Python 3.10 emits when only the old-style
249 importer hooks are present -- by :user:`webknjaz`
251 Documentation changes
252 ^^^^^^^^^^^^^^^^^^^^^
253 * #2620: Added documentation for the ``license_files`` option. -- by :user:`cdce8p`
262 * #2566: Remove the deprecated ``bdist_wininst`` command. Binary packages should be built as wheels instead. -- by :user:`hroncok`
271 * #2608: Added informative error message to PEP 517 build failures owing to
272 an empty ``setup.py`` -- by :user:`layday`
278 No significant changes.
287 * #2595: Reduced scope of dash deprecation warning to Setuptools/distutils only -- by :user:`melissa-kun-li`
294 Documentation changes
295 ^^^^^^^^^^^^^^^^^^^^^
296 * #2584: Added ``sphinx-inline-tabs`` extension to allow for comparison of ``setup.py`` and its equivalent ``setup.cfg`` -- by :user:`amy-lei`
300 * #2592: Made option keys in the ``[metadata]`` section of ``setup.cfg`` case-sensitive. Users having
301 uppercase option spellings will get a warning suggesting to make them to lowercase
302 -- by :user:`melissa-kun-li`
311 * #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`
320 * #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.
324 * #1932: Handled :code:`AttributeError` by raising :code:`DistutilsSetupError` in :code:`dist.check_specifier()` when specifier is not a string -- by :user:`melissa-kun-li`
325 * #2570: Correctly parse cmdclass in setup.cfg.
327 Documentation changes
328 ^^^^^^^^^^^^^^^^^^^^^
329 * #2553: Added userguide example for markers in extras_require -- by :user:`pwoolvett`
338 * #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`
339 * #2573: Fixed error in uploading a Sphinx doc with the :code:`upload_docs` command. An html builder will be used.
340 Note: :code:`upload_docs` is deprecated for PyPi, but is supported for other sites -- by :user:`melissa-kun-li`
349 * #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.
358 * #2537: Remove fallback support for fetch_build_eggs using easy_install. Now pip is required for setup_requires to succeed.
359 * #2544: Removed 'easy_install' top-level model (runpy entry point) and 'easy_install' console script.
360 * #2545: Removed support for eggsecutables.
364 * #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``.
373 * #2539: Fix AttributeError in Description validation.
382 * #1390: Validation of Description field now is more lenient, emitting a warning and mangling the value to be valid (replacing newlines with spaces).
391 * #2536: Reverted tag deduplication handling.
400 * #1390: Newlines in metadata description/Summary now trigger a ValueError.
401 * #2481: Define ``create_module()`` and ``exec_module()`` methods in ``VendorImporter``
402 to get rid of ``ImportWarning`` -- by :user:`hroncok`
403 * #2489: ``pkg_resources`` behavior for zipimport now matches the regular behavior, and finds
404 ``.egg-info`` (previoulsy would only find ``.dist-info``) -- by :user:`thatch`
405 * #2529: Fixed an issue where version tags may be added multiple times
414 * #2493: Use importlib.import_module() rather than the deprecated loader.load_module()
415 in pkg_resources namespace delaration -- by :user:`encukou`
417 Documentation changes
418 ^^^^^^^^^^^^^^^^^^^^^
419 * #2525: Fix typo in the document page about entry point. -- by :user:`jtr109`
423 * #2534: Avoid hitting network during test_easy_install.
432 * #2505: Disable inclusion of package data as it causes 'tests' to be included as data.
441 * #2534: Avoid hitting network during test_virtualenv.test_test_command.
450 * #2486: Project adopts jaraco/skeleton for shared package maintenance.
454 * #2477: Restore inclusion of rst files in sdist.
455 * #2484: Setuptools has replaced the master branch with the main branch.
456 * #2485: Fixed failing test when pip 20.3+ is present.
457 -- by :user:`yan12125`
458 * #2487: Fix tests with pytest 6.2
459 -- by :user:`yan12125`
468 * #2435: Require Python 3.6 or later.
470 Documentation changes
471 ^^^^^^^^^^^^^^^^^^^^^
472 * #2430: Fixed inconsistent RST title nesting levels caused by #2399
473 -- by :user:`webknjaz`
474 * #2430: Fixed a typo in Sphinx docs that made docs dev section disappear
475 as a result of PR #2426 -- by :user:`webknjaz`
479 * #2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils.
487 Documentation changes
488 ^^^^^^^^^^^^^^^^^^^^^
489 * #2394: Extended towncrier news template to include change note categories.
490 This allows to see what types of changes a given version introduces
491 -- by :user:`webknjaz`
492 * #2427: Started enforcing strict syntax and reference validation
493 in the Sphinx docs -- by :user:`webknjaz`
494 * #2428: Removed redundant Sphinx ``Makefile`` support -- by :user:`webknjaz`
498 * #2401: Enabled test results reporting in AppVeyor CI
499 -- by :user:`webknjaz`
500 * #2420: Replace Python 3.9.0 beta with 3.9.0 final on GitHub Actions.
501 * #2421: Python 3.9 Trove classifier got added to the dist metadata
502 -- by :user:`webknjaz`
510 Documentation changes
511 ^^^^^^^^^^^^^^^^^^^^^
512 * #2093: Finalized doc revamp.
513 * #2097: doc: simplify index and group deprecated files
514 * #2102: doc overhaul step 2: break main doc into multiple sections
515 * #2111: doc overhaul step 3: update userguide
516 * #2395: Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`
517 * #2395: Added an illustrative explanation about the change notes to fragments dir -- by :user:`webknjaz`
521 * #2379: Travis CI test suite now tests against PPC64.
522 * #2413: Suppress EOF errors (and other exceptions) when importing lib2to3.
532 * #2368: In distutils, restore support for monkeypatched CCompiler.spawn per pypa/distutils#15.
542 * #2355: When pip is imported as part of a build, leave distutils patched.
543 * #2380: There are some setuptools specific changes in the
544 ``setuptools.command.bdist_rpm`` module that are no longer needed, because
545 they are part of the ``bdist_rpm`` module in distutils in Python
546 3.5.0. Therefore, code was removed from ``setuptools.command.bdist_rpm``.
556 * #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.
566 * #2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils#9).
576 * #2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876.
586 * #2357: Restored Python 3.5 support in distutils.util for missing ``subprocess._optim_args_from_interpreter_flags``.
587 * #2358: Restored AIX support on Python 3.8 and earlier.
588 * #2361: Add Python 3.10 support to _distutils_hack. Get the 'Loader' abstract class
589 from importlib.abc rather than importlib.util.abc (alias removed in Python
600 * #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.
604 * #2334: In MSVC module, refine text in error message.
614 * #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.
624 * #2306: When running as a PEP 517 backend, setuptools does not try to install
625 ``setup_requires`` itself. They are reported as build requirements for the
636 * #2310: Updated vendored packaging version to 20.4.
644 Documentation changes
645 ^^^^^^^^^^^^^^^^^^^^^
646 * #2300: Improve the ``safe_version`` function documentation
650 * #2297: Once again, in stubs prefer exec_module to the deprecated load_module.
660 * #2316: Removed warning when ``distutils`` is imported before ``setuptools`` when ``distutils`` replacement is not enabled.
670 * #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.
680 * #2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn.
690 * #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.
700 * #2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state.
701 * #2249: Fix extension loading technique in stubs.
711 * #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.
721 * #2094: Removed pkg_resources.py2_warn module, which is no longer reachable.
731 * #2228: Applied fix for pypa/distutils#3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file.
741 * #2228: Disabled distutils adoption for now while emergent issues are addressed.
751 * #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.
755 * #2137: Removed (private) pkg_resources.RequirementParseError, now replaced by packaging.requirements.InvalidRequirement. Kept the name for compatibility, but users should catch InvalidRequirement instead.
756 * #2180: Update vendored packaging in pkg_resources to 19.2.
760 * #2199: Fix exception causes all over the codebase by using ``raise new_exception from old_exception``
770 * #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.
771 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)``.
781 * #2071: Replaced references to the deprecated imp package with references to importlib
791 * #1973: Removed ``pkg_resources.py31compat.makedirs`` in favor of the stdlib. Use ``os.makedirs()`` instead.
792 * #2198: Restore ``__requires__`` directive in easy-install wrapper scripts.
802 * #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.
806 * #2195: Fix broken entry points generated by easy-install (pip editable installs).
816 * #2194: Editable-installed entry points now load significantly faster on Python versions 3.8+.
817 * #1471: Incidentally fixed by #2194 on Python 3.8 or when importlib_metadata is present.
825 Documentation changes
826 ^^^^^^^^^^^^^^^^^^^^^
827 * #2156: Update mailing list pointer in developer docs
829 Incorporate changes from v44.1.1:
830 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
832 * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.
842 * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.
852 * #2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages.
862 * #2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should use ``setuptools<45``.
866 * #1700: Document all supported keywords by migrating the ones from distutils.
876 * #1753: ``attr:`` now extracts variables through rudimentary examination of the AST,
877 thereby supporting modules with third-party imports. If examining the AST
878 fails to find the variable, ``attr:`` falls back to the old behavior of
879 importing the module. Works on Python 3 only.
885 No significant changes.
895 * #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.
899 * #2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards.
900 * #2105: Filter ``2to3`` deprecation warnings from ``TestDevelop.test_2to3_user_mode``.
910 * #2040: Deprecated the ``bdist_wininst`` command. Binary packages should be built as wheels instead.
911 * #2062: Change 'Mac OS X' to 'macOS' in code.
912 * #2075: Stop recognizing files ending with ``.dist-info`` as distribution metadata.
913 * #2086: Deprecate 'use_2to3' functionality. Packagers are encouraged to use single-source solutions or build tool chains to manage conversions outside of setuptools.
915 Documentation changes
916 ^^^^^^^^^^^^^^^^^^^^^
917 * #1698: Added documentation for ``build_meta`` (a bare minimum, not completed).
921 * #2082: Filter ``lib2to3`` ``PendingDeprecationWarning`` and ``DeprecationWarning`` in tests,
922 because ``lib2to3`` is `deprecated in Python 3.9 <https://bugs.python.org/issue40360>`_.
928 No significant changes.
938 * #1458: Added template for reporting Python 2 incompatibilities.
944 No significant changes.
954 * #308: Allow version number normalization to be bypassed by wrapping in a 'setuptools.sic()' call.
955 * #1424: Prevent keeping files mode for package_data build. It may break a build if user's package data has read only flag.
956 * #1431: In ``easy_install.check_site_dir``, ensure the installation directory exists.
957 * #1563: In ``pkg_resources`` prefer ``find_spec`` (PEP 451) to ``find_module``.
959 Incorporate changes from v44.1.0:
960 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
962 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
963 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
964 * #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.
974 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
975 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
976 * #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.
986 * #65: Once again as in 3.0, removed the Features feature.
990 * #1890: Fix vendored dependencies so importing ``setuptools.extern.some_module`` gives the same object as ``setuptools._vendor.some_module``. This makes Metadata picklable again.
991 * #1899: Test suite now fails on warnings.
993 Documentation changes
994 ^^^^^^^^^^^^^^^^^^^^^
995 * #2011: Fix broken link to distutils docs on package_data
999 * #1991: Include pkg_resources test data in sdist, so tests can be executed from it.
1009 * #1557: Deprecated eggsecutable scripts and updated docs.
1010 * #1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+
1020 * #1905: Fixed defect in _imp, introduced in 41.6.0 when the 'tests' directory is not present.
1021 * #1941: Improve editable installs with PEP 518 build isolation:
1023 * The ``--user`` option is now always available. A warning is issued if the user site directory is not available.
1024 * The error shown when the install directory is not in ``PYTHONPATH`` has been turned into a warning.
1025 * #1981: Setuptools now declares its ``tests`` and ``docs`` dependencies in metadata (extras).
1026 * #1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9).
1030 * #1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info.
1040 * #1458: Add minimum sunset date and preamble to Python 2 warning.
1041 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
1042 * #1974: Add Python 3 Only Trove Classifier and remove universal wheel declaration for more complete transition from Python 2.
1052 * #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.
1056 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
1066 * #1908: Drop support for Python 3.4.
1076 * #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.
1080 * #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.
1089 * #1921: Fix support for easy_install's ``find-links`` option in ``setup.cfg``.
1090 * #1922: Build dependencies (setup_requires and tests_require) now install transitive dependencies indicated by extras.
1100 * #1918: Fix regression in handling wheels compatibility tags.
1110 * #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:
1111 * support for ``python_requires``
1112 * better support for wheels (proper handling of priority with respect to PEP 425 tags)
1113 * PEP 517/518 support
1114 * eggs are not supported
1115 * no support for the ``allow_hosts`` easy_install option (``index_url``/``find_links`` are still honored)
1116 * pip environment variables are honored (and take precedence over easy_install options)
1117 * #1898: Removed the "upload" and "register" commands in favor of `twine <https://pypi.org/p/twine>`_.
1121 * #1767: Add support for the ``license_files`` option in ``setup.cfg`` to automatically
1122 include multiple license files in a source distribution.
1123 * #1829: Update handling of wheels compatibility tags:
1124 * add support for manylinux2010
1125 * fix use of removed 'm' ABI flag in Python 3.8 on Windows
1126 * #1861: Fix empty namespace package installation from wheel.
1127 * #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.
1137 * #479: Replace usage of deprecated ``imp`` module with local re-implementation in ``setuptools._imp``.
1147 * #1891: Fix code for detecting Visual Studio's version on Windows under Python 2.
1157 * #1811: Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019.
1158 * #1814: Fix ``pkg_resources.Requirement`` hash/equality implementation: take PEP 508 direct URL into account.
1159 * #1824: Fix tests when running under ``python3.10``.
1160 * #1878: Formally deprecated the ``test`` command, with the recommendation that users migrate to ``tox``.
1162 Documentation changes
1163 ^^^^^^^^^^^^^^^^^^^^^
1164 * #1860: Update documentation to mention the egg format is not supported by pip and dependency links support was dropped starting with pip 19.0.
1165 * #1862: Drop ez_setup documentation: deprecated for some time (last updated in 2016), and still relying on easy_install (deprecated too).
1166 * #1868: Drop most documentation references to (deprecated) EasyInstall.
1167 * #1884: Added a trove classifier to document support for Python 3.8.
1171 * #1886: Added Python 3.8 release to the Travis test matrix.
1181 * #1847: In declarative config, now traps errors when invalid ``python_requires`` values are supplied.
1191 * #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+.
1195 * #1858: Fixed failing integration test triggered by 'long_description_content_type' in packaging.
1205 * #479: Remove some usage of the deprecated ``imp`` module.
1209 * #1565: Changed html_sidebars from string to list of string as per
1210 https://www.sphinx-doc.org/en/master/changes.html#id58
1220 * #1697: Moved most of the constants from setup.py to setup.cfg
1221 * #1749: Fixed issue with the PEP 517 backend where building a source distribution would fail if any tarball existed in the destination directory.
1222 * #1750: Fixed an issue with PEP 517 backend where wheel builds would fail if the destination directory did not already exist.
1223 * #1756: Force metadata-version >= 1.2. when project urls are present.
1224 * #1769: Improve ``package_data`` check: ensure the dictionary values are lists/tuples of strings.
1225 * #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.
1226 * #1790: Added the file path to the error message when a ``UnicodeDecodeError`` occurs while reading a metadata file.
1228 Documentation changes
1229 ^^^^^^^^^^^^^^^^^^^^^
1230 * #1776: Use license classifiers rather than the license field.
1240 * #1671: Fixed issue with the PEP 517 backend that prevented building a wheel when the ``dist/`` directory contained existing ``.whl`` files.
1241 * #1709: In test.paths_on_python_path, avoid adding unnecessary duplicates to the PYTHONPATH.
1242 * #1741: In package_index, now honor "current directory" during a checkout of git and hg repositories under Windows
1252 * #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.
1262 * #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.
1263 * #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.
1264 * #1664: Added the path to the ``PKG-INFO`` or ``METADATA`` file in the exception
1265 text when the ``Version:`` header can't be found.
1267 Documentation changes
1268 ^^^^^^^^^^^^^^^^^^^^^
1269 * #1705: Removed some placeholder documentation sections referring to deprecated features.
1279 * #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``.
1280 * #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.
1281 * #1536: ``setuptools`` will now automatically include licenses if ``setup.cfg`` contains a ``license_file`` attribute, unless this file is manually excluded inside ``MANIFEST.in``.
1291 * #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.
1301 * #1666: Restore port in URL handling in package_index.
1311 * #1660: On Python 2, when reading config files, downcast options from text to bytes to satisfy distutils expectations.
1321 * #1551: File inputs for the ``license`` field in ``setup.cfg`` files now explicitly raise an error.
1325 * #1180: Add support for non-ASCII in setup.cfg (#1062). Add support for native strings on some parameters (#1136).
1326 * #1499: ``setuptools.package_index`` no longer relies on the deprecated ``urllib.parse.splituser`` per Python #27485.
1327 * #1544: Added tests for PackageIndex.download (for git URLs).
1328 * #1625: In PEP 517 build_meta builder, ensure that sdists are built as gztar per the spec.
1338 * #1594: PEP 517 backend no longer declares setuptools as a dependency as it can be assumed.
1348 * #1592: Fix invalid dependency on external six module (instead of vendored version).
1358 * #1590: Fixed regression where packages without ``author`` or ``author_email`` fields generated malformed package metadata.
1368 * #1541: Officially deprecated the ``requires`` parameter in ``setup()``.
1372 * #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.
1373 * #1545: Changed the warning class of all deprecation warnings; deprecation warning classes are no longer derived from ``DeprecationWarning`` and are thus visible by default.
1374 * #1554: ``build_meta.build_sdist`` now includes ``setup.py`` in source distributions by default.
1375 * #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.
1377 Documentation changes
1378 ^^^^^^^^^^^^^^^^^^^^^
1379 * #1395: Changed Pyrex references to Cython in the documentation.
1380 * #1456: Documented that the ``rpmbuild`` packages is required for the ``bdist_rpm`` command.
1381 * #1537: Documented how to use ``setup.cfg`` for ``src/ layouts``
1382 * #1539: Added minimum version column in ``setup.cfg`` metadata table.
1383 * #1552: Fixed a minor typo in the python 2/3 compatibility documentation.
1384 * #1553: Updated installation instructions to point to ``pip install`` instead of ``ez_setup.py``.
1385 * #1560: Updated ``setuptools`` distribution documentation to remove some outdated information.
1386 * #1564: Documented ``setup.cfg`` minimum version for version and project_urls.
1390 * #1533: Restricted the ``recursive-include setuptools/_vendor`` to contain only .py and .txt files.
1391 * #1572: Added the ``concurrent.futures`` backport ``futures`` to the Python 2.7 test suite requirements.
1401 * #1335: In ``pkg_resources.normalize_path``, fix issue on Cygwin when cwd contains symlinks.
1402 * #1502: Deprecated support for downloads from Subversion in package_index/easy_install.
1403 * #1517: Dropped use of six.u in favor of ``u""`` literals.
1404 * #1520: Added support for ``data_files`` in ``setup.cfg``.
1406 Documentation changes
1407 ^^^^^^^^^^^^^^^^^^^^^
1408 * #1525: Fixed rendering of the deprecation warning in easy_install doc.
1418 * #1480: Bump vendored pyparsing in pkg_resources to 2.2.1.
1428 * #1497: Updated gitignore in repo.
1438 * #1480: Bump vendored pyparsing to 2.2.1.
1448 * #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).
1458 * #1402: Fixed a bug with namespace packages under Python 3.6 when one package in
1459 current directory hides another which is installed.
1460 * #1427: Set timestamp of ``.egg-info`` directory whenever ``egg_info`` command is run.
1461 * #1474: ``build_meta.get_requires_for_build_sdist`` now does not include the ``wheel`` package anymore.
1462 * #1486: Suppress warnings in pkg_resources.handle_ns.
1466 * #1479: Remove internal use of six.binary_type.
1476 * #1466: Fix handling of Unicode arguments in PEP 517 backend
1486 * #1465: Fix regression with ``egg_info`` command when tagging is used.
1496 * #1410: Deprecated ``upload`` and ``register`` commands.
1497 * #1312: Introduced find_namespace_packages() to find PEP 420 namespace packages.
1498 * #1420: Added find_namespace: directive to config parser.
1499 * #1418: Solved race in when creating egg cache directories.
1500 * #1450: Upgraded vendored PyParsing from 2.1.10 to 2.2.0.
1501 * #1451: Upgraded vendored appdirs from 1.4.0 to 1.4.3.
1502 * #1388: Fixed "Microsoft Visual C++ Build Tools" link in exception when Visual C++ not found.
1503 * #1389: Added support for scripts which have unicode content.
1504 * #1416: Moved several Python version checks over to using ``six.PY2`` and ``six.PY3``.
1508 * #1441: Removed spurious executable permissions from files that don't need them.
1518 * #1342: Drop support for Python 3.3.
1522 * #1366: In package_index, fixed handling of encoded entities in URLs.
1523 * #1383: In pkg_resources VendorImporter, avoid removing packages imported from the root.
1525 Documentation changes
1526 ^^^^^^^^^^^^^^^^^^^^^
1527 * #1379: Minor doc fixes after actually using the new release process.
1528 * #1385: Removed section on non-package data files.
1529 * #1403: Fix developer's guide.
1533 * #1404: Fix PEP 518 configuration: set build requirements in ``pyproject.toml`` to ``["wheel"]``.
1543 * #1359: Support using "file:" to load a PEP 440-compliant package version from
1545 * #1360: Fixed issue with a mismatch between the name of the package and the
1546 name of the .dist-info file in wheel files
1547 * #1364: Add ``__dir__()`` implementation to ``pkg_resources.Distribution()`` that
1548 includes the attributes in the ``_provider`` instance variable.
1549 * #1365: Take the package_dir option into account when loading the version from
1552 Documentation changes
1553 ^^^^^^^^^^^^^^^^^^^^^
1554 * #1353: Added coverage badge to README.
1555 * #1356: Made small fixes to the developer guide documentation.
1556 * #1357: Fixed warnings in documentation builds and started enforcing that the
1557 docs build without warnings in tox.
1558 * #1376: Updated release process docs.
1562 * #1343: The ``setuptools`` specific ``long_description_content_type``,
1563 ``project_urls`` and ``provides_extras`` fields are now set consistently
1564 after any ``distutils`` ``setup_keywords`` calls, allowing them to override
1566 * #1352: Added ``tox`` environment for documentation builds.
1567 * #1354: Added ``towncrier`` for changelog management.
1568 * #1355: Add PR template.
1569 * #1368: Fixed tests which failed without network connectivity.
1570 * #1369: Added unit tests for PEP 425 compatibility tags support.
1571 * #1372: Stop testing Python 3.3 in Travis CI, now that the latest version of
1572 ``wheel`` no longer installs on it.
1577 * #1340: Update all PyPI URLs to reflect the switch to the
1578 new Warehouse codebase.
1579 * #1337: In ``pkg_resources``, now support loading resources
1580 for modules loaded by the ``SourcelessFileLoader``.
1581 * #1332: Silence spurious wheel related warnings on Windows.
1586 * #1297: Restore Unicode handling for Maintainer fields in
1592 * #1296: Setuptools now vendors its own direct dependencies, no
1593 longer relying on the dependencies as vendored by pkg_resources.
1595 * #296: Removed long-deprecated support for iteration on
1596 Version objects as returned by ``pkg_resources.parse_version``.
1597 Removed the ``SetuptoolsVersion`` and
1598 ``SetuptoolsLegacyVersion`` names as well. They should not
1599 have been used, but if they were, replace with
1600 ``Version`` and ``LegacyVersion`` from ``packaging.version``.
1605 * #1288: Add support for maintainer in PKG-INFO.
1610 * #1292: Avoid generating ``Provides-Extra`` in metadata when
1611 no extra is present (but environment markers are).
1616 * #1286: Add support for Metadata 2.1 (PEP 566).
1621 * #1285: Fixed RuntimeError in pkg_resources.parse_requirements
1622 on Python 3.7 (stemming from PEP 479).
1627 * #1271: Revert to Cython legacy ``build_ext`` behavior for
1633 * #1229: Expand imports in ``build_ext`` to refine detection of
1634 Cython availability.
1636 * #1270: When Cython is available, ``build_ext`` now uses the
1642 * #1257: In bdist_egg.scan_module, fix ValueError on Python 3.7.
1647 * #1231: Removed warning when PYTHONDONTWRITEBYTECODE is enabled.
1652 * #1210: Add support for PEP 345 Project-URL metadata.
1653 * #1207: Add support for ``long_description_type`` to setup.cfg
1654 declarative config as intended and documented.
1659 * #1232: Fix trailing slash handling in ``pkg_resources.ZipProvider``.
1664 * #1220: Fix ``data_files`` handling when installing from wheel.
1669 * fix Travis' Python 3.3 job.
1674 * #1214: fix handling of namespace packages when installing
1680 * #1212: fix encoding handling of metadata when installing
1686 * #1200: easy_install now support installing from wheels:
1687 they will be installed as standalone unzipped eggs.
1692 * #1208: Improve error message when failing to locate scripts
1693 in egg-info metadata.
1698 * #458: In order to support deterministic builds, Setuptools no
1699 longer allows packages to declare ``install_requires`` as
1700 unordered sequences (sets or dicts).
1705 * #878: Drop support for Python 2.6. Python 2.6 users should
1706 rely on 'setuptools < 37dev'.
1711 * #1190: In SSL support for package index operations, use SNI
1717 * #1175: Bug fixes to ``build_meta`` module.
1722 * #701: Fixed duplicate test discovery on Python 3.
1727 * #1193: Avoid test failures in bdist_egg when
1728 PYTHONDONTWRITEBYTECODE is set.
1733 * #1054: Support ``setup_requires`` in ``setup.cfg`` files.
1738 * #1132: Removed redundant and costly serialization/parsing step
1739 in ``EntryPoint.__init__``.
1741 * #844: ``bdist_egg --exclude-source-files`` now tested and works
1747 * #1143: Added ``setuptools.build_meta`` module, an implementation
1748 of PEP-517 for Setuptools-defined packages.
1750 * #1143: Added ``dist_info`` command for producing dist_info
1756 * #170: When working with Mercurial checkouts, use Windows-friendly
1757 syntax for suppressing output.
1759 * Inspired by #1134, performed substantial refactoring of
1760 ``pkg_resources.find_on_path`` to facilitate an optimization
1761 for paths with many non-version entries.
1766 * #1075: Add new ``Description-Content-Type`` metadata field. `See here for
1767 documentation on how to use this field.
1768 <https://packaging.python.org/specifications/#description-content-type>`_
1770 * #1068: Sort files and directories when building eggs for
1771 deterministic order.
1773 * #196: Remove caching of easy_install command in fetch_build_egg.
1774 Fixes issue where ``pytest-runner-N.N`` would satisfy the installation
1777 * #1129: Fix working set dependencies handling when replacing conflicting
1778 distributions (e.g. when using ``setup_requires`` with a conflicting
1779 transitive dependency, fix #1124).
1781 * #1133: Improved handling of README files extensions and added
1782 Markdown to the list of searched READMES.
1784 * #1135: Improve performance of pkg_resources import by not invoking
1785 ``access`` or ``stat`` and using ``os.listdir`` instead.
1790 * #1131: Make possible using several files within ``file:`` directive
1791 in metadata.long_description in ``setup.cfg``.
1796 * fix #1105: Fix handling of requirements with environment
1797 markers when declared in ``setup.cfg`` (same treatment as
1803 * #462: Don't assume a directory is an egg by the ``.egg``
1809 * #1093: Fix test command handler with extras_require.
1810 * #1112, #1091, #1115: Now using Trusty containers in
1811 Travis for CI and CD.
1816 * #1092: ``pkg_resources`` now uses ``inspect.getmro`` to
1817 resolve classes in method resolution order.
1822 * #1102: Restore behavior for empty extras.
1827 * #1099: Revert commit a3ec721, restoring intended purpose of
1828 extras as part of a requirement declaration.
1835 * support extras specifiers in install_requires requirements
1840 * #1081: Environment markers indicated in ``install_requires``
1841 are now processed and treated as nameless ``extras_require``
1842 with markers, allowing their metadata in requires.txt to be
1843 correctly generated.
1845 * #1053: Tagged commits are now released using Travis-CI
1846 build stages, meaning releases depend on passing tests on
1847 all supported Python versions (Linux) and not just the latest
1853 * #1083: Correct ``py31compat.makedirs`` to correctly honor
1854 ``exist_ok`` parameter.
1855 * #1083: Also use makedirs compatibility throughout setuptools.
1860 * #1083: Avoid race condition on directory creation in
1861 ``pkg_resources.ensure_directory``.
1863 * Removed deprecation of and restored support for
1864 ``upload_docs`` command for sites other than PyPI.
1865 Only warehouse is dropping support, but services like
1866 `devpi <http://doc.devpi.net/latest/>`_ continue to
1867 support docs built by setuptools' plugins. See
1868 `this comment <https://bitbucket.org/hpk42/devpi/issues/388/support-rtd-model-for-building-uploading#comment-34292423>`_
1869 for more context on the motivation for this change.
1874 * #1042: Fix import in py27compat module that still
1875 referenced six directly, rather than through the externs
1876 module (vendored packages hook).
1881 * #980 and others: Once again, Setuptools vendors all
1882 of its dependencies. It seems to be the case that in
1883 the Python ecosystem, all build tools must run without
1884 any dependencies (build, runtime, or otherwise). At
1885 such a point that a mechanism exists that allows
1886 build tools to have dependencies, Setuptools will adopt
1892 * #1015: Fix test failures on Python 3.7.
1894 * #1024: Add workaround for Jython #2581 in monkey module.
1899 * #992: Revert change introduced in v34.4.1, now
1902 * #1016: Revert change introduced in v35.0.0 per #1014,
1903 referencing #436. The approach had unintended
1904 consequences, causing sdist installs to be missing
1910 * #436: In egg_info.manifest_maker, no longer read
1911 the file list from the manifest file, and instead
1912 re-build it on each build. In this way, files removed
1913 from the specification will not linger in the manifest.
1914 As a result, any files manually added to the manifest
1915 will be removed on subsequent egg_info invocations.
1916 No projects should be manually adding files to the
1917 manifest and should instead use MANIFEST.in or SCM
1918 file finders to force inclusion of files in the manifest.
1923 * #1008: In MSVC support, use always the last version available for Windows SDK and UCRT SDK.
1925 * #1008: In MSVC support, fix "vcruntime140.dll" returned path with Visual Studio 2017.
1927 * #992: In msvc.msvc9_query_vcvarsall, ensure the
1928 returned dicts have str values and not Unicode for
1929 compatibility with os.environ.
1934 * #995: In MSVC support, add support for "Microsoft Visual Studio 2017" and "Microsoft Visual Studio Build Tools 2017".
1936 * #999 via #1007: Extend support for declarative package
1937 config in a setup.cfg file to include the options
1938 ``python_requires`` and ``py_modules``.
1943 * #967 (and #997): Explicitly import submodules of
1944 packaging to account for environments where the imports
1945 of those submodules is not implied by other behavior.
1950 * #993: Fix documentation upload by correcting
1951 rendering of content-type in _build_multipart
1957 * #988: Trap ``os.unlink`` same as ``os.remove`` in
1958 ``auto_chmod`` error handler.
1960 * #983: Fixes to invalid escape sequence deprecations on
1966 * #941: In the upload command, if the username is blank,
1967 default to ``getpass.getuser()``.
1969 * #971: Correct distutils findall monkeypatch to match
1970 appropriate versions (namely Python 3.4.6).
1975 * #966: Add support for reading dist-info metadata and
1976 thus locating Distributions from zip files.
1978 * #968: Allow '+' and '!' in egg fragments
1979 so that it can take package names that contain
1980 PEP 440 conforming version specifiers.
1985 * #953: More aggressively employ the compatibility issue
1986 originally added in #706.
1991 * #930: ``build_info`` now accepts two new parameters
1992 to optimize and customize the building of C libraries.
1997 * #947: Loosen restriction on the version of six required,
1998 restoring compatibility with environments relying on
1999 six 1.6.0 and later.
2004 * #882: Ensure extras are honored when building the
2006 * #913: Fix issue in develop if package directory has
2012 * #935: Fix glob syntax in graft.
2017 * #581: Instead of vendoring the growing list of
2018 dependencies that Setuptools requires to function,
2019 Setuptools now requires these dependencies just like
2020 any other project. Unlike other projects, however,
2021 Setuptools cannot rely on ``setup_requires`` to
2022 demand the dependencies it needs to install because
2023 its own machinery would be necessary to pull those
2024 dependencies if not present (a bootstrapping problem).
2025 As a result, Setuptools no longer supports self upgrade or
2026 installation in the general case. Instead, users are
2027 directed to use pip to install and upgrade using the
2028 ``wheel`` distributions of setuptools.
2030 Users are welcome to contrive other means to install
2031 or upgrade Setuptools using other means, such as
2032 pre-installing the Setuptools dependencies with pip
2033 or a bespoke bootstrap tool, but such usage is not
2034 recommended and is not supported.
2036 As discovered in #940, not all versions of pip will
2037 successfully install Setuptools from its pre-built
2038 wheel. If you encounter issues with "No module named
2039 six" or "No module named packaging", especially
2040 following a line "Running setup.py egg_info for package
2041 setuptools", then your pip is not new enough.
2043 There's an additional issue in pip where setuptools
2044 is upgraded concurrently with other source packages,
2045 described in pip #4253. The proposed workaround is to
2046 always upgrade Setuptools first prior to upgrading
2047 other packages that would upgrade Setuptools.
2052 * #921: Correct issue where certifi fallback not being
2058 Installation via pip, as indicated in the `Python Packaging
2059 User's Guide <https://packaging.python.org/installing/>`_,
2060 is the officially-supported mechanism for installing
2061 Setuptools, and this recommendation is now explicit in the
2062 much more concise README.
2064 Other edits and tweaks were made to the documentation. The
2065 codebase is unchanged.
2070 * #619: Removed support for the ``tag_svn_revision``
2071 distribution option. If Subversion tagging support is
2072 still desired, consider adding the functionality to
2073 setuptools_svn in setuptools_svn #2.
2078 * #866: Use ``dis.Bytecode`` on Python 3.4 and later in
2079 ``setuptools.depends``.
2084 * #889: Backport proposed fix for disabling interpolation in
2085 distutils.Distribution.parse_config_files.
2090 * #884: Restore support for running the tests under
2091 `pytest-runner <https://github.com/pytest-dev/pytest-runner>`_
2092 by ensuring that PYTHONPATH is honored in tests invoking
2098 * #706: Add rmtree compatibility shim for environments where
2099 rmtree fails when passed a unicode string.
2104 * #893: Only release sdist in zip format as warehouse now
2105 disallows releasing two different formats.
2110 * #704: More selectively ensure that 'rmtree' is not invoked with
2111 a byte string, enabling it to remove files that are non-ascii,
2114 * #712: In 'sandbox.run_setup', ensure that ``__file__`` is
2115 always a ``str``, modeling the behavior observed by the
2116 interpreter when invoking scripts and modules.
2121 * #891: In 'test' command on test failure, raise DistutilsError,
2122 suppression invocation of subsequent commands.
2127 * #890: Revert #849. ``global-exclude .foo`` will not match all
2128 ``*.foo`` files any more. Package authors must add an explicit
2129 wildcard, such as ``global-exclude *.foo``, to match all
2130 ``.foo`` files. See #886, #849.
2135 * #885: Fix regression where 'pkg_resources._rebuild_mod_path'
2136 would fail when a namespace package's '__path__' was not
2137 a list with a sort attribute.
2142 * #250: Install '-nspkg.pth' files for packages installed
2143 with 'setup.py develop'. These .pth files allow
2144 namespace packages installed by pip or develop to
2145 co-mingle. This change required the removal of the
2146 change for #805 and pip #1924, introduced in 28.3.0 and implicated
2147 in #870, but means that namespace packages not in a
2148 site packages directory will no longer work on Python
2149 earlier than 3.5, whereas before they would work on
2150 Python not earlier than 3.3.
2155 * #879: For declarative config:
2157 - 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.
2159 - packages find: directive now supports fine tuning from a subsection. The same arguments as for find() are accepted.
2164 * #394 via #862: Added support for `declarative package
2165 config in a setup.cfg file
2166 <https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files>`_.
2171 * #850: In test command, invoke unittest.main with
2172 indication not to exit the process.
2177 * #854: Bump to vendored Packaging 16.8.
2182 * #846: Also trap 'socket.error' when opening URLs in
2185 * #849: Manifest processing now matches the filename
2186 pattern anywhere in the filename and not just at the
2187 start. Restores behavior found prior to 28.5.0.
2192 * #864: Drop support for Python 3.2. Systems requiring
2193 Python 3.2 support must use 'setuptools < 30'.
2195 * #825: Suppress warnings for single files.
2197 * #830 via #843: Once again restored inclusion of data
2198 files to sdists, but now trap TypeError caused by
2199 techniques employed rjsmin and similar.
2204 * #861: Re-release of v29.0.1 with the executable script
2205 launchers bundled. Now, launchers are included by default
2206 and users that want to disable this behavior must set the
2207 environment variable
2208 'SETUPTOOLS_INSTALL_WINDOWS_SPECIFIC_FILES' to
2209 a false value like "false" or "0".
2214 * #841: Drop special exception for packages invoking
2215 win32com during the build/install process. See
2216 Distribute #118 for history.
2221 * #629: Per the discussion, refine the sorting to use version
2222 value order for more accurate detection of the latest
2223 available version when scanning for packages. See also
2226 * #837: Rely on the config var "SO" for Python 3.3.0 only
2227 when determining the ext filename.
2232 * #827: Update PyPI root for dependency links.
2234 * #833: Backed out changes from #830 as the implementation
2235 seems to have problems in some cases.
2240 * #832: Moved much of the namespace package handling
2241 functionality into a separate module for re-use in something
2243 * #830: ``sdist`` command no longer suppresses the inclusion
2244 of data files, re-aligning with the expectation of distutils
2245 and addressing #274 and #521.
2250 * #816: Fix manifest file list order in tests.
2255 * #629: When scanning for packages, ``pkg_resources`` now
2256 ignores empty egg-info directories and gives precedence to
2257 packages whose versions are lexicographically greatest,
2258 a rough approximation for preferring the latest available
2264 * #810: Tests are now invoked with tox and not setup.py test.
2265 * #249 and #450 via #764: Avoid scanning the whole tree
2266 when building the manifest. Also fixes a long-standing bug
2267 where patterns in ``MANIFEST.in`` had implicit wildcard
2268 matching. This caused ``global-exclude .foo`` to exclude
2269 all ``*.foo`` files, but also ``global-exclude bar.py`` to
2270 exclude ``foo_bar.py``.
2275 * #732: Now extras with a hyphen are honored per PEP 426.
2276 * #811: Update to pyparsing 2.1.10.
2277 * Updated ``setuptools.command.sdist`` to re-use most of
2278 the functionality directly from ``distutils.command.sdist``
2279 for the ``add_defaults`` method with strategic overrides.
2280 See #750 for rationale.
2281 * #760 via #762: Look for certificate bundle where SUSE
2282 Linux typically presents it. Use ``certifi.where()`` to locate
2288 * #809: In ``find_packages()``, restore support for excluding
2289 a parent package without excluding a child package.
2291 * #805: Disable ``-nspkg.pth`` behavior on Python 3.3+ where
2292 PEP-420 functionality is adequate. Fixes pip #1924.
2297 * #803: Bump certifi to 2016.9.26.
2302 * #733: Do not search excluded directories for packages.
2303 This introduced a backwards incompatible change in ``find_packages()``
2304 so that ``find_packages(exclude=['foo']) == []``, excluding subpackages of ``foo``.
2305 Previously, ``find_packages(exclude=['foo']) == ['foo.bar']``,
2306 even though the parent ``foo`` package was excluded.
2308 * #795: Bump certifi.
2310 * #719: Suppress decoding errors and instead log a warning
2311 when metadata cannot be decoded.
2316 * #790: In MSVC monkeypatching, explicitly patch each
2317 function by name in the target module instead of inferring
2318 the module from the function's ``__module__``. Improves
2319 compatibility with other packages that might have previously
2320 patched distutils functions (i.e. NumPy).
2325 * #794: In test command, add installed eggs to PYTHONPATH
2326 when invoking tests so that subprocesses will also have the
2327 dependencies available. Fixes `tox 330
2328 <https://github.com/tox-dev/tox/issues/330>`_.
2330 * #795: Update vendored pyparsing 2.1.9.
2335 * #520 and #513: Suppress ValueErrors in fixup_namespace_packages
2338 * Nicer, more consistent interfaces for msvc monkeypatching.
2343 * #779 via #781: Fix circular import.
2348 * #778: Fix MSVC monkeypatching.
2353 * Introduce the (private) ``monkey`` module to encapsulate
2354 the distutils monkeypatching behavior.
2359 * Now use Warehouse by default for
2360 ``upload``, patching ``distutils.config.PyPIRCCommand`` to
2361 affect default behavior.
2363 Any config in .pypirc should be updated to replace
2365 https://pypi.python.org/pypi/
2369 https://upload.pypi.org/legacy/
2371 Similarly, any passwords stored in the keyring should be
2372 updated to use this new value for "system".
2374 The ``upload_docs`` command will continue to use the python.org
2375 site, but the command is now deprecated. Users are urged to use
2376 Read The Docs instead.
2378 * #776: Use EXT_SUFFIX for py_limited_api renaming.
2380 * #774 and #775: Use LegacyVersion from packaging when
2381 detecting numpy versions.
2386 * Re-release of 26.1.0 with pytest pinned to allow for automated
2387 deployment and thus proper packaging environment variables,
2388 fixing issues with missing executable launchers.
2393 * #763: ``pkg_resources.get_default_cache`` now defers to the
2394 `appdirs project <https://pypi.org/project/appdirs>`_ to
2395 resolve the cache directory. Adds a vendored dependency on
2396 appdirs to pkg_resources.
2401 * #748: By default, sdists are now produced in gzipped tarfile
2402 format by default on all platforms, adding forward compatibility
2403 for the same behavior in Python 3.6 (See Python #27819).
2405 * #459 via #736: On Windows with script launchers,
2406 sys.argv[0] now reflects
2407 the name of the entry point, consistent with the behavior in
2408 distlib and pip wrappers.
2410 * #752 via #753: When indicating ``py_limited_api`` to Extension,
2411 it must be passed as a keyword argument.
2416 * Add Extension(py_limited_api=True). When set to a truthy value,
2417 that extension gets a filename appropriate for code using Py_LIMITED_API.
2418 When used correctly this allows a single compiled extension to work on
2419 all future versions of CPython 3.
2420 The py_limited_api argument only controls the filename. To be
2421 compatible with multiple versions of Python 3, the C extension
2422 will also need to set -DPy_LIMITED_API=... and be modified to use
2423 only the functions in the limited API.
2428 * #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).
2430 * #731: Bump certifi.
2432 * Style updates. See #740, #741, #743, #744, #742, #747.
2434 * #735: include license file.
2439 * #612 via #730: Add a LICENSE file which needs to be provided by the terms of
2445 * #725: revert ``library_dir_option`` patch (Error is related to ``numpy.distutils`` and make errors on non Numpy users).
2451 * #723: Improve patch for ``library_dir_option``.
2458 * #707: Fix Python 2 compatibility for MSVC by catching errors properly.
2459 * #715: Fix unquoted libpaths by patching ``library_dir_option``.
2464 * #714 and #704: Revert fix as it breaks other components
2465 downstream that can't handle unicode. See #709, #710,
2471 * #704: Fix errors when installing a zip sdist that contained
2472 files named with non-ascii characters on Windows would
2473 crash the install when it attempted to clean up the build.
2474 * #646: MSVC compatibility - catch errors properly in
2475 RegistryInfo.lookup.
2476 * #702: Prevent UnboundLocalError when initial working_set
2482 * #686: Fix issue in sys.path ordering by pkg_resources when
2483 rewrite technique is "raw".
2484 * #699: Fix typo in msvc support.
2489 * #609: Setuptools will now try to download a distribution from
2490 the next possible download location if the first download fails.
2491 This means you can now specify multiple links as ``dependency_links``
2492 and all links will be tried until a working download link is encountered.
2497 * #688: Fix AttributeError in setup.py when invoked not from
2498 the current directory.
2503 * Cleanup of setup.py script.
2505 * Fixed documentation builders by allowing setup.py
2506 to be imported without having bootstrapped the
2509 * More style cleanup. See #677, #678, #679, #681, #685.
2514 * #674: Default ``sys.path`` manipulation by easy-install.pth
2515 is now "raw", meaning that when writing easy-install.pth
2516 during any install operation, the ``sys.path`` will not be
2517 rewritten and will no longer give preference to easy_installed
2520 To retain the old behavior when using any easy_install
2521 operation (including ``setup.py install`` when setuptools is
2522 present), set the environment variable:
2524 SETUPTOOLS_SYS_PATH_TECHNIQUE=rewrite
2526 This project hopes that that few if any environments find it
2527 necessary to retain the old behavior, and intends to drop
2528 support for it altogether in a future release. Please report
2529 any relevant concerns in the ticket for this change.
2534 * #398: Fix shebang handling on Windows in script
2535 headers where spaces in ``sys.executable`` would
2536 produce an improperly-formatted shebang header,
2537 introduced in 12.0 with the fix for #188.
2539 * #663, #670: More style updates.
2544 * #516: Disable ``os.link`` to avoid hard linking
2545 in ``sdist.make_distribution``, avoiding errors on
2546 systems that support hard links but not on the
2547 file system in which the build is occurring.
2552 * #667: Update Metadata-Version to 1.2 when
2553 ``python_requires`` is supplied.
2558 * #631: Add support for ``python_requires`` keyword.
2563 * More style updates. See #660, #661, #641.
2568 * #659: ``setup.py`` now will fail fast and with a helpful
2569 error message when the necessary metadata is missing.
2570 * More style updates. See #656, #635, #640,
2571 #644, #650, #652, and #655.
2576 * Updated style in much of the codebase to match
2577 community expectations. See #632, #633, #634,
2578 #637, #639, #638, #642, #648.
2583 * If MSVC++14 is needed ``setuptools.msvc`` now redirect
2584 user to Visual C++ Build Tools web page.
2589 * #625 and #626: Fixes on ``setuptools.msvc`` mainly
2590 for Python 2 and Linux.
2595 * Pull Request #174: Add more aggressive support for
2596 standalone Microsoft Visual C++ compilers in
2597 msvc9compiler patch.
2598 Particularly : Windows SDK 6.1 and 7.0
2599 (MSVC++ 9.0), Windows SDK 7.1 (MSVC++ 10.0),
2600 Visual C++ Build Tools 2015 (MSVC++14)
2601 * Renamed ``setuptools.msvc9_support`` to
2602 ``setuptools.msvc``.
2607 Re-release of v23.2.0, which was missing the intended
2610 * #623: Remove used of deprecated 'U' flag when reading
2616 * #619: Deprecated ``tag_svn_revision`` distribution
2622 * #611: Removed ARM executables for CLI and GUI script
2623 launchers on Windows. If this was a feature you cared
2624 about, please comment in the ticket.
2625 * #604: Removed docs building support. The project
2626 now relies on documentation hosted at
2627 https://setuptools.readthedocs.io/.
2632 * #604: Restore repository for upload_docs command
2633 to restore publishing of docs during release.
2638 * #589: Upload releases to pypi.io using the upload
2639 hostname and legacy path.
2644 * #589: Releases are now uploaded to pypi.io (Warehouse)
2645 even when releases are made on Twine via Travis.
2650 * #589: Releases are now uploaded to pypi.io (Warehouse).
2655 * #190: On Python 2, if unicode is passed for packages to
2656 ``build_py`` command, it will be handled just as with
2662 Intended to be v21.3.0, but jaraco accidentally released as
2665 * #598: Setuptools now lists itself first in the User-Agent
2666 for web requests, better following the guidelines in
2668 <https://tools.ietf.org/html/rfc7231#section-5.5.3>`_.
2673 * Minor fixes to changelog and docs.
2678 * #261: Exclude directories when resolving globs in
2684 * #539: In the easy_install get_site_dirs, honor all
2685 paths found in ``site.getsitepackages``.
2690 * #572: In build_ext, now always import ``_CONFIG_VARS``
2691 from ``distutils`` rather than from ``sysconfig``
2692 to allow ``distutils.sysconfig.customize_compiler``
2693 configure the OS X compiler for ``-dynamiclib``.
2698 * Removed ez_setup.py from Setuptools sdist. The
2699 bootstrap script will be maintained in its own
2700 branch and should be generally be retrieved from
2701 its canonical location at
2702 https://bootstrap.pypa.io/ez_setup.py.
2707 * #553: egg_info section is now generated in a
2708 deterministic order, matching the order generated
2709 by earlier versions of Python. Except on Python 2.6,
2710 order is preserved when existing settings are present.
2711 * #556: Update to Packaging 16.7, restoring support
2712 for deprecated ``python_implmentation`` marker.
2713 * #555: Upload command now prompts for a password
2714 when uploading to PyPI (or other repository) if no
2715 password is present in .pypirc or in the keyring.
2720 * #548: Update certify version to 2016.2.28
2721 * #545: Safely handle deletion of non-zip eggs in rotate
2727 * Issue #544: Fix issue with extra environment marker
2728 processing in WorkingSet due to refactor in v20.7.0.
2733 * Issue #543: Re-release so that latest release doesn't
2734 cause déjà vu with distribute and setuptools 0.7 in
2740 * Refactored extra environment marker processing
2742 * Issue #533: Fixed intermittent test failures.
2743 * Issue #536: In msvc9_support, trap additional exceptions
2744 that might occur when importing
2745 ``distutils.msvc9compiler`` in mingw environments.
2746 * Issue #537: Provide better context when package
2747 metadata fails to decode in UTF-8.
2752 * Issue #523: Restored support for environment markers,
2753 now honoring 'extra' environment markers.
2758 * Issue #523: Disabled support for environment markers
2759 introduced in v20.5.
2764 * Issue #503: Restore support for PEP 345 environment
2765 markers by updating to Packaging 16.6.
2770 * New release process that relies on
2771 `bumpversion <https://github.com/peritus/bumpversion>`_
2772 and Travis CI for continuous deployment.
2773 * Project versioning semantics now follow
2774 `semver <https://semver.org>`_ precisely.
2775 The 'v' prefix on version numbers now also allows
2776 version numbers to be referenced in the changelog,
2777 e.g. http://setuptools.readthedocs.io/en/latest/history.html#v20-6-0.
2782 * BB Pull Request #185, #470: Add support for environment markers
2783 in requirements in install_requires, setup_requires,
2784 tests_require as well as adding a test for the existing
2785 extra_requires machinery.
2790 * Issue #422: Moved hosting to
2791 `Github <https://github.com/pypa/setuptools>`_
2792 from `Bitbucket <https://bitbucket.org/pypa/setuptools>`_.
2793 Issues have been migrated, though all issues and comments
2794 are attributed to bb-migration. So if you have a particular
2795 issue or issues to which you've been subscribed, you will
2796 want to "watch" the equivalent issue in Github.
2797 The Bitbucket project will be retained for the indefinite
2798 future, but Github now hosts the canonical project repository.
2803 * Issue #519: Remove import hook when reloading the
2804 ``pkg_resources`` module.
2805 * BB Pull Request #184: Update documentation in ``pkg_resources``
2806 around new ``Requirement`` implementation.
2811 * BB Pull Request #179: ``pkg_resources.Requirement`` objects are
2812 now a subclass of ``packaging.requirements.Requirement``,
2813 allowing any environment markers and url (if any) to be
2814 affiliated with the requirement
2815 * BB Pull Request #179: Restore use of RequirementParseError
2816 exception unintentionally dropped in 20.2.
2821 * Issue #502: Correct regression in parsing of multiple
2822 version specifiers separated by commas and spaces.
2827 * Issue #499: Restore compatibility for legacy versions
2828 by bumping to packaging 16.4.
2833 * Changelog now includes release dates and links to PEPs.
2834 * BB Pull Request #173: Replace dual PEP 345 _markerlib implementation
2835 and PEP 426 implementation of environment marker support from
2836 packaging 16.1 and PEP 508. Fixes Issue #122.
2837 See also BB Pull Request #175, BB Pull Request #168, and
2838 BB Pull Request #164. Additionally:
2840 - ``Requirement.parse`` no longer retains the order of extras.
2841 - ``parse_requirements`` now requires that all versions be
2842 PEP-440 compliant, as revealed in #499. Packages released
2843 with invalid local versions should be re-released using
2844 the proper local version syntax, e.g. ``mypkg-1.0+myorg.1``.
2849 * Update ``upload_docs`` command to also honor keyring
2850 for password resolution.
2855 * Added support for using passwords from keyring in the upload
2856 command. See `the upload docs
2857 <https://setuptools.readthedocs.io/en/latest/setuptools.html#upload-upload-source-and-or-egg-distributions-to-pypi>`_
2863 * Issue #118: Once again omit the package metadata (egg-info)
2864 from the list of outputs in ``--record``. This version of setuptools
2865 can no longer be used to upgrade pip earlier than 6.0.
2870 * Off-project PR: `0dcee79 <https://github.com/pypa/setuptools/commit/0dcee791dfdcfacddaaec79b29f30a347a147413>`_ and `f9bd9b9 <https://github.com/pypa/setuptools/commit/f9bd9b9f5df54ef5a0bf8d16c3a889ab8c640580>`_
2871 For FreeBSD, also `honor root certificates from ca_root_nss <https://github.com/pypa/setuptools/commit/3ae46c30225eb46e1f5aada1a19e88b79f04dc72>`_.
2876 * Issue #491: Correct regression incurred in 19.4 where
2877 a double-namespace package installed using pip would
2883 * Restore compatibility for PyPy 3 compatibility lost in
2884 19.4.1 addressing Issue #487.
2885 * ``setuptools.launch`` shim now loads scripts in a new
2886 namespace, avoiding getting relative imports from
2887 the setuptools package on Python 2.
2892 * Added a new entry script ``setuptools.launch``,
2893 implementing the shim found in
2894 ``pip.util.setuptools_build``. Use this command to launch
2895 distutils-only packages under setuptools in the same way that
2896 pip does, causing the setuptools monkeypatching of distutils
2897 to be invoked prior to invoking a script. Useful for debugging
2898 or otherwise installing a distutils-only package under
2899 setuptools when pip isn't available or otherwise does not
2900 expose the desired functionality. For example::
2902 $ python -m setuptools.launch setup.py develop
2904 * Issue #488: Fix dual manifestation of Extension class in
2905 extension packages installed as dependencies when Cython
2911 * Issue #486: Correct TypeError when getfilesystemencoding
2913 * Issue #139: Clarified the license as MIT.
2914 * BB Pull Request #169: Removed special handling of command
2915 spec in scripts for Jython.
2920 * Issue #487: Use direct invocation of ``importlib.machinery``
2921 in ``pkg_resources`` to avoid missing detection on relevant
2927 * Issue #341: Correct error in path handling of package data
2928 files in ``build_py`` command when package is empty.
2929 * Distribute #323, Issue #141, Issue #207, and
2930 BB Pull Request #167: Another implementation of
2931 ``pkg_resources.WorkingSet`` and ``pkg_resources.Distribution``
2932 that supports replacing an extant package with a new one,
2933 allowing for setup_requires dependencies to supersede installed
2934 packages for the session.
2939 * Issue #229: Implement new technique for readily incorporating
2940 dependencies conditionally from vendored copies or primary
2941 locations. Adds a new dependency on six.
2946 * BB Pull Request #163: Add get_command_list method to Distribution.
2947 * BB Pull Request #162: Add missing whitespace to multiline string
2953 * Issue #476: Cast version to string (using default encoding)
2954 to avoid creating Unicode types on Python 2 clients.
2955 * Issue #477: In Powershell downloader, use explicit rendering
2956 of strings, rather than rely on ``repr``, which can be
2957 incorrect (especially on Python 2).
2962 * Issue #215: The bootstrap script ``ez_setup.py`` now
2963 automatically detects
2964 the latest version of setuptools (using PyPI JSON API) rather
2965 than hard-coding a particular value.
2966 * Issue #475: Fix incorrect usage in _translate_metadata2.
2971 * Issue #442: Use RawConfigParser for parsing .pypirc file.
2972 Interpolated values are no longer honored in .pypirc files.
2977 * Issue #440: Prevent infinite recursion when a SandboxViolation
2978 or other UnpickleableException occurs in a sandbox context
2979 with setuptools hidden. Fixes regression introduced in Setuptools
2985 * Deprecated ``egg_info.get_pkg_info_revision``.
2986 * Issue #471: Don't rely on repr for an HTML attribute value in
2988 * Issue #419: Avoid errors in FileMetadata when the metadata directory
2990 * Issue #472: Remove deprecated use of 'U' in mode parameter
2996 * Issue #469: Refactored logic for Issue #419 fix to re-use metadata
2997 loading from Provider.
3002 * Update dependency on certify.
3003 * BB Pull Request #160: Improve detection of gui script in
3004 ``easy_install._adjust_header``.
3005 * Made ``test.test_args`` a non-data property; alternate fix
3006 for the issue reported in BB Pull Request #155.
3007 * Issue #453: In ``ez_setup`` bootstrap module, unload all
3008 ``pkg_resources`` modules following download.
3009 * BB Pull Request #158: Honor PEP-488 when excluding
3010 files for namespace packages.
3011 * Issue #419 and BB Pull Request #144: Add experimental support for
3012 reading the version info from distutils-installed metadata rather
3013 than using the version in the filename.
3018 * Issue #464: Correct regression in invocation of superclass on old-style
3024 * Issue #439: When installing entry_point scripts under development,
3025 omit the version number of the package, allowing any version of the
3031 * In preparation for dropping support for Python 3.2, a warning is
3032 now logged when pkg_resources is imported on Python 3.2 or earlier
3034 * `Add support for python_platform_implementation environment marker
3035 <https://github.com/pypa/setuptools/commit/94416707fd59a65f4a8f7f70541d6b3fc018b626>`_.
3036 * `Fix dictionary mutation during iteration
3037 <https://github.com/pypa/setuptools/commit/57ebfa41e0f96b97e599ecd931b7ae8a143e096e>`_.
3042 * Issue #446: Test command now always invokes unittest, even
3043 if no test suite is supplied.
3048 * Correct another regression in setuptools.findall
3049 where the fix for Python #12885 was lost.
3054 * Issue #425: Correct regression in setuptools.findall.
3059 * BB Pull Request #135: Setuptools now allows disabling of
3060 the manipulation of the sys.path
3061 during the processing of the easy-install.pth file. To do so, set
3062 the environment variable ``SETUPTOOLS_SYS_PATH_TECHNIQUE`` to
3063 anything but "rewrite" (consider "raw"). During any install operation
3064 with manipulation disabled, setuptools packages will be appended to
3067 Future versions may change the default behavior to disable
3068 manipulation. If so, the default behavior can be retained by setting
3069 the variable to "rewrite".
3071 * Issue #257: ``easy_install --version`` now shows more detail
3072 about the installation location and Python version.
3074 * Refactor setuptools.findall in preparation for re-submission
3080 * Issue #412: More efficient directory search in ``find_packages``.
3085 * Upgrade to vendored packaging 15.3.
3090 * Issue #401: Fix failure in test suite.
3095 * Dropped support for builds with Pyrex. Only Cython is supported.
3096 * Issue #288: Detect Cython later in the build process, after
3097 ``setup_requires`` dependencies are resolved.
3098 Projects backed by Cython can now be readily built
3099 with a ``setup_requires`` dependency. For example::
3101 ext = setuptools.Extension('mylib', ['src/CythonStuff.pyx', 'src/CStuff.c'])
3105 setup_requires=['cython'],
3108 For compatibility with older versions of setuptools, packagers should
3109 still include ``src/CythonMod.c`` in the source distributions or
3110 require that Cython be present before building source distributions.
3111 However, for systems with this build of setuptools, Cython will be
3112 downloaded on demand.
3113 * Issue #396: Fixed test failure on OS X.
3114 * BB Pull Request #136: Remove excessive quoting from shebang headers
3120 * Backed out unintended changes to pkg_resources, restoring removal of
3121 deprecated imp module (`ref
3122 <https://bitbucket.org/pypa/setuptools/commits/f572ec9563d647fa8d4ffc534f2af8070ea07a8b#comment-1881283>`_).
3127 * Issue #380: Add support for range operators on environment
3133 * Issue #378: Do not use internal importlib._bootstrap module.
3134 * Issue #390: Disallow console scripts with path separators in
3135 the name. Removes unintended functionality and brings behavior
3136 into parity with pip.
3141 * BB Pull Request #130: Better error messages for errors in
3142 parsed requirements.
3143 * BB Pull Request #133: Removed ``setuptools.tests`` from the
3145 * BB Pull Request #129: Address deprecation warning due to usage
3151 * Issue #373: Provisionally expose
3152 ``pkg_resources._initialize_master_working_set``, allowing for
3153 imperative re-initialization of the master working set.
3158 * Updated to Packaging 15.1 to address Packaging #28.
3159 * Fix ``setuptools.sandbox._execfile()`` with Python 3.1.
3164 * BB Pull Request #126: DistributionNotFound message now lists the package or
3165 packages that required it. E.g.::
3167 pkg_resources.DistributionNotFound: The 'colorama>=0.3.1' distribution was not found and is required by smlib.log.
3169 Note that zc.buildout once dependended on the string rendering of this
3170 message to determine the package that was not found. This expectation
3171 has since been changed, but older versions of buildout may experience
3172 problems. See Buildout #242 for details.
3177 * Issue #307: Removed PEP-440 warning during parsing of versions
3178 in ``pkg_resources.Distribution``.
3179 * Issue #364: Replace deprecated usage with recommended usage of
3180 ``EntryPoint.load``.
3185 * Issue #254: When creating temporary egg cache on Unix, use mode 755
3186 for creating the directory to avoid the subsequent warning if
3187 the directory is group writable.
3192 * Issue #137: Update ``Distribution.hashcmp`` so that Distributions with
3193 None for pyversion or platform can be compared against Distributions
3194 defining those attributes.
3199 * Issue #360: Removed undesirable behavior from test runs, preventing
3200 write tests and installation to system site packages.
3205 * BB Pull Request #125: Add ``__ne__`` to Requirement class.
3206 * Various refactoring of easy_install.
3211 * Bootstrap script now accepts ``--to-dir`` to customize save directory or
3212 allow for re-use of existing repository of setuptools versions. See
3213 BB Pull Request #112 for background.
3214 * Issue #285: ``easy_install`` no longer will default to installing
3215 packages to the "user site packages" directory if it is itself installed
3216 there. Instead, the user must pass ``--user`` in all cases to install
3217 packages to the user site packages.
3218 This behavior now matches that of "pip install". To configure
3219 an environment to always install to the user site packages, consider
3220 using the "install-dir" and "scripts-dir" parameters to easy_install
3221 through an appropriate distutils config file.
3226 * Issue #359: Include pytest.ini in the sdist so invocation of py.test on the
3227 sdist honors the pytest configuration.
3232 Re-release of 13.0. Intermittent connectivity issues caused the release
3233 process to fail and PyPI uploads no longer accept files for 13.0.
3238 * Issue #356: Back out BB Pull Request #119 as it requires Setuptools 10 or later
3239 as the source during an upgrade.
3240 * Removed build_py class from setup.py. According to 892f439d216e, this
3241 functionality was added to support upgrades from old Distribute versions,
3247 * BB Pull Request #119: Restore writing of ``setup_requires`` to metadata
3248 (previously added in 8.4 and removed in 9.0).
3253 * Documentation is now linked using the rst.linker package.
3254 * Fix ``setuptools.command.easy_install.extract_wininst_cfg()``
3255 with Python 2.6 and 2.7.
3256 * Issue #354. Added documentation on building setuptools
3262 * Issue #345: Unload all modules under pkg_resources during
3263 ``ez_setup.use_setuptools()``.
3264 * Issue #336: Removed deprecation from ``ez_setup.use_setuptools``,
3265 as it is clearly still used by buildout's bootstrap. ``ez_setup``
3266 remains deprecated for use by individual packages.
3267 * Simplified implementation of ``ez_setup.use_setuptools``.
3272 * BB Pull Request #118: Soften warning for non-normalized versions in
3278 * Issue #339: Correct Attribute reference in ``cant_write_to_target``.
3279 * Issue #336: Deprecated ``ez_setup.use_setuptools``.
3284 * Issue #335: Fix script header generation on Windows.
3289 * Fixed incorrect class attribute in ``install_scripts``. Tests would be nice.
3294 * Issue #331: Fixed ``install_scripts`` command on Windows systems corrupting
3300 * Restore ``setuptools.command.easy_install.sys_executable`` for pbr
3301 compatibility. For the future, tools should construct a CommandSpec
3307 * Issue #188: Setuptools now support multiple entities in the value for
3308 ``build.executable``, such that an executable of "/usr/bin/env my-python" may
3309 be specified. This means that systems with a specified executable whose name
3310 has spaces in the path must be updated to escape or quote that value.
3311 * Deprecated ``easy_install.ScriptWriter.get_writer``, replaced by ``.best()``
3312 with slightly different semantics (no force_windows flag).
3317 * Issue #327: Formalize and restore support for any printable character in an
3323 * Expose ``EntryPoint.resolve`` in place of EntryPoint._load, implementing the
3324 simple, non-requiring load. Deprecated all uses of ``EntryPoint._load``
3325 except for calling with no parameters, which is just a shortcut for
3326 ``ep.require(); ep.resolve();``.
3328 Apps currently invoking ``ep.load(require=False)`` should instead do the
3329 following if wanting to avoid the deprecating warning::
3331 getattr(ep, "resolve", lambda: ep.load(require=False))()
3336 * Pip #2326: Report deprecation warning at stacklevel 2 for easier diagnosis.
3341 * Issue #281: Since Setuptools 6.1 (Issue #268), a ValueError would be raised
3342 in certain cases where VersionConflict was raised with two arguments, which
3343 occurred in ``pkg_resources.WorkingSet.find``. This release adds support
3344 for indicating the dependent packages while maintaining support for
3345 a VersionConflict when no dependent package context is known. New unit tests
3346 now capture the expected interface.
3351 * Interop #3: Upgrade to Packaging 15.0; updates to PEP 440 so that >1.7 does
3352 not exclude 1.7.1 but does exclude 1.7.0 and 1.7.0.post1.
3357 * Issue #323: Fix regression in entry point name parsing.
3362 * Deprecated use of EntryPoint.load(require=False). Passing a boolean to a
3363 function to select behavior is an anti-pattern. Instead use
3364 ``Entrypoint._load()``.
3365 * Substantial refactoring of all unit tests. Tests are now much leaner and
3366 re-use a lot of fixtures and contexts for better clarity of purpose.
3371 * Issue #320: Added a compatibility implementation of
3372 ``sdist._default_revctrl``
3373 so that systems relying on that interface do not fail (namely, Ubuntu 12.04
3374 and similar Debian releases).
3379 * Issue #319: Fixed issue installing pure distutils packages.
3384 * Issue #313: Removed built-in support for subversion. Projects wishing to
3385 retain support for subversion will need to use a third party library. The
3386 extant implementation is being ported to `setuptools_svn
3387 <https://pypi.org/project/setuptools_svn/>`_.
3388 * Issue #315: Updated setuptools to hide its own loaded modules during
3389 installation of another package. This change will enable setuptools to
3390 upgrade (or downgrade) itself even when its own metadata and implementation
3396 * Prefer vendored packaging library `as recommended
3397 <https://github.com/pypa/setuptools/commit/170657b68f4b92e7e1bf82f5e19a831f5744af67>`_.
3402 * Issue #312: Restored presence of pkg_resources API tests (doctest) to sdist.
3407 * Issue #314: Disabled support for ``setup_requires`` metadata to avoid issue
3408 where Setuptools was unable to upgrade over earlier versions.
3413 * BB Pull Request #106: Now write ``setup_requires`` metadata.
3418 * Issue #311: Decoupled pkg_resources from setuptools once again.
3419 ``pkg_resources`` is now a package instead of a module.
3424 * Issue #306: Suppress warnings about Version format except in select scenarios
3425 (such as installation).
3430 * BB Pull Request #85: Search egg-base when adding egg-info to manifest.
3435 * Upgrade ``packaging`` to 14.5, giving preference to "rc" as designator for
3436 release candidates over "c".
3437 * PEP-440 warnings are now raised as their own class,
3438 ``pkg_resources.PEP440Warning``, instead of RuntimeWarning.
3439 * Disabled warnings on empty versions.
3444 * Upgrade ``packaging`` to 14.4, fixing an error where there is a
3445 different result for if 2.0.5 is contained within >2.0dev and >2.0.dev even
3446 though normalization rules should have made them equal.
3447 * Issue #296: Add warning when a version is parsed as legacy. This warning will
3448 make it easier for developers to recognize deprecated version numbers.
3453 * Issue #296: Restored support for ``__hash__`` on parse_version results.
3458 * Issue #296: Restored support for ``__getitem__`` and sort operations on
3459 parse_version result.
3464 * Issue #296: Restore support for iteration over parse_version result, but
3465 deprecated that usage with a warning. Fixes failure with buildout.
3470 * Implement PEP 440 within
3471 pkg_resources and setuptools. This change
3472 deprecates some version numbers such that they will no longer be installable
3473 without using the ``===`` escape hatch. See `the changes to test_resources
3474 <https://bitbucket.org/pypa/setuptools/commits/dcd552da643c4448056de84c73d56da6d70769d5#chg-setuptools/tests/test_resources.py>`_
3475 for specific examples of version numbers and specifiers that are no longer
3476 supported. Setuptools now "vendors" the `packaging
3477 <https://github.com/pypa/packaging>`_ library.
3482 * Issue #80, Issue #209: Eggs that are downloaded for ``setup_requires``,
3483 ``test_requires``, etc. are now placed in a ``./.eggs`` directory instead of
3484 directly in the current directory. This choice of location means the files
3485 can be readily managed (removed, ignored). Additionally,
3486 later phases or invocations of setuptools will not detect the package as
3487 already installed and ignore it for permanent install (See #209).
3489 This change is indicated as backward-incompatible as installations that
3490 depend on the installation in the current directory will need to account for
3491 the new location. Systems that ignore ``*.egg`` will probably need to be
3492 adapted to ignore ``.eggs``. The files will need to be manually moved or
3493 will be retrieved again. Most use cases will require no attention.
3498 * Issue #268: When resolving package versions, a VersionConflict now reports
3499 which package previously required the conflicting version.
3504 * Issue #262: Fixed regression in pip install due to egg-info directories
3505 being omitted. Re-opens Issue #118.
3510 * Issue #259: Fixed regression with namespace package handling on ``single
3511 version, externally managed`` installs.
3516 * Issue #100: When building a distribution, Setuptools will no longer match
3517 default files using platform-dependent case sensitivity, but rather will
3518 only match the files if their case matches exactly. As a result, on Windows
3519 and other case-insensitive file systems, files with names such as
3520 'readme.txt' or 'README.TXT' will be omitted from the distribution and a
3521 warning will be issued indicating that 'README.txt' was not found. Other
3522 filenames affected are:
3527 - setup.py (or the script name)
3530 Any users producing distributions with filenames that match those above
3531 case-insensitively, but not case-sensitively, should rename those files in
3532 their repository for better portability.
3533 * BB Pull Request #72: When using ``single_version_externally_managed``, the
3534 exclusion list now includes Python 3.2 ``__pycache__`` entries.
3535 * BB Pull Request #76 and BB Pull Request #78: lines in top_level.txt are now
3536 ordered deterministically.
3537 * Issue #118: The egg-info directory is now no longer included in the list
3539 * Issue #258: Setuptools now patches distutils msvc9compiler to
3540 recognize the specially-packaged compiler package for easy extension module
3541 support on Python 2.6, 2.7, and 3.2.
3546 * Issue #237: ``pkg_resources`` now uses explicit detection of Python 2 vs.
3547 Python 3, supporting environments where builtins have been patched to make
3548 Python 3 look more like Python 2.
3553 * Issue #240: Based on real-world performance measures against 5.4, zip
3554 manifests are now cached in all circumstances. The
3555 ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` environment variable is no longer
3556 relevant. The observed "memory increase" referenced in the 5.4 release
3557 notes and detailed in Issue #154 was likely not an increase over the status
3558 quo, but rather only an increase over not storing the zip info at all.
3563 * Issue #242: Use absolute imports in svn_utils to avoid issues if the
3564 installing package adds an xml module to the path.
3569 * Issue #239: Fix typo in 5.5 such that fix did not take.
3574 * Issue #239: Setuptools now includes the setup_requires directive on
3575 Distribution objects and validates the syntax just like install_requires
3576 and tests_require directives.
3581 * Issue #236: Corrected regression in execfile implementation for Python 2.6.
3586 * Python #7776: (ssl_support) Correct usage of host for validation when
3587 tunneling for HTTPS.
3592 * Issue #154: ``pkg_resources`` will now cache the zip manifests rather than
3593 re-processing the same file from disk multiple times, but only if the
3594 environment variable ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` is set. Clients
3595 that package many modules in the same zip file will see some improvement
3596 in startup time by enabling this feature. This feature is not enabled by
3597 default because it causes a substantial increase in memory usage.
3602 * Issue #185: Make svn tagging work on the new style SVN metadata.
3604 * Prune revision control directories (e.g .svn) from base path
3605 as well as sub-directories.
3610 * Added a `Developer Guide
3611 <https://setuptools.readthedocs.io/en/latest/developer-guide.html>`_ to the official
3613 * Some code refactoring and cleanup was done with no intended behavioral
3615 * During install_egg_info, the generated lines for namespace package .pth
3616 files are now processed even during a dry run.
3621 * Issue #202: Implemented more robust cache invalidation for the ZipImporter,
3622 building on the work in Issue #168. Special thanks to Jurko Gospodnetic and
3628 * Issue #220: Restored script templates.
3633 * Renamed script templates to end with .tmpl now that they no longer need
3634 to be processed by 2to3. Fixes spurious syntax errors during build/install.
3639 * Issue #218: Re-release of 3.8.1 to signal that it supersedes 4.x.
3640 * Incidentally, script templates were updated not to include the triple-quote
3643 3.7.1 and 3.8.1 and 4.0.1
3644 -------------------------
3646 * Issue #213: Use legacy StringIO behavior for compatibility under pbr.
3647 * Issue #218: Setuptools 3.8.1 superseded 4.0.1, and 4.x was removed
3648 from the available versions to install.
3653 * Issue #210: ``setup.py develop`` now copies scripts in binary mode rather
3654 than text mode, matching the behavior of the ``install`` command.
3659 * Extend Issue #197 workaround to include all Python 3 versions prior to
3665 * Issue #193: Improved handling of Unicode filenames when building manifests.
3670 * Issue #203: Honor proxy settings for Powershell downloader in the bootstrap
3676 * Issue #168: More robust handling of replaced zip files and stale caches.
3677 Fixes ZipImportError complaining about a 'bad local header'.
3682 * Issue #199: Restored ``install._install`` for compatibility with earlier
3688 * Issue #195: Follow symbolic links in find_packages (restoring behavior
3690 * Issue #197: On Python 3.1, PKG-INFO is now saved in a UTF-8 encoding instead
3691 of ``sys.getpreferredencoding`` to match the behavior on Python 2.6-3.4.
3692 * Issue #192: Preferred bootstrap location is now
3693 https://bootstrap.pypa.io/ez_setup.py (mirrored from former location).
3698 * Issue #184: Correct failure where find_package over-matched packages
3699 when directory traversal isn't short-circuited.
3704 * Issue #183: Really fix test command with Python 3.1.
3709 * Issue #183: Fix additional regression in test command on Python 3.1.
3714 * Issue #180: Fix regression in test command not caught by py.test-run tests.
3719 * Issue #176: Add parameter to the test command to support a custom test
3720 runner: --test-runner or -r.
3721 * Issue #177: Now assume most common invocation to install command on
3722 platforms/environments without stack support (issuing a warning). Setuptools
3723 now installs naturally on IronPython. Behavior on CPython should be
3729 * Add ``include`` parameter to ``setuptools.find_packages()``.
3734 * BB Pull Request #39: Add support for C++ targets from Cython ``.pyx`` files.
3735 * Issue #162: Update dependency on certifi to 1.0.1.
3736 * Issue #164: Update dependency on wincertstore to 0.2.
3741 * Issue #161: Restore Features functionality to allow backward compatibility
3742 (for Features) until the uses of that functionality is sufficiently removed.
3747 * Correct typo in previous bugfix.
3752 * Issue #157: Restore support for Python 2.6 in bootstrap script where
3753 ``zipfile.ZipFile`` does not yet have support for context managers.
3758 * Issue #125: Prevent Subversion support from creating a ~/.subversion
3759 directory just for checking the presence of a Subversion repository.
3760 * Issue #12: Namespace packages are now imported lazily. That is, the mere
3761 declaration of a namespace package in an egg on ``sys.path`` no longer
3762 causes it to be imported when ``pkg_resources`` is imported. Note that this
3763 change means that all of a namespace package's ``__init__.py`` files must
3764 include a ``declare_namespace()`` call in order to ensure that they will be
3765 handled properly at runtime. In 2.x it was possible to get away without
3766 including the declaration, but only at the cost of forcing namespace
3767 packages to be imported early, which 3.0 no longer does.
3768 * Issue #148: When building (bdist_egg), setuptools no longer adds
3769 ``__init__.py`` files to namespace packages. Any packages that rely on this
3770 behavior will need to create ``__init__.py`` files and include the
3771 ``declare_namespace()``.
3772 * Issue #7: Setuptools itself is now distributed as a zip archive in addition to
3773 tar archive. ez_setup.py now uses zip archive. This approach avoids the potential
3774 security vulnerabilities presented by use of tar archives in ez_setup.py.
3775 It also leverages the security features added to ZipFile.extract in Python 2.7.4.
3776 * Issue #65: Removed deprecated Features functionality.
3777 * BB Pull Request #28: Remove backport of ``_bytecode_filenames`` which is
3778 available in Python 2.6 and later, but also has better compatibility with
3779 Python 3 environments.
3780 * Issue #156: Fix spelling of __PYVENV_LAUNCHER__ variable.
3785 * Issue #141: Restored fix for allowing setup_requires dependencies to
3786 override installed dependencies during setup.
3787 * Issue #128: Fixed issue where only the first dependency link was honored
3788 in a distribution where multiple dependency links were supplied.
3793 * Issue #144: Read long_description using codecs module to avoid errors
3794 installing on systems where LANG=C.
3799 * Issue #139: Fix regression in re_finder for CVS repos (and maybe Git repos
3805 * Issue #129: Suppress inspection of ``*.whl`` files when searching for files
3806 in a zip-imported file.
3807 * Issue #131: Fix RuntimeError when constructing an egg fetcher.
3812 * Fix NameError during installation with Python implementations (e.g. Jython)
3813 not containing parser module.
3814 * Fix NameError in ``sdist:re_finder``.
3819 * Issue #124: Fixed error in list detection in upload_docs.
3824 * Issue #121: Exempt lib2to3 pickled grammars from DirectorySandbox.
3825 * Issue #41: Dropped support for Python 2.4 and Python 2.5. Clients requiring
3826 setuptools for those versions of Python should use setuptools 1.x.
3827 * Removed ``setuptools.command.easy_install.HAS_USER_SITE``. Clients
3828 expecting this boolean variable should use ``site.ENABLE_USER_SITE``
3830 * Removed ``pkg_resources.ImpWrapper``. Clients that expected this class
3831 should use ``pkgutil.ImpImporter`` instead.
3836 * Issue #116: Correct TypeError when reading a local package index on Python
3842 * Issue #114: Use ``sys.getfilesystemencoding`` for decoding config in
3843 ``bdist_wininst`` distributions.
3845 * Issue #105 and Issue #113: Establish a more robust technique for
3846 determining the terminal encoding::
3848 1. Try ``getpreferredencoding``
3849 2. If that returns US_ASCII or None, try the encoding from
3850 ``getdefaultlocale``. If that encoding was a "fallback" because Python
3851 could not figure it out from the environment or OS, encoding remains
3853 3. If the encoding is resolved, then make sure Python actually implements
3855 4. On the event of an error or unknown codec, revert to fallbacks
3856 (UTF-8 on Darwin, ASCII on everything else).
3857 5. On the encoding is 'mac-roman' on Darwin, use UTF-8 as 'mac-roman' was
3858 a bug on older Python releases.
3860 On a side note, it would seem that the encoding only matters for when SVN
3861 does not yet support ``--xml`` and when getting repository and svn version
3862 numbers. The ``--xml`` technique should yield UTF-8 according to some
3863 messages on the SVN mailing lists. So if the version numbers are always
3864 7-bit ASCII clean, it may be best to only support the file parsing methods
3865 for legacy SVN releases and support for SVN without the subprocess command
3866 would simple go away as support for the older SVNs does.
3871 * Issue #27: ``easy_install`` will now use credentials from .pypirc if
3872 present for connecting to the package index.
3873 * BB Pull Request #21: Omit unwanted newlines in ``package_index._encode_auth``
3874 when the username/password pair length indicates wrapping.
3879 * Issue #99: Fix filename encoding issues in SVN support.
3884 * Remove exuberant warning in SVN support when SVN is not used.
3889 * Address security vulnerability in SSL match_hostname check as reported in
3891 * Prefer `backports.ssl_match_hostname
3892 <https://pypi.org/project/backports.ssl_match_hostname/>`_ for backport
3893 implementation if present.
3894 * Correct NameError in ``ssl_support`` module (``socket.error``).
3899 * Issue #26: Add support for SVN 1.7. Special thanks to Philip Thiem for the
3901 * Issue #93: Wheels are now distributed with every release. Note that as
3902 reported in Issue #108, as of Pip 1.4, scripts aren't installed properly
3903 from wheels. Therefore, if using Pip to install setuptools from a wheel,
3904 the ``easy_install`` command will not be available.
3905 * Setuptools "natural" launcher support, introduced in 1.0, is now officially
3911 * Fixed behavior of NameError handling in 'script template (dev).py' (script
3912 launcher for 'develop' installs).
3913 * ``ez_setup.py`` now ensures partial downloads are cleaned up following
3915 * Distribute #363 and Issue #55: Skip an sdist test that fails on locales
3921 * Distribute #349: ``sandbox.execfile`` now opens the target file in binary
3922 mode, thus honoring a BOM in the file when compiled.
3927 * Issue #69: Second attempt at fix (logic was reversed).
3932 * Issue #77: Fix error in upload command (Python 2.4).
3937 * Fix NameError in previous patch.
3942 * Issue #69: Correct issue where 404 errors are returned for URLs with
3943 fragments in them (such as #egg=).
3948 * Issue #75: Add ``--insecure`` option to ez_setup.py to accommodate
3949 environments where a trusted SSL connection cannot be validated.
3950 * Issue #76: Fix AttributeError in upload command with Python 2.4.
3955 * Issue #71 (Distribute #333): EasyInstall now puts less emphasis on the
3956 condition when a host is blocked via ``--allow-hosts``.
3957 * Issue #72: Restored Python 2.4 compatibility in ``ez_setup.py``.
3962 * Issue #60: On Windows, Setuptools supports deferring to another launcher,
3963 such as Vinay Sajip's `pylauncher <https://bitbucket.org/pypa/pylauncher>`_
3964 (included with Python 3.3) to launch console and GUI scripts and not install
3965 its own launcher executables. This experimental functionality is currently
3966 only enabled if the ``SETUPTOOLS_LAUNCHER`` environment variable is set to
3967 "natural". In the future, this behavior may become default, but only after
3968 it has matured and seen substantial adoption. The ``SETUPTOOLS_LAUNCHER``
3969 also accepts "executable" to force the default behavior of creating launcher
3971 * Issue #63: Bootstrap script (ez_setup.py) now prefers Powershell, curl, or
3972 wget for retrieving the Setuptools tarball for improved security of the
3973 install. The script will still fall back to a simple ``urlopen`` on
3974 platforms that do not have these tools.
3975 * Issue #65: Deprecated the ``Features`` functionality.
3976 * Issue #52: In ``VerifyingHTTPSConn``, handle a tunnelled (proxied)
3979 Backward-Incompatible Changes
3980 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3982 This release includes a couple of backward-incompatible changes, but most if
3983 not all users will find 1.0 a drop-in replacement for 0.9.
3985 * Issue #50: Normalized API of environment marker support. Specifically,
3986 removed line number and filename from SyntaxErrors when returned from
3987 ``pkg_resources.invalid_marker``. Any clients depending on the specific
3988 string representation of exceptions returned by that function may need to
3989 be updated to account for this change.
3990 * Issue #50: SyntaxErrors generated by ``pkg_resources.invalid_marker`` are
3991 normalized for cross-implementation consistency.
3992 * Removed ``--ignore-conflicts-at-my-risk`` and ``--delete-conflicting``
3993 options to easy_install. These options have been deprecated since 0.6a11.
3998 * Issue #53: Fix NameErrors in ``_vcs_split_rev_from_url``.
4003 * Issue #49: Correct AttributeError on PyPy where a hashlib.HASH object does
4004 not have a ``.name`` attribute.
4005 * Issue #34: Documentation now refers to bootstrap script in code repository
4006 referenced by bookmark.
4007 * Add underscore-separated keys to environment markers (markerlib).
4012 * Issue #44: Test failure on Python 2.4 when MD5 hash doesn't have a ``.name``
4018 * Python #17980: Fix security vulnerability in SSL certificate validation.
4023 * Issue #43: Fix issue (introduced in 0.9.1) with version resolution when
4024 upgrading over other releases of Setuptools.
4029 * Issue #42: Fix new ``AttributeError`` introduced in last fix.
4034 * Issue #42: Fix regression where blank checksums would trigger an
4040 * Distribute #386: Allow other positional and keyword arguments to os.open.
4041 * Corrected dependency on certifi mis-referenced in 0.9.
4046 * ``package_index`` now validates hashes other than MD5 in download links.
4051 * Code base now runs on Python 2.4 - Python 3.3 without Python 2to3
4057 * Distribute #375: Yet another fix for yet another regression.
4062 * Distribute #375: Repair AttributeError created in last release (redo).
4063 * Issue #30: Added test for get_cache_path.
4068 * Distribute #375: Repair AttributeError created in last release.
4073 * Issue #21: Restore Python 2.4 compatibility in ``test_easy_install``.
4074 * Distribute #375: Merged additional warning from Distribute 0.6.46.
4075 * Now honor the environment variable
4076 ``SETUPTOOLS_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT`` in addition to the now
4077 deprecated ``DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT``.
4082 * Issue #20: Fix comparison of parsed SVN version on Python 3.
4087 * Issue #1: Disable installation of Windows-specific files on non-Windows systems.
4088 * Use new sysconfig module with Python 2.7 or >=3.2.
4093 * Issue #14: Use markerlib when the ``parser`` module is not available.
4094 * Issue #10: ``ez_setup.py`` now uses HTTPS to download setuptools from PyPI.
4099 * Fix NameError (Issue #3) again - broken in bad merge.
4104 * Merged Setuptools and Distribute. See docs/merge.txt for details.
4106 Added several features that were slated for setuptools 0.6c12:
4108 * Index URL now defaults to HTTPS.
4109 * Added experimental environment marker support. Now clients may designate a
4110 PEP-426 environment marker for "extra" dependencies. Setuptools uses this
4111 feature in ``setup.py`` for optional SSL and certificate validation support
4112 on older platforms. Based on Distutils-SIG discussions, the syntax is
4113 somewhat tentative. There should probably be a PEP with a firmer spec before
4114 the feature should be considered suitable for use.
4115 * Added support for SSL certificate validation when installing packages from
4121 * Issue #3: Fixed NameError in SSL support.
4126 * Move warning check in ``get_cache_path`` to follow the directory creation
4127 to avoid errors when the cache path does not yet exist. Fixes the error
4128 reported in Distribute #375.
4133 * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
4139 * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
4145 * Distribute #375: Issue a warning if the PYTHON_EGG_CACHE or otherwise
4146 customized egg cache location specifies a directory that's group- or
4152 * Distribute #379: ``distribute_setup.py`` now traps VersionConflict as well,
4153 restoring ability to upgrade from an older setuptools version.
4158 * ``distribute_setup.py`` has been updated to allow Setuptools 0.7 to
4159 satisfy use_setuptools.
4164 * Distribute #378: Restore support for Python 2.4 Syntax (regression in 0.6.42).
4169 * External links finder no longer yields duplicate links.
4170 * Distribute #337: Moved site.py to setuptools/site-patch.py (graft of very old
4171 patch from setuptools trunk which inspired PR #31).
4176 * Distribute #27: Use public api for loading resources from zip files rather than
4177 the private method ``_zip_directory_cache``.
4178 * Added a new function ``easy_install.get_win_launcher`` which may be used by
4179 third-party libraries such as buildout to get a suitable script launcher.
4184 * Distribute #376: brought back cli.exe and gui.exe that were deleted in the
4190 * Add support for console launchers on ARM platforms.
4191 * Fix possible issue in GUI launchers where the subsystem was not supplied to
4193 * Launcher build script now refactored for robustness.
4194 * Distribute #375: Resources extracted from a zip egg to the file system now also
4195 check the contents of the file against the zip contents during each
4196 invocation of get_resource_filename.
4201 * Distribute #371: The launcher manifest file is now installed properly.
4206 * Distribute #143: Launcher scripts, including easy_install itself, are now
4207 accompanied by a manifest on 32-bit Windows environments to avoid the
4208 Installer Detection Technology and thus undesirable UAC elevation described
4209 in `this Microsoft article
4210 <http://technet.microsoft.com/en-us/library/cc709628%28WS.10%29.aspx>`_.
4215 * BB Pull Request #35: In Buildout #64, it was reported that
4216 under Python 3, installation of distutils scripts could attempt to copy
4217 the ``__pycache__`` directory as a file, causing an error, apparently only
4218 under Windows. Easy_install now skips all directories when processing
4225 Note this release is backward-incompatible with distribute 0.6.23-0.6.34 in
4226 how it parses version numbers.
4228 * Distribute #278: Restored compatibility with distribute 0.6.22 and setuptools
4229 0.6. Updated the documentation to match more closely with the version
4230 parsing as intended in setuptools 0.6.
4235 * Distribute #341: 0.6.33 fails to build under Python 2.4.
4240 * Fix 2 errors with Jython 2.5.
4241 * Fix 1 failure with Jython 2.5 and 2.7.
4242 * Disable workaround for Jython scripts on Linux systems.
4243 * Distribute #336: ``setup.py`` no longer masks failure exit code when tests fail.
4244 * Fix issue in pkg_resources where try/except around a platform-dependent
4245 import would trigger hook load failures on Mercurial. See pull request 32
4247 * Distribute #341: Fix a ResourceWarning.
4252 * Fix test suite with Python 2.6.
4253 * Fix some DeprecationWarnings and ResourceWarnings.
4254 * Distribute #335: Backed out ``setup_requires`` superceding installed requirements
4255 until regression can be addressed.
4260 * Distribute #303: Make sure the manifest only ever contains UTF-8 in Python 3.
4261 * Distribute #329: Properly close files created by tests for compatibility with
4263 * Work around Jython #1980 and Jython #1981.
4264 * Distribute #334: Provide workaround for packages that reference ``sys.__stdout__``
4265 such as numpy does. This change should address
4266 `virtualenv #359 <https://github.com/pypa/virtualenv/issues/359>`_ as long
4267 as the system encoding is UTF-8 or the IO encoding is specified in the
4270 PYTHONIOENCODING=utf8 pip install numpy
4272 * Fix for encoding issue when installing from Windows executable on Python 3.
4273 * Distribute #323: Allow ``setup_requires`` requirements to supercede installed
4274 requirements. Added some new keyword arguments to existing pkg_resources
4275 methods. Also had to updated how __path__ is handled for namespace packages
4276 to ensure that when a new egg distribution containing a namespace package is
4277 placed on sys.path, the entries in __path__ are found in the same order they
4278 would have been in had that egg been on the path when pkg_resources was
4284 * Distribute #328: Clean up temporary directories in distribute_setup.py.
4285 * Fix fatal bug in distribute_setup.py.
4290 * BB Pull Request #14: Honor file permissions in zip files.
4291 * Distribute #327: Merged pull request #24 to fix a dependency problem with pip.
4292 * Merged pull request #23 to fix https://github.com/pypa/virtualenv/issues/301.
4293 * If Sphinx is installed, the ``upload_docs`` command now runs ``build_sphinx``
4294 to produce uploadable documentation.
4295 * Distribute #326: ``upload_docs`` provided mangled auth credentials under Python 3.
4296 * Distribute #320: Fix check for "createable" in distribute_setup.py.
4297 * Distribute #305: Remove a warning that was triggered during normal operations.
4298 * Distribute #311: Print metadata in UTF-8 independent of platform.
4299 * Distribute #303: Read manifest file with UTF-8 encoding under Python 3.
4300 * Distribute #301: Allow to run tests of namespace packages when using 2to3.
4301 * Distribute #304: Prevent import loop in site.py under Python 3.3.
4302 * Distribute #283: Reenable scanning of ``*.pyc`` / ``*.pyo`` files on Python 3.3.
4303 * Distribute #299: The develop command didn't work on Python 3, when using 2to3,
4304 as the egg link would go to the Python 2 source. Linking to the 2to3'd code
4305 in build/lib makes it work, although you will have to rebuild the module
4307 * Distribute #306: Even if 2to3 is used, we build in-place under Python 2.
4308 * Distribute #307: Prints the full path when .svn/entries is broken.
4309 * Distribute #313: Support for sdist subcommands (Python 2.7)
4310 * Distribute #314: test_local_index() would fail an OS X.
4311 * Distribute #310: Non-ascii characters in a namespace __init__.py causes errors.
4312 * Distribute #218: Improved documentation on behavior of ``package_data`` and
4313 ``include_package_data``. Files indicated by ``package_data`` are now included
4315 * ``distribute_setup.py`` now allows a ``--download-base`` argument for retrieving
4316 distribute from a specified location.
4321 * Distribute #294: setup.py can now be invoked from any directory.
4322 * Scripts are now installed honoring the umask.
4323 * Added support for .dist-info directories.
4324 * Distribute #283: Fix and disable scanning of ``*.pyc`` / ``*.pyo`` files on
4330 * Support current snapshots of CPython 3.3.
4331 * Distribute now recognizes README.rst as a standard, default readme file.
4332 * Exclude 'encodings' modules when removing modules from sys.modules.
4333 Workaround for #285.
4334 * Distribute #231: Don't fiddle with system python when used with buildout
4340 * Distribute #183: Symlinked files are now extracted from source distributions.
4341 * Distribute #227: Easy_install fetch parameters are now passed during the
4342 installation of a source distribution; now fulfillment of setup_requires
4343 dependencies will honor the parameters passed to easy_install.
4348 * Distribute #258: Workaround a cache issue
4349 * Distribute #260: distribute_setup.py now accepts the --user parameter for
4350 Python 2.6 and later.
4351 * Distribute #262: package_index.open_with_auth no longer throws LookupError
4353 * Distribute #269: AttributeError when an exception occurs reading Manifest.in
4354 on late releases of Python.
4355 * Distribute #272: Prevent TypeError when namespace package names are unicode
4356 and single-install-externally-managed is used. Also fixes PIP issue
4358 * Distribute #273: Legacy script launchers now install with Python2/3 support.
4363 * Distribute #249: Added options to exclude 2to3 fixers
4368 * Distribute #244: Fixed a test
4369 * Distribute #243: Fixed a test
4370 * Distribute #239: Fixed a test
4371 * Distribute #240: Fixed a test
4372 * Distribute #241: Fixed a test
4373 * Distribute #237: Fixed a test
4374 * Distribute #238: easy_install now uses 64bit executable wrappers on 64bit Python
4375 * Distribute #208: Fixed parsed_versions, it now honors post-releases as noted in the documentation
4376 * Distribute #207: Windows cli and gui wrappers pass CTRL-C to child python process
4377 * Distribute #227: easy_install now passes its arguments to setup.py bdist_egg
4378 * Distribute #225: Fixed a NameError on Python 2.5, 2.4
4383 * Distribute #225: FIxed a regression on py2.4
4388 * Distribute #135: Include url in warning when processing URLs in package_index.
4389 * Distribute #212: Fix issue where easy_instal fails on Python 3 on windows installer.
4390 * Distribute #213: Fix typo in documentation.
4395 * Distribute #206: AttributeError: 'HTTPMessage' object has no attribute 'getheaders'
4400 * Distribute #210: Fixed a regression introduced by Distribute #204 fix.
4405 * Support 'DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT' environment
4406 variable to allow to disable installation of easy_install-${version} script.
4407 * Support Python >=3.1.4 and >=3.2.1.
4408 * Distribute #204: Don't try to import the parent of a namespace package in
4410 * Distribute #196: Tolerate responses with multiple Content-Length headers
4411 * Distribute #205: Sandboxing doesn't preserve working_set. Leads to setup_requires
4417 * Builds sdist gztar even on Windows (avoiding Distribute #193).
4418 * Distribute #192: Fixed metadata omitted on Windows when package_dir
4419 specified with forward-slash.
4420 * Distribute #195: Cython build support.
4421 * Distribute #200: Issues with recognizing 64-bit packages on Windows.
4426 * Fixed typo in bdist_egg
4427 * Several issues under Python 3 has been solved.
4428 * Distribute #146: Fixed missing DLL files after easy_install of windows exe package.
4433 * Distribute #170: Fixed unittest failure. Thanks to Toshio.
4434 * Distribute #171: Fixed race condition in unittests cause deadlocks in test suite.
4435 * Distribute #143: Fixed a lookup issue with easy_install.
4436 Thanks to David and Zooko.
4437 * Distribute #174: Fixed the edit mode when its used with setuptools itself
4442 * Distribute #160: 2.7 gives ValueError("Invalid IPv6 URL")
4443 * Distribute #150: Fixed using ~/.local even in a --no-site-packages virtualenv
4444 * Distribute #163: scan index links before external links, and don't use the md5 when
4445 comparing two distributions
4450 * Distribute #149: Fixed various failures on 2.3/2.4
4455 * Found another case of SandboxViolation - fixed
4456 * Distribute #15 and Distribute #48: Introduced a socket timeout of 15 seconds on url openings
4457 * Added indexsidebar.html into MANIFEST.in
4458 * Distribute #108: Fixed TypeError with Python3.1
4459 * Distribute #121: Fixed --help install command trying to actually install.
4460 * Distribute #112: Added an os.makedirs so that Tarek's solution will work.
4461 * Distribute #133: Added --no-find-links to easy_install
4462 * Added easy_install --user
4463 * Distribute #100: Fixed develop --user not taking '.' in PYTHONPATH into account
4464 * Distribute #134: removed spurious UserWarnings. Patch by VanLindberg
4465 * Distribute #138: cant_write_to_target error when setup_requires is used.
4466 * Distribute #147: respect the sys.dont_write_bytecode flag
4471 * Reverted change made for the DistributionNotFound exception because
4472 zc.buildout uses the exception message to get the name of the
4478 * Distribute #90: unknown setuptools version can be added in the working set
4479 * Distribute #87: setupt.py doesn't try to convert distribute_setup.py anymore
4480 Initial Patch by arfrever.
4481 * Distribute #89: added a side bar with a download link to the doc.
4482 * Distribute #86: fixed missing sentence in pkg_resources doc.
4483 * Added a nicer error message when a DistributionNotFound is raised.
4484 * Distribute #80: test_develop now works with Python 3.1
4485 * Distribute #93: upload_docs now works if there is an empty sub-directory.
4486 * Distribute #70: exec bit on non-exec files
4487 * Distribute #99: now the standalone easy_install command doesn't uses a
4488 "setup.cfg" if any exists in the working directory. It will use it
4489 only if triggered by ``install_requires`` from a setup.py call
4490 (install, develop, etc).
4491 * Distribute #101: Allowing ``os.devnull`` in Sandbox
4492 * Distribute #92: Fixed the "no eggs" found error with MacPort
4493 (platform.mac_ver() fails)
4494 * Distribute #103: test_get_script_header_jython_workaround not run
4495 anymore under py3 with C or POSIX local. Contributed by Arfrever.
4496 * Distribute #104: removed the assertion when the installation fails,
4497 with a nicer message for the end user.
4498 * Distribute #100: making sure there's no SandboxViolation when
4499 the setup script patches setuptools.
4504 * Added "check_packages" in dist. (added in Setuptools 0.6c11)
4505 * Fixed the DONT_PATCH_SETUPTOOLS state.
4510 * Distribute #58: Added --user support to the develop command
4511 * Distribute #11: Generated scripts now wrap their call to the script entry point
4512 in the standard "if name == 'main'"
4513 * Added the 'DONT_PATCH_SETUPTOOLS' environment variable, so virtualenv
4514 can drive an installation that doesn't patch a global setuptools.
4515 * Reviewed unladen-swallow specific change from
4516 http://code.google.com/p/unladen-swallow/source/detail?spec=svn875&r=719
4517 and determined that it no longer applies. Distribute should work fine with
4518 Unladen Swallow 2009Q3.
4519 * Distribute #21: Allow PackageIndex.open_url to gracefully handle all cases of a
4520 httplib.HTTPException instead of just InvalidURL and BadStatusLine.
4521 * Removed virtual-python.py from this distribution and updated documentation
4522 to point to the actively maintained virtualenv instead.
4523 * Distribute #64: use_setuptools no longer rebuilds the distribute egg every
4525 * use_setuptools now properly respects the requested version
4526 * use_setuptools will no longer try to import a distribute egg for the
4527 wrong Python version
4528 * Distribute #74: no_fake should be True by default.
4529 * Distribute #72: avoid a bootstrapping issue with easy_install -U
4534 * Unified the bootstrap file so it works on both py2.x and py3k without 2to3
4535 (patch by Holger Krekel)
4540 * Distribute #65: cli.exe and gui.exe are now generated at build time,
4541 depending on the platform in use.
4543 * Distribute #67: Fixed doc typo (PEP 381/PEP 382).
4545 * Distribute no longer shadows setuptools if we require a 0.7-series
4546 setuptools. And an error is raised when installing a 0.7 setuptools with
4549 * When run from within buildout, no attempt is made to modify an existing
4550 setuptools egg, whether in a shared egg directory or a system setuptools.
4552 * Fixed a hole in sandboxing allowing builtin file to write outside of
4558 * Added the generation of ``distribute_setup_3k.py`` during the release.
4559 This closes Distribute #52.
4561 * Added an upload_docs command to easily upload project documentation to
4562 PyPI's https://pythonhosted.org. This close issue Distribute #56.
4564 * Fixed a bootstrap bug on the use_setuptools() API.
4572 * Fixed a bunch of calls to file() that caused crashes on Python 3.
4577 * Fixed a bug in sorting that caused bootstrap to fail on Python 3.
4585 * Added Python 3 support; see docs/python3.txt.
4586 This closes Old Setuptools #39.
4588 * Added option to run 2to3 automatically when installing on Python 3.
4589 This closes issue Distribute #31.
4591 * Fixed invalid usage of requirement.parse, that broke develop -d.
4592 This closes Old Setuptools #44.
4594 * Fixed script launcher for 64-bit Windows.
4595 This closes Old Setuptools #2.
4597 * KeyError when compiling extensions.
4598 This closes Old Setuptools #41.
4603 * Fixed bootstrap not working on Windows. This closes issue Distribute #49.
4605 * Fixed 2.6 dependencies. This closes issue Distribute #50.
4607 * Make sure setuptools is patched when running through easy_install
4608 This closes Old Setuptools #40.
4616 * package_index.urlopen now catches BadStatusLine and malformed url errors.
4617 This closes Distribute #16 and Distribute #18.
4619 * zip_ok is now False by default. This closes Old Setuptools #33.
4621 * Fixed invalid URL error catching. Old Setuptools #20.
4623 * Fixed invalid bootstraping with easy_install installation (Distribute #40).
4624 Thanks to Florian Schulze for the help.
4626 * Removed buildout/bootstrap.py. A new repository will create a specific
4627 bootstrap.py script.
4633 * The bootstrap process leave setuptools alone if detected in the system
4634 and --root or --prefix is provided, but is not in the same location.
4635 This closes Distribute #10.
4643 * Packages required at build time where not fully present at install time.
4644 This closes Distribute #12.
4646 * Protected against failures in tarfile extraction. This closes Distribute #10.
4648 * Made Jython api_tests.txt doctest compatible. This closes Distribute #7.
4650 * sandbox.py replaced builtin type file with builtin function open. This
4651 closes Distribute #6.
4653 * Immediately close all file handles. This closes Distribute #3.
4655 * Added compatibility with Subversion 1.6. This references Distribute #1.
4660 * Avoid a call to /usr/bin/sw_vers on OSX and use the official platform API
4661 instead. Based on a patch from ronaldoussoren. This closes issue #5.
4663 * Fixed a SandboxViolation for mkdir that could occur in certain cases.
4664 This closes Distribute #13.
4666 * Allow to find_on_path on systems with tight permissions to fail gracefully.
4667 This closes Distribute #9.
4669 * Corrected inconsistency between documentation and code of add_entry.
4670 This closes Distribute #8.
4672 * Immediately close all file handles. This closes Distribute #3.
4677 * Immediately close all file handles. This closes Distribute #3.
4682 * Fixed a missing files problem when using Windows source distributions on
4683 non-Windows platforms, due to distutils not handling manifest file line
4686 * Updated Pyrex support to work with Pyrex 0.9.6 and higher.
4688 * Minor changes for Jython compatibility, including skipping tests that can't
4691 * Fixed not installing eggs in ``install_requires`` if they were also used for
4692 ``setup_requires`` or ``tests_require``.
4694 * Fixed not fetching eggs in ``install_requires`` when running tests.
4696 * Allow ``ez_setup.use_setuptools()`` to upgrade existing setuptools
4697 installations when called from a standalone ``setup.py``.
4699 * Added a warning if a namespace package is declared, but its parent package
4700 is not also declared as a namespace.
4702 * Support Subversion 1.5
4704 * Removed use of deprecated ``md5`` module if ``hashlib`` is available
4706 * Fixed ``bdist_wininst upload`` trying to upload the ``.exe`` twice
4708 * Fixed ``bdist_egg`` putting a ``native_libs.txt`` in the source package's
4709 ``.egg-info``, when it should only be in the built egg's ``EGG-INFO``.
4711 * Ensure that _full_name is set on all shared libs before extensions are
4712 checked for shared lib usage. (Fixes a bug in the experimental shared
4713 library build support.)
4715 * Fix to allow unpacked eggs containing native libraries to fail more
4716 gracefully under Google App Engine (with an ``ImportError`` loading the
4717 C-based module, instead of getting a ``NameError``).
4719 * Fixed ``win32.exe`` support for .pth files, so unnecessary directory nesting
4720 is flattened out in the resulting egg. (There was a case-sensitivity
4721 problem that affected some distributions, notably ``pywin32``.)
4723 * Prevent ``--help-commands`` and other junk from showing under Python 2.5
4724 when running ``easy_install --help``.
4726 * Fixed GUI scripts sometimes not executing on Windows
4728 * Fixed not picking up dependency links from recursive dependencies.
4730 * Only make ``.py``, ``.dll`` and ``.so`` files executable when unpacking eggs
4732 * Changes for Jython compatibility
4734 * Improved error message when a requirement is also a directory name, but the
4735 specified directory is not a source package.
4737 * Fixed ``--allow-hosts`` option blocking ``file:`` URLs
4739 * Fixed HTTP SVN detection failing when the page title included a project
4740 name (e.g. on SourceForge-hosted SVN)
4742 * Fix Jython script installation to handle ``#!`` lines better when
4743 ``sys.executable`` is a script.
4745 * Removed use of deprecated ``md5`` module if ``hashlib`` is available
4747 * Keep site directories (e.g. ``site-packages``) from being included in
4753 * Fixed ``distutils.filelist.findall()`` crashing on broken symlinks, and
4754 ``egg_info`` command failing on new, uncommitted SVN directories.
4756 * Fix import problems with nested namespace packages installed via
4757 ``--root`` or ``--single-version-externally-managed``, due to the
4758 parent package not having the child package as an attribute.
4760 * ``ftp:`` download URLs now work correctly.
4762 * The default ``--index-url`` is now ``https://pypi.python.org/simple``, to use
4763 the Python Package Index's new simpler (and faster!) REST API.
4768 * Added ``--egg-path`` option to ``develop`` command, allowing you to force
4769 ``.egg-link`` files to use relative paths (allowing them to be shared across
4770 platforms on a networked drive).
4772 * Fix not building binary RPMs correctly.
4774 * Fix "eggsecutables" (such as setuptools' own egg) only being runnable with
4775 bash-compatible shells.
4777 * Fix ``#!`` parsing problems in Windows ``.exe`` script wrappers, when there
4778 was whitespace inside a quoted argument or at the end of the ``#!`` line
4779 (a regression introduced in 0.6c4).
4781 * Fix ``test`` command possibly failing if an older version of the project
4782 being tested was installed on ``sys.path`` ahead of the test source
4785 * Fix ``find_packages()`` treating ``ez_setup`` and directories with ``.`` in
4786 their names as packages.
4788 * EasyInstall no longer aborts the installation process if a URL it wants to
4789 retrieve can't be downloaded, unless the URL is an actual package download.
4790 Instead, it issues a warning and tries to keep going.
4792 * Fixed distutils-style scripts originally built on Windows having their line
4793 endings doubled when installed on any platform.
4795 * Added ``--local-snapshots-ok`` flag, to allow building eggs from projects
4796 installed using ``setup.py develop``.
4798 * Fixed not HTML-decoding URLs scraped from web pages
4803 * Fix uploaded ``bdist_rpm`` packages being described as ``bdist_egg``
4804 packages under Python versions less than 2.5.
4806 * Fix uploaded ``bdist_wininst`` packages being described as suitable for
4807 "any" version by Python 2.5, even if a ``--target-version`` was specified.
4809 * Fixed ``.dll`` files on Cygwin not having executable permissions when an egg
4810 is installed unzipped.
4815 * Overhauled Windows script wrapping to support ``bdist_wininst`` better.
4816 Scripts installed with ``bdist_wininst`` will always use ``#!python.exe`` or
4817 ``#!pythonw.exe`` as the executable name (even when built on non-Windows
4818 platforms!), and the wrappers will look for the executable in the script's
4819 parent directory (which should find the right version of Python).
4821 * Fix ``upload`` command not uploading files built by ``bdist_rpm`` or
4822 ``bdist_wininst`` under Python 2.3 and 2.4.
4824 * Add support for "eggsecutable" headers: a ``#!/bin/sh`` script that is
4825 prepended to an ``.egg`` file to allow it to be run as a script on Unix-ish
4826 platforms. (This is mainly so that setuptools itself can have a single-file
4827 installer on Unix, without doing multiple downloads, dealing with firewalls,
4830 * Fix problem with empty revision numbers in Subversion 1.4 ``entries`` files
4832 * Use cross-platform relative paths in ``easy-install.pth`` when doing
4833 ``develop`` and the source directory is a subdirectory of the installation
4836 * Fix a problem installing eggs with a system packaging tool if the project
4837 contained an implicit namespace package; for example if the ``setup()``
4838 listed a namespace package ``foo.bar`` without explicitly listing ``foo``
4839 as a namespace package.
4841 * Added support for HTTP "Basic" authentication using ``http://user:pass@host``
4842 URLs. If a password-protected page contains links to the same host (and
4843 protocol), those links will inherit the credentials used to access the
4846 * Removed all special support for Sourceforge mirrors, as Sourceforge's
4847 mirror system now works well for non-browser downloads.
4849 * Fixed not recognizing ``win32.exe`` installers that included a custom
4852 * Fixed not allowing ``os.open()`` of paths outside the sandbox, even if they
4853 are opened read-only (e.g. reading ``/dev/urandom`` for random numbers, as
4854 is done by ``os.urandom()`` on some platforms).
4856 * Fixed a problem with ``.pth`` testing on Windows when ``sys.executable``
4857 has a space in it (e.g., the user installed Python to a ``Program Files``
4863 * Fixed breakages caused by Subversion 1.4's new "working copy" format
4865 * You can once again use "python -m easy_install" with Python 2.4 and above.
4867 * Python 2.5 compatibility fixes added.
4872 * The ``ez_setup`` module displays the conflicting version of setuptools (and
4873 its installation location) when a script requests a version that's not
4876 * Running ``setup.py develop`` on a setuptools-using project will now install
4877 setuptools if needed, instead of only downloading the egg.
4879 * Windows script wrappers now support quoted arguments and arguments
4880 containing spaces. (Patch contributed by Jim Fulton.)
4882 * The ``ez_setup.py`` script now actually works when you put a setuptools
4883 ``.egg`` alongside it for bootstrapping an offline machine.
4885 * A writable installation directory on ``sys.path`` is no longer required to
4886 download and extract a source distribution using ``--editable``.
4888 * Generated scripts now use ``-x`` on the ``#!`` line when ``sys.executable``
4889 contains non-ASCII characters, to prevent deprecation warnings about an
4890 unspecified encoding when the script is run.
4895 * Fixed ``AttributeError`` when trying to download a ``setup_requires``
4896 dependency when a distribution lacks a ``dependency_links`` setting.
4898 * Made ``zip-safe`` and ``not-zip-safe`` flag files contain a single byte, so
4899 as to play better with packaging tools that complain about zero-length
4902 * Made ``setup.py develop`` respect the ``--no-deps`` option, which it
4903 previously was ignoring.
4905 * Support ``extra_path`` option to ``setup()`` when ``install`` is run in
4906 backward-compatibility mode.
4908 * Source distributions now always include a ``setup.cfg`` file that explicitly
4909 sets ``egg_info`` options such that they produce an identical version number
4910 to the source distribution's version number. (Previously, the default
4911 version number could be different due to the use of ``--tag-date``, or if
4912 the version was overridden on the command line that built the source
4915 * EasyInstall now includes setuptools version information in the
4916 ``User-Agent`` string sent to websites it visits.
4921 * Fix ``register`` not obeying name/version set by ``egg_info`` command, if
4922 ``egg_info`` wasn't explicitly run first on the same command line.
4924 * Added ``--no-date`` and ``--no-svn-revision`` options to ``egg_info``
4925 command, to allow suppressing tags configured in ``setup.cfg``.
4927 * Fixed redundant warnings about missing ``README`` file(s); it should now
4928 appear only if you are actually a source distribution.
4930 * Fix creating Python wrappers for non-Python scripts
4932 * Fix ``ftp://`` directory listing URLs from causing a crash when used in the
4933 "Home page" or "Download URL" slots on PyPI.
4935 * Fix ``sys.path_importer_cache`` not being updated when an existing zipfile
4936 or directory is deleted/overwritten.
4938 * Fix not recognizing HTML 404 pages from package indexes.
4940 * Allow ``file://`` URLs to be used as a package index. URLs that refer to
4941 directories will use an internally-generated directory listing if there is
4942 no ``index.html`` file in the directory.
4944 * Allow external links in a package index to be specified using
4945 ``rel="homepage"`` or ``rel="download"``, without needing the old
4946 PyPI-specific visible markup.
4948 * Suppressed warning message about possibly-misspelled project name, if an egg
4949 or link for that project name has already been seen.
4954 * Fix ``bdist_egg`` not including files in subdirectories of ``.egg-info``.
4956 * Allow ``.py`` files found by the ``include_package_data`` option to be
4957 automatically included. Remove duplicate data file matches if both
4958 ``include_package_data`` and ``package_data`` are used to refer to the same
4961 * Fix local ``--find-links`` eggs not being copied except with
4964 * Fix sometimes not detecting local packages installed outside of "site"
4967 * Fix mysterious errors during initial ``setuptools`` install, caused by
4968 ``ez_setup`` trying to run ``easy_install`` twice, due to a code fallthru
4969 after deleting the egg from which it's running.
4974 * Don't install or update a ``site.py`` patch when installing to a
4975 ``PYTHONPATH`` directory with ``--multi-version``, unless an
4976 ``easy-install.pth`` file is already in use there.
4978 * Construct ``.pth`` file paths in such a way that installing an egg whose
4979 name begins with ``import`` doesn't cause a syntax error.
4981 * Fixed a bogus warning message that wasn't updated since the 0.5 versions.
4986 * Strip ``module`` from the end of compiled extension modules when computing
4987 the name of a ``.py`` loader/wrapper. (Python's import machinery ignores
4988 this suffix when searching for an extension module.)
4990 * Better ambiguity management: accept ``#egg`` name/version even if processing
4991 what appears to be a correctly-named distutils file, and ignore ``.egg``
4992 files with no ``-``, since valid Python ``.egg`` files always have a version
4993 number (but Scheme eggs often don't).
4995 * Support ``file://`` links to directories in ``--find-links``, so that
4996 easy_install can build packages from local source checkouts.
4998 * Added automatic retry for Sourceforge mirrors. The new download process is
4999 to first just try dl.sourceforge.net, then randomly select mirror IPs and
5000 remove ones that fail, until something works. The removed IPs stay removed
5001 for the remainder of the run.
5003 * Ignore bdist_dumb distributions when looking at download URLs.
5008 * Added ``test_loader`` keyword to support custom test loaders
5010 * Added ``setuptools.file_finders`` entry point group to allow implementing
5011 revision control plugins.
5013 * Added ``--identity`` option to ``upload`` command.
5015 * Added ``dependency_links`` to allow specifying URLs for ``--find-links``.
5017 * Enhanced test loader to scan packages as well as modules, and call
5018 ``additional_tests()`` if present to get non-unittest tests.
5020 * Support namespace packages in conjunction with system packagers, by omitting
5021 the installation of any ``__init__.py`` files for namespace packages, and
5022 adding a special ``.pth`` file to create a working package in
5025 * Made ``--single-version-externally-managed`` automatic when ``--root`` is
5026 used, so that most system packagers won't require special support for
5029 * Fixed ``setup_requires``, ``tests_require``, etc. not using ``setup.cfg`` or
5030 other configuration files for their option defaults when installing, and
5031 also made the install use ``--multi-version`` mode so that the project
5032 directory doesn't need to support .pth files.
5034 * ``MANIFEST.in`` is now forcibly closed when any errors occur while reading
5035 it. Previously, the file could be left open and the actual error would be
5036 masked by problems trying to remove the open file on Windows systems.
5038 * Process ``dependency_links.txt`` if found in a distribution, by adding the
5039 URLs to the list for scanning.
5041 * Use relative paths in ``.pth`` files when eggs are being installed to the
5042 same directory as the ``.pth`` file. This maximizes portability of the
5043 target directory when building applications that contain eggs.
5045 * Added ``easy_install-N.N`` script(s) for convenience when using multiple
5048 * Added automatic handling of installation conflicts. Eggs are now shifted to
5049 the front of sys.path, in an order consistent with where they came from,
5050 making EasyInstall seamlessly co-operate with system package managers.
5052 The ``--delete-conflicting`` and ``--ignore-conflicts-at-my-risk`` options
5053 are now no longer necessary, and will generate warnings at the end of a
5054 run if you use them.
5056 * Don't recursively traverse subdirectories given to ``--find-links``.
5061 * Fixed the ``develop`` command ignoring ``--find-links``.
5063 * Added exhaustive testing of the install directory, including a spawn test
5064 for ``.pth`` file support, and directory writability/existence checks. This
5065 should virtually eliminate the need to set or configure ``--site-dirs``.
5067 * Added ``--prefix`` option for more do-what-I-mean-ishness in the absence of
5070 * Enhanced ``PYTHONPATH`` support so that you don't have to put any eggs on it
5071 manually to make it work. ``--multi-version`` is no longer a silent
5072 default; you must explicitly use it if installing to a non-PYTHONPATH,
5073 non-"site" directory.
5075 * Expand ``$variables`` used in the ``--site-dirs``, ``--build-directory``,
5076 ``--install-dir``, and ``--script-dir`` options, whether on the command line
5077 or in configuration files.
5079 * Improved SourceForge mirror processing to work faster and be less affected
5080 by transient HTML changes made by SourceForge.
5082 * PyPI searches now use the exact spelling of requirements specified on the
5083 command line or in a project's ``install_requires``. Previously, a
5084 normalized form of the name was used, which could lead to unnecessary
5085 full-index searches when a project's name had an underscore (``_``) in it.
5087 * EasyInstall can now download bare ``.py`` files and wrap them in an egg,
5088 as long as you include an ``#egg=name-version`` suffix on the URL, or if
5089 the ``.py`` file is listed as the "Download URL" on the project's PyPI page.
5090 This allows third parties to "package" trivial Python modules just by
5091 linking to them (e.g. from within their own PyPI page or download links
5094 * The ``--always-copy`` option now skips "system" and "development" eggs since
5095 they can't be reliably copied. Note that this may cause EasyInstall to
5096 choose an older version of a package than what you expected, or it may cause
5097 downloading and installation of a fresh version of what's already installed.
5099 * The ``--find-links`` option previously scanned all supplied URLs and
5100 directories as early as possible, but now only directories and direct
5101 archive links are scanned immediately. URLs are not retrieved unless a
5102 package search was already going to go online due to a package not being
5103 available locally, or due to the use of the ``--update`` or ``-U`` option.
5105 * Fixed the annoying ``--help-commands`` wart.
5110 * The ``sdist`` command no longer uses the traditional ``MANIFEST`` file to
5111 create source distributions. ``MANIFEST.in`` is still read and processed,
5112 as are the standard defaults and pruning. But the manifest is built inside
5113 the project's ``.egg-info`` directory as ``SOURCES.txt``, and it is rebuilt
5114 every time the ``egg_info`` command is run.
5116 * Added the ``include_package_data`` keyword to ``setup()``, allowing you to
5117 automatically include any package data listed in revision control or
5120 * Added the ``exclude_package_data`` keyword to ``setup()``, allowing you to
5121 trim back files included via the ``package_data`` and
5122 ``include_package_data`` options.
5124 * Fixed ``--tag-svn-revision`` not working when run from a source
5127 * Added warning for namespace packages with missing ``declare_namespace()``
5129 * Added ``tests_require`` keyword to ``setup()``, so that e.g. packages
5130 requiring ``nose`` to run unit tests can make this dependency optional
5131 unless the ``test`` command is run.
5133 * Made all commands that use ``easy_install`` respect its configuration
5134 options, as this was causing some problems with ``setup.py install``.
5136 * Added an ``unpack_directory()`` driver to ``setuptools.archive_util``, so
5137 that you can process a directory tree through a processing filter as if it
5138 were a zipfile or tarfile.
5140 * Added an internal ``install_egg_info`` command to use as part of old-style
5141 ``install`` operations, that installs an ``.egg-info`` directory with the
5144 * Added a ``--single-version-externally-managed`` option to the ``install``
5145 command so that you can more easily wrap a "flat" egg in a system package.
5147 * Enhanced ``bdist_rpm`` so that it installs single-version eggs that
5148 don't rely on a ``.pth`` file. The ``--no-egg`` option has been removed,
5149 since all RPMs are now built in a more backwards-compatible format.
5151 * Support full roundtrip translation of eggs to and from ``bdist_wininst``
5152 format. Running ``bdist_wininst`` on a setuptools-based package wraps the
5153 egg in an .exe that will safely install it as an egg (i.e., with metadata
5154 and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
5155 back into an ``.egg`` file or directory and install it as such.
5157 * Fixed ``.pth`` file processing picking up nested eggs (i.e. ones inside
5158 "baskets") when they weren't explicitly listed in the ``.pth`` file.
5160 * If more than one URL appears to describe the exact same distribution, prefer
5161 the shortest one. This helps to avoid "table of contents" CGI URLs like the
5164 * Quote arguments to python.exe (including python's path) to avoid problems
5165 when Python (or a script) is installed in a directory whose name contains
5168 * Support full roundtrip translation of eggs to and from ``bdist_wininst``
5169 format. Running ``bdist_wininst`` on a setuptools-based package wraps the
5170 egg in an .exe that will safely install it as an egg (i.e., with metadata
5171 and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
5172 back into an ``.egg`` file or directory and install it as such.
5177 * Fixed some problems building extensions when Pyrex was installed, especially
5178 with Python 2.4 and/or packages using SWIG.
5180 * Made ``develop`` command accept all the same options as ``easy_install``,
5181 and use the ``easy_install`` command's configuration settings as defaults.
5183 * Made ``egg_info --tag-svn-revision`` fall back to extracting the revision
5184 number from ``PKG-INFO`` in case it is being run on a source distribution of
5185 a snapshot taken from a Subversion-based project.
5187 * Automatically detect ``.dll``, ``.so`` and ``.dylib`` files that are being
5188 installed as data, adding them to ``native_libs.txt`` automatically.
5190 * Fixed some problems with fresh checkouts of projects that don't include
5191 ``.egg-info/PKG-INFO`` under revision control and put the project's source
5192 code directly in the project directory. If such a package had any
5193 requirements that get processed before the ``egg_info`` command can be run,
5194 the setup scripts would fail with a "Missing 'Version:' header and/or
5195 PKG-INFO file" error, because the egg runtime interpreted the unbuilt
5196 metadata in a directory on ``sys.path`` (i.e. the current directory) as
5197 being a corrupted egg. Setuptools now monkeypatches the distribution
5198 metadata cache to pretend that the egg has valid version information, until
5199 it has a chance to make it actually be so (via the ``egg_info`` command).
5201 * Update for changed SourceForge mirror format
5203 * Fixed not installing dependencies for some packages fetched via Subversion
5205 * Fixed dependency installation with ``--always-copy`` not using the same
5206 dependency resolution procedure as other operations.
5208 * Fixed not fully removing temporary directories on Windows, if a Subversion
5209 checkout left read-only files behind
5211 * Fixed some problems building extensions when Pyrex was installed, especially
5212 with Python 2.4 and/or packages using SWIG.
5217 * Fixed not being able to install Windows script wrappers using Python 2.3
5222 * Added support for "traditional" PYTHONPATH-based non-root installation, and
5223 also the convenient ``virtual-python.py`` script, based on a contribution
5224 by Ian Bicking. The setuptools egg now contains a hacked ``site`` module
5225 that makes the PYTHONPATH-based approach work with .pth files, so that you
5226 can get the full EasyInstall feature set on such installations.
5228 * Added ``--no-deps`` and ``--allow-hosts`` options.
5230 * Improved Windows ``.exe`` script wrappers so that the script can have the
5231 same name as a module without confusing Python.
5233 * Changed dependency processing so that it's breadth-first, allowing a
5234 depender's preferences to override those of a dependee, to prevent conflicts
5235 when a lower version is acceptable to the dependee, but not the depender.
5236 Also, ensure that currently installed/selected packages aren't given
5237 precedence over ones desired by a package being installed, which could
5238 cause conflict errors.
5243 * Fixed missing gui/cli .exe files in distribution. Fixed bugs in tests.
5248 * Added ``gui_scripts`` entry point group to allow installing GUI scripts
5249 on Windows and other platforms. (The special handling is only for Windows;
5250 other platforms are treated the same as for ``console_scripts``.)
5252 * Improved error message when trying to use old ways of running
5253 ``easy_install``. Removed the ability to run via ``python -m`` or by
5254 running ``easy_install.py``; ``easy_install`` is the command to run on all
5255 supported platforms.
5257 * Improved wrapper script generation and runtime initialization so that a
5258 VersionConflict doesn't occur if you later install a competing version of a
5259 needed package as the default version of that package.
5261 * Fixed a problem parsing version numbers in ``#egg=`` links.
5266 * Added ``console_scripts`` entry point group to allow installing scripts
5267 without the need to create separate script files. On Windows, console
5268 scripts get an ``.exe`` wrapper so you can just type their name. On other
5269 platforms, the scripts are written without a file extension.
5271 * EasyInstall can now install "console_scripts" defined by packages that use
5272 ``setuptools`` and define appropriate entry points. On Windows, console
5273 scripts get an ``.exe`` wrapper so you can just type their name. On other
5274 platforms, the scripts are installed without a file extension.
5276 * Using ``python -m easy_install`` or running ``easy_install.py`` is now
5277 DEPRECATED, since an ``easy_install`` wrapper is now available on all
5283 * Added support for building "old-style" RPMs that don't install an egg for
5284 the target package, using a ``--no-egg`` option.
5286 * The ``build_ext`` command now works better when using the ``--inplace``
5287 option and multiple Python versions. It now makes sure that all extensions
5288 match the current Python version, even if newer copies were built for a
5289 different Python version.
5291 * The ``upload`` command no longer attaches an extra ``.zip`` when uploading
5292 eggs, as PyPI now supports egg uploads without trickery.
5294 * The ``ez_setup`` script/module now displays a warning before downloading
5295 the setuptools egg, and attempts to check the downloaded egg against an
5296 internal MD5 checksum table.
5298 * Fixed the ``--tag-svn-revision`` option of ``egg_info`` not finding the
5299 latest revision number; it was using the revision number of the directory
5300 containing ``setup.py``, not the highest revision number in the project.
5302 * Added ``eager_resources`` setup argument
5304 * The ``sdist`` command now recognizes Subversion "deleted file" entries and
5305 does not include them in source distributions.
5307 * ``setuptools`` now embeds itself more thoroughly into the distutils, so that
5308 other distutils extensions (e.g. py2exe, py2app) will subclass setuptools'
5309 versions of things, rather than the native distutils ones.
5311 * Added ``entry_points`` and ``setup_requires`` arguments to ``setup()``;
5312 ``setup_requires`` allows you to automatically find and download packages
5313 that are needed in order to *build* your project (as opposed to running it).
5315 * ``setuptools`` now finds its commands, ``setup()`` argument validators, and
5316 metadata writers using entry points, so that they can be extended by
5317 third-party packages. See `Creating distutils Extensions
5318 <https://setuptools.readthedocs.io/en/latest/setuptools.html#creating-distutils-extensions>`_
5321 * The vestigial ``depends`` command has been removed. It was never finished
5322 or documented, and never would have worked without EasyInstall - which it
5323 pre-dated and was never compatible with.
5325 * EasyInstall now does MD5 validation of downloads from PyPI, or from any link
5326 that has an "#md5=..." trailer with a 32-digit lowercase hex md5 digest.
5328 * EasyInstall now handles symlinks in target directories by removing the link,
5329 rather than attempting to overwrite the link's destination. This makes it
5330 easier to set up an alternate Python "home" directory (as described in
5331 the Non-Root Installation section of the docs).
5333 * Added support for handling MacOS platform information in ``.egg`` filenames,
5334 based on a contribution by Kevin Dangoor. You may wish to delete and
5335 reinstall any eggs whose filename includes "darwin" and "Power_Macintosh",
5336 because the format for this platform information has changed so that minor
5337 OS X upgrades (such as 10.4.1 to 10.4.2) do not cause eggs built with a
5338 previous OS version to become obsolete.
5340 * easy_install's dependency processing algorithms have changed. When using
5341 ``--always-copy``, it now ensures that dependencies are copied too. When
5342 not using ``--always-copy``, it tries to use a single resolution loop,
5343 rather than recursing.
5345 * Fixed installing extra ``.pyc`` or ``.pyo`` files for scripts with ``.py``
5348 * Added ``--site-dirs`` option to allow adding custom "site" directories.
5349 Made ``easy-install.pth`` work in platform-specific alternate site
5350 directories (e.g. ``~/Library/Python/2.x/site-packages`` on Mac OS X).
5352 * If you manually delete the current version of a package, the next run of
5353 EasyInstall against the target directory will now remove the stray entry
5354 from the ``easy-install.pth`` file.
5356 * EasyInstall now recognizes URLs with a ``#egg=project_name`` fragment ID
5357 as pointing to the named project's source checkout. Such URLs have a lower
5358 match precedence than any other kind of distribution, so they'll only be
5359 used if they have a higher version number than any other available
5360 distribution, or if you use the ``--editable`` option. The ``#egg``
5361 fragment can contain a version if it's formatted as ``#egg=proj-ver``,
5362 where ``proj`` is the project name, and ``ver`` is the version number. You
5363 *must* use the format for these values that the ``bdist_egg`` command uses;
5364 i.e., all non-alphanumeric runs must be condensed to single underscore
5367 * Added the ``--editable`` option; see Editing and Viewing Source Packages
5368 in the docs. Also, slightly changed the behavior of the
5369 ``--build-directory`` option.
5371 * Fixed the setup script sandbox facility not recognizing certain paths as
5372 valid on case-insensitive platforms.
5377 * The zip-safety scanner now checks for modules that might be used with
5378 ``python -m``, and marks them as unsafe for zipping, since Python 2.4 can't
5379 handle ``-m`` on zipped modules.
5381 * Fix ``python -m easy_install`` not working due to setuptools being installed
5382 as a zipfile. Update safety scanner to check for modules that might be used
5383 as ``python -m`` scripts.
5385 * Misc. fixes for win32.exe support, including changes to support Python 2.4's
5386 changed ``bdist_wininst`` format.
5391 * Fix breakage of the "develop" command that was caused by the addition of
5392 ``--always-unzip`` to the ``easy_install`` command.
5397 * Put the ``easy_install`` module back in as a module, as it's needed for
5398 ``python -m`` to run it!
5400 * Allow ``--find-links/-f`` to accept local directories or filenames as well
5406 * Include ``svn:externals`` directories in source distributions as well as
5407 normal subversion-controlled files and directories.
5409 * Added ``exclude=patternlist`` option to ``setuptools.find_packages()``
5411 * Changed --tag-svn-revision to include an "r" in front of the revision number
5412 for better readability.
5414 * Added ability to build eggs without including source files (except for any
5415 scripts, of course), using the ``--exclude-source-files`` option to
5418 * ``setup.py install`` now automatically detects when an "unmanaged" package
5419 or module is going to be on ``sys.path`` ahead of a package being installed,
5420 thereby preventing the newer version from being imported. If this occurs,
5421 a warning message is output to ``sys.stderr``, but installation proceeds
5422 anyway. The warning message informs the user what files or directories
5423 need deleting, and advises them they can also use EasyInstall (with the
5424 ``--delete-conflicting`` option) to do it automatically.
5426 * The ``egg_info`` command now adds a ``top_level.txt`` file to the metadata
5427 directory that lists all top-level modules and packages in the distribution.
5428 This is used by the ``easy_install`` command to find possibly-conflicting
5429 "unmanaged" packages when installing the distribution.
5431 * Added ``zip_safe`` and ``namespace_packages`` arguments to ``setup()``.
5432 Added package analysis to determine zip-safety if the ``zip_safe`` flag
5433 is not given, and advise the author regarding what code might need changing.
5435 * Fixed the swapped ``-d`` and ``-b`` options of ``bdist_egg``.
5437 * EasyInstall now automatically detects when an "unmanaged" package or
5438 module is going to be on ``sys.path`` ahead of a package you're installing,
5439 thereby preventing the newer version from being imported. By default, it
5440 will abort installation to alert you of the problem, but there are also
5441 new options (``--delete-conflicting`` and ``--ignore-conflicts-at-my-risk``)
5442 available to change the default behavior. (Note: this new feature doesn't
5443 take effect for egg files that were built with older ``setuptools``
5444 versions, because they lack the new metadata file required to implement it.)
5446 * The ``easy_install`` distutils command now uses ``DistutilsError`` as its
5447 base error type for errors that should just issue a message to stderr and
5448 exit the program without a traceback.
5450 * EasyInstall can now be given a path to a directory containing a setup
5451 script, and it will attempt to build and install the package there.
5453 * EasyInstall now performs a safety analysis on module contents to determine
5454 whether a package is likely to run in zipped form, and displays
5455 information about what modules may be doing introspection that would break
5456 when running as a zipfile.
5458 * Added the ``--always-unzip/-Z`` option, to force unzipping of packages that
5459 would ordinarily be considered safe to unzip, and changed the meaning of
5460 ``--zip-ok/-z`` to "always leave everything zipped".
5465 * The "egg_info" command now always sets the distribution metadata to "safe"
5466 forms of the distribution name and version, so that distribution files will
5467 be generated with parseable names (i.e., ones that don't include '-' in the
5468 name or version). Also, this means that if you use the various ``--tag``
5469 options of "egg_info", any distributions generated will use the tags in the
5470 version, not just egg distributions.
5472 * Added support for defining command aliases in distutils configuration files,
5473 under the "[aliases]" section. To prevent recursion and to allow aliases to
5474 call the command of the same name, a given alias can be expanded only once
5475 per command-line invocation. You can define new aliases with the "alias"
5476 command, either for the local, global, or per-user configuration.
5478 * Added "rotate" command to delete old distribution files, given a set of
5479 patterns to match and the number of files to keep. (Keeps the most
5480 recently-modified distribution files matching each pattern.)
5482 * Added "saveopts" command that saves all command-line options for the current
5483 invocation to the local, global, or per-user configuration file. Useful for
5484 setting defaults without having to hand-edit a configuration file.
5486 * Added a "setopt" command that sets a single option in a specified distutils
5489 * There is now a separate documentation page for setuptools; revision
5490 history that's not specific to EasyInstall has been moved to that page.
5495 * Added "upload" support for egg and source distributions, including a bug
5496 fix for "upload" and a temporary workaround for lack of .egg support in
5502 * Beefed up the "sdist" command so that if you don't have a MANIFEST.in, it
5503 will include all files under revision control (CVS or Subversion) in the
5504 current directory, and it will regenerate the list every time you create a
5505 source distribution, not just when you tell it to. This should make the
5506 default "do what you mean" more often than the distutils' default behavior
5507 did, while still retaining the old behavior in the presence of MANIFEST.in.
5509 * Fixed the "develop" command always updating .pth files, even if you
5510 specified ``-n`` or ``--dry-run``.
5512 * Slightly changed the format of the generated version when you use
5513 ``--tag-build`` on the "egg_info" command, so that you can make tagged
5514 revisions compare *lower* than the version specified in setup.py (e.g. by
5515 using ``--tag-build=dev``).
5520 * Added ``develop`` command to ``setuptools``-based packages. This command
5521 installs an ``.egg-link`` pointing to the package's source directory, and
5522 script wrappers that ``execfile()`` the source versions of the package's
5523 scripts. This lets you put your development checkout(s) on sys.path without
5524 having to actually install them. (To uninstall the link, use
5525 use ``setup.py develop --uninstall``.)
5527 * Added ``egg_info`` command to ``setuptools``-based packages. This command
5528 just creates or updates the "projectname.egg-info" directory, without
5529 building an egg. (It's used by the ``bdist_egg``, ``test``, and ``develop``
5532 * Enhanced the ``test`` command so that it doesn't install the package, but
5533 instead builds any C extensions in-place, updates the ``.egg-info``
5534 metadata, adds the source directory to ``sys.path``, and runs the tests
5535 directly on the source. This avoids an "unmanaged" installation of the
5536 package to ``site-packages`` or elsewhere.
5538 * Made ``easy_install`` a standard ``setuptools`` command, moving it from
5539 the ``easy_install`` module to ``setuptools.command.easy_install``. Note
5540 that if you were importing or extending it, you must now change your imports
5541 accordingly. ``easy_install.py`` is still installed as a script, but not as
5547 * Setup scripts using setuptools can now list their dependencies directly in
5548 the setup.py file, without having to manually create a ``depends.txt`` file.
5549 The ``install_requires`` and ``extras_require`` arguments to ``setup()``
5550 are used to create a dependencies file automatically. If you are manually
5551 creating ``depends.txt`` right now, please switch to using these setup
5552 arguments as soon as practical, because ``depends.txt`` support will be
5553 removed in the 0.6 release cycle. For documentation on the new arguments,
5554 see the ``setuptools.dist.Distribution`` class.
5556 * Setup scripts using setuptools now always install using ``easy_install``
5557 internally, for ease of uninstallation and upgrading.
5559 * Added ``--always-copy/-a`` option to always copy needed packages to the
5560 installation directory, even if they're already present elsewhere on
5561 sys.path. (In previous versions, this was the default behavior, but now
5562 you must request it.)
5564 * Added ``--upgrade/-U`` option to force checking PyPI for latest available
5565 version(s) of all packages requested by name and version, even if a matching
5566 version is available locally.
5568 * Added automatic installation of dependencies declared by a distribution
5569 being installed. These dependencies must be listed in the distribution's
5570 ``EGG-INFO`` directory, so the distribution has to have declared its
5571 dependencies by using setuptools. If a package has requirements it didn't
5572 declare, you'll still have to deal with them yourself. (E.g., by asking
5573 EasyInstall to find and install them.)
5575 * Added the ``--record`` option to ``easy_install`` for the benefit of tools
5576 that run ``setup.py install --record=filename`` on behalf of another
5582 * Fixed not setting script permissions to allow execution.
5584 * Improved sandboxing so that setup scripts that want a temporary directory
5585 (e.g. pychecker) can still run in the sandbox.
5590 * Fix stupid stupid refactoring-at-the-last-minute typos. :(
5595 * Added support for "self-installation" bootstrapping. Packages can now
5596 include ``ez_setup.py`` in their source distribution, and add the following
5597 to their ``setup.py``, in order to automatically bootstrap installation of
5598 setuptools as part of their setup process::
5600 from ez_setup import use_setuptools
5603 from setuptools import setup
5606 * Added support for converting ``.win32.exe`` installers to eggs on the fly.
5607 EasyInstall will now recognize such files by name and install them.
5609 * Fixed a problem with picking the "best" version to install (versions were
5610 being sorted as strings, rather than as parsed values)
5615 * Added support for the distutils "verbose/quiet" and "dry-run" options, as
5616 well as the "optimize" flag.
5618 * Support downloading packages that were uploaded to PyPI (by scanning all
5619 links on package pages, not just the homepage/download links).
5624 * Add progress messages to the search/download process so that you can tell
5625 what URLs it's reading to find download links. (Hopefully, this will help
5626 people report out-of-date and broken links to package authors, and to tell
5627 when they've asked for a package that doesn't exist.)
5632 * Added ``ez_setup.py`` installer/bootstrap script to make initial setuptools
5633 installation easier, and to allow distributions using setuptools to avoid
5634 having to include setuptools in their source distribution.
5636 * All downloads are now managed by the ``PackageIndex`` class (which is now
5637 subclassable and replaceable), so that embedders can more easily override
5638 download logic, give download progress reports, etc. The class has also
5639 been moved to the new ``setuptools.package_index`` module.
5641 * The ``Installer`` class no longer handles downloading, manages a temporary
5642 directory, or tracks the ``zip_ok`` option. Downloading is now handled
5643 by ``PackageIndex``, and ``Installer`` has become an ``easy_install``
5644 command class based on ``setuptools.Command``.
5646 * There is a new ``setuptools.sandbox.run_setup()`` API to invoke a setup
5647 script in a directory sandbox, and a new ``setuptools.archive_util`` module
5648 with an ``unpack_archive()`` API. These were split out of EasyInstall to
5649 allow reuse by other tools and applications.
5651 * ``setuptools.Command`` now supports reinitializing commands using keyword
5652 arguments to set/reset options. Also, ``Command`` subclasses can now set
5653 their ``command_consumes_arguments`` attribute to ``True`` in order to
5654 receive an ``args`` option containing the rest of the command line.
5656 * Added support for installing scripts
5658 * Added support for setting options via distutils configuration files, and
5659 using distutils' default options as a basis for EasyInstall's defaults.
5661 * Renamed ``--scan-url/-s`` to ``--find-links/-f`` to free up ``-s`` for the
5662 script installation directory option.
5664 * Use ``urllib2`` instead of ``urllib``, to allow use of ``https:`` URLs if
5665 Python includes SSL support.
5670 * Added ``--scan-url`` and ``--index-url`` options, to scan download pages
5671 and search PyPI for needed packages.
5676 * Restrict ``--build-directory=DIR/-b DIR`` option to only be used with single
5677 URL installs, to avoid running the wrong setup.py.
5682 * Added ``--build-directory=DIR/-b DIR`` option.
5684 * Added "installation report" that explains how to use 'require()' when doing
5685 a multiversion install or alternate installation directory.
5687 * Added SourceForge mirror auto-select (Contributed by Ian Bicking)
5689 * Added "sandboxing" that stops a setup script from running if it attempts to
5690 write to the filesystem outside of the build area
5692 * Added more workarounds for packages with quirky ``install_data`` hacks
5697 * Added new options to ``bdist_egg`` to allow tagging the egg's version number
5698 with a subversion revision number, the current date, or an explicit tag
5699 value. Run ``setup.py bdist_egg --help`` to get more information.
5701 * Added subversion download support for ``svn:`` and ``svn+`` URLs, as well as
5702 automatic recognition of HTTP subversion URLs (Contributed by Ian Bicking)
projects / platform / upstream / python3-setuptools.git / blob