7 * #3395: Included a performance optimization: ``setuptools.build_meta`` no longer tries
8 to :func:`compile` the setup script code before :func:`exec`-ing it.
12 * #3435: Corrected issue in macOS framework builds on Python 3.9 not installed by homebrew (pypa/distutils#158).
21 * #3430: Merge with pypa/distutils@152c13d including pypa/distutils#155 (improved compatibility for editable installs on homebrew Python 3.9), pypa/distutils#150 (better handling of runtime_library_dirs on cygwin), and pypa/distutils#151 (remove warnings for namespace packages).
30 * #3421: Drop setuptools' support for installing an entrypoint extra requirements at load time:
31 - the functionality has been broken since v60.8.0.
32 - the mechanism to do so is deprecated (`fetch_build_eggs`).
33 - that use case (e.g. a custom command class entrypoint) is covered by making sure the necessary build requirements are declared.
37 * #3305: Updated the example pyproject.toml -- by :user:`jacalata`
38 * #3394: This updates the documentation for the ``file_finders`` hook so that
39 the logging recommendation aligns with the suggestion to not use
40 ``distutils`` directly.
41 * #3397: Fix reference for ``keywords`` to point to the Core Metadata Specification
42 instead of PEP 314 (the live standard is kept always up-to-date and
43 consolidates several PEPs together in a single document).
44 * #3402: Reordered the User Guide's Table of Contents -- by :user:`codeandfire`
53 * #3253: Enabled using ``file:`` for requirements in setup.cfg -- by :user:`akx`
54 (this feature is currently considered to be in **beta** stage).
55 * #3255: Enabled using ``file:`` for dependencies and optional-dependencies in pyproject.toml -- by :user:`akx`
56 (this feature is currently considered to be in **beta** stage).
57 * #3391: Updated ``attr:`` to also extract simple constants with type annotations -- by :user:`karlotness`
66 * #3347: Changed warnings and documentation notes about *experimental* aspect of ``pyproject.toml`` configuration:
67 now ``[project]`` is a fully supported configuration interface, but the ``[tool.setuptools]`` table
68 and sub-tables are still considered to be in **beta** stage.
69 * #3383: In _distutils_hack, suppress/undo the use of local distutils when select tests are imported in CPython.
73 * #3368: Added documentation page about extension modules -- by :user:`mkoeppe`
74 * #3371: Moved documentation from ``/userguide/commands`` to ``/depracted/commands``.
75 This change was motived by the fact that running ``python setup.py`` directly is
76 considered a deprecated practice.
77 * #3372: Consolidated sections about ``sdist`` contents and ``MANIFEST.in`` into a single page.
79 Added a simple ``MANIFEST.in`` example.
80 * #3373: Moved remarks about using :pypi:`Cython` to the newly created page for
82 * #3374: Added clarification that using ``python setup.py egg_info`` commands to
83 manage project versions is only supported in a *transitional* basis, and
84 that eventually ``egg_info`` will be deprecated.
86 Reorganized sections with tips for managing versions.
87 * #3378: Updated ``Quickstart`` docs to make it easier to follow for beginners.
91 * #3385: Modules used to parse and evaluate configuration from ``pyproject.toml`` files are
92 intended for internal use only and that not part of the public API.
101 * #3256: Added setuptools.command.build command to match distutils.command.build -- by :user:`isuruf`
102 * #3366: Merge with pypa/distutils@75ed79d including reformat using black, fix for Cygwin support (pypa/distutils#139), and improved support for cross compiling (pypa/distutils#144 and pypa/distutils#145).
104 Documentation changes
105 ^^^^^^^^^^^^^^^^^^^^^
106 * #3355: Changes to the User Guide's Entry Points page -- by :user:`codeandfire`
107 * #3361: Further minor corrections to the Entry Points page -- by :user:`codeandfire`
108 * #3363: Rework some documentation pages to de-emphasize ``distutils`` and the history
109 of packaging in the Python ecosystem. The focus of these changes is to make the
110 documentation easier to read for new users.
111 * #3364: Update documentation about dependency management, removing mention to
112 the deprecated ``dependency_links`` and adding some small improvements.
113 * #3367: Extracted text about automatic resource extraction and the zip-safe flag
114 from ``userguide/miscellaneous`` to ``deprecated/resource_extraction`` and
115 ``deprecated/zip_safe``.
117 Extracted text about additional metadata files from
118 ``userguide/miscellaneous`` into the existing ``userguide/extension``
121 Updated ``userguide/extension`` to better reflect the status of the
124 Removed ``userguide/functionalities_rewrite`` (a virtually empty part of the
132 Documentation changes
133 ^^^^^^^^^^^^^^^^^^^^^
134 * #3349: Fixed two small issues preventing docs from building locally -- by :user:`codeandfire`
135 * #3350: Added note explaining ``package_data`` glob pattern matching for dotfiles -- by :user:`comabrewer`
136 * #3358: Clarify the role of the ``package_dir`` configuration.
140 * #3354: Improve clarity in warning about unlisted namespace packages.
147 Documentation changes
148 ^^^^^^^^^^^^^^^^^^^^^
149 * #3331: Replaced single backticks with double ones in ``CHANGES.rst`` -- by :user:`codeandfire`
150 * #3332: Fixed grammar/typos, modified example directory trees for src-layout and flat-layout -- by :user:`codeandfire`
151 * #3335: Changes to code snippets and other examples in the Data Files page of the User Guide -- by :user:`codeandfire`
155 * #3336: Modified ``test_setup_install_includes_dependencies`` to work with custom ``PYTHONPATH`` –- by :user:`hroncok`
164 * #3328: Include a first line summary to some of the existing multi-line warnings.
173 * #3320: Fixed typo which causes ``namespace_packages`` to raise an error instead of
183 * #3262: Formally added deprecation messages for ``namespace_packages``.
184 The methodology that uses ``pkg_resources`` and ``namespace_packages`` for
185 creating namespaces was already discouraged by the :doc:`setuptools docs
186 </userguide/package_discovery>` and the
187 :doc:`Python Packaging User Guide <PyPUG:guides/packaging-namespace-packages>`,
188 therefore this change just make the deprecation more official.
189 Users can consider migrating to native/implicit namespaces (as introduced in
191 * #3308: Relying on ``include_package_data`` to ensure sub-packages are automatically
192 added to the build wheel distribution (as "data") is now considered a
195 This behaviour was controversial and caused inconsistencies (#3260).
197 Instead, projects are encouraged to properly configure ``packages`` or use
198 discovery tools. General information can be found in :doc:`userguide/package_discovery`.
202 * #1806: Allowed recursive globs (``**``) in ``package_data``. -- by :user:`nullableVoidPtr`
203 * #3206: Fixed behaviour when both ``install_requires`` (in ``setup.py``) and
204 ``dependencies`` (in ``pyproject.toml``) are specified.
205 The configuration in ``pyproject.toml`` will take precedence over ``setup.py``
206 (in accordance with PEP 621). A warning was added to inform users.
208 Documentation changes
209 ^^^^^^^^^^^^^^^^^^^^^
210 * #3307: Added introduction to references/keywords.
212 Added deprecation tags to test kwargs.
214 Moved userguide/keywords to deprecated section.
216 Clarified in deprecated doc what keywords came from distutils and which were added or changed by setuptools.
220 * #3274: Updated version of vendored ``pyparsing`` to 3.0.8 to avoid problems with
221 upcoming deprecation in Python 3.11.
222 * #3292: Added warning about incompatibility with old versions of
223 ``importlib-metadata``.
232 * #3299: Optional metadata fields are now truly optional. Includes merge with pypa/distutils@a7cfb56 per pypa/distutils#138.
236 * #3282: Added CI cache for ``setup.cfg`` examples used when testing ``setuptools.config``.
245 * #3258: Merge pypa/distutils@5229dad46b.
249 * #3249: Simplified ``package_dir`` obtained via auto-discovery.
258 * #3151: Made ``setup.py develop --user`` install to the user site packages directory even if it is disabled in the current interpreter.
262 * #3153: When resolving requirements use both canonical and normalized names -- by :user:`ldaniluk`
263 * #3167: Honor unix file mode in ZipFile when installing wheel via ``install_as_egg`` -- by :user:`delijati`
267 * #3088: Fixed duplicated tag with the ``dist-info`` command.
268 * #3247: Fixed problem preventing ``readme`` specified as dynamic in ``pyproject.toml``
269 from being dynamically specified in ``setup.py``.
278 * #3233: Included missing test file ``setupcfg_examples.txt`` in ``sdist``.
279 * #3233: Added script that allows developers to download ``setupcfg_examples.txt`` prior to
280 running tests. By caching these files it should be possible to run the test suite
290 * #3229: Disabled automatic download of ``trove-classifiers`` to facilitate reproducibility.
294 * #3229: Updated ``pyproject.toml`` validation via ``validate-pyproject`` v0.7.1.
295 * #3229: New internal tool made available for updating the code responsible for
296 the validation of ``pyproject.toml``.
297 This tool can be executed via ``tox -e generate-validation-code``.
306 * #3215: Ignored a subgroup of invalid ``pyproject.toml`` files that use the ``[project]``
307 table to specify only ``requires-python`` (**transitional**).
310 Please note that future releases of setuptools will halt the build process
311 if a ``pyproject.toml`` file that does not match doc:`the PyPA Specification
312 <PyPUG:specifications/declaring-project-metadata>` is given.
313 * #3215: Updated ``pyproject.toml`` validation, as generated by ``validate-pyproject==0.6.1``.
314 * #3218: Prevented builds from erroring if the project specifies metadata via
315 ``pyproject.toml``, but uses other files (e.g. ``setup.py``) to complement it,
316 without setting ``dynamic`` properly.
319 This is a **transitional** behaviour.
320 Future releases of ``setuptools`` may simply ignore externally set metadata
321 not backed by ``dynamic`` or even halt the build with an error.
322 * #3224: Merge changes from pypa/distutils@e1d5c9b1f6
324 Documentation changes
325 ^^^^^^^^^^^^^^^^^^^^^
326 * #3217: Fixed typo in ``pyproject.toml`` example in Quickstart -- by :user:`pablo-cardenas`.
330 * #3223: Fixed missing requirements with environment markers when
331 ``optional-dependencies`` is set in ``pyproject.toml``.
340 * #3212: Fixed missing dependencies when running ``setup.py install``.
341 Note that calling ``setup.py install`` directly is still deprecated and
342 will be removed in future versions of ``setuptools``.
343 Please check the release notes for :ref:`setup_install_deprecation_note`.
352 * #3206: Changed ``setuptools.convert_path`` to an internal function that is not exposed
353 as part of setuptools API.
354 Future releases of ``setuptools`` are likely to remove this function.
358 * #3202: Changed behaviour of auto-discovery to not explicitly expand ``package_dir``
359 for flat-layouts and to not use relative paths starting with ``./``.
360 * #3203: Prevented ``pyproject.toml`` parsing from overwriting
361 ``dist.include_package_data`` explicitly set in ``setup.py`` with default
363 * #3208: Added a warning for non existing files listed with the ``file`` directive in
364 ``setup.cfg`` and ``pyproject.toml``.
365 * #3208: Added a default value for dynamic ``classifiers`` in ``pyproject.toml`` when
366 files are missing and errors being ignored.
367 * #3211: Disabled auto-discovery when distribution class has a ``configuration``
368 attribute (e.g. when the ``setup.py`` script contains ``setup(...,
369 configuration=...)``). This is done to ensure extension-only packages created
370 with ``numpy.distutils.misc_util.Configuration`` are not broken by the safe
372 behaviour to avoid accidental multiple top-level packages in a flat-layout.
375 Users that don't set ``packages``, ``py_modules``, or ``configuration`` are
376 still likely to observe the auto-discovery behavior, which may halt the
377 build if the project contains multiple directories and/or multiple Python
378 files directly under the project root.
380 To disable auto-discovery please explicitly set either ``packages`` or
381 ``py_modules``. Alternatively you can also configure :ref:`custom-discovery`.
390 * #3068: Deprecated ``setuptools.config.read_configuration``,
391 ``setuptools.config.parse_configuration`` and other functions or classes
392 from ``setuptools.config``.
394 Users that still need to parse and process configuration from ``setup.cfg`` can
395 import a direct replacement from ``setuptools.config.setupcfg``, however this
396 module is transitional and might be removed in the future
397 (the ``setup.cfg`` configuration format itself is likely to be deprecated in the future).
401 * #2894: If you purposefully want to create an *"empty distribution"*, please be aware
402 that some Python files (or general folders) might be automatically detected and
405 Projects that currently don't specify both ``packages`` and ``py_modules`` in their
406 configuration and contain extra folders or Python files (not meant for distribution),
407 might see these files being included in the wheel archive or even experience
410 You can check details about the automatic discovery (and how to configure a
411 different behaviour) in :doc:`/userguide/package_discovery`.
412 * #3067: If the file ``pyproject.toml`` exists and it includes project
413 metadata/config (via ``[project]`` table or ``[tool.setuptools]``),
414 a series of new behaviors that are not backward compatible may take place:
416 - The default value of ``include_package_data`` will be considered to be ``True``.
417 - Setuptools will attempt to validate the ``pyproject.toml`` file according
418 to PEP 621 specification.
419 - The values specified in ``pyproject.toml`` will take precedence over those
420 specified in ``setup.cfg`` or ``setup.py``.
424 * #2887: **[EXPERIMENTAL]** Added automatic discovery for ``py_modules`` and ``packages``
425 -- by :user:`abravalheri`.
427 Setuptools will try to find these values assuming that the package uses either
428 the *src-layout* (a ``src`` directory containing all the packages or modules),
429 the *flat-layout* (package directories directly under the project root),
430 or the *single-module* approach (an isolated Python file, directly under
433 The automatic discovery will also respect layouts that are explicitly
434 configured using the ``package_dir`` option.
436 For backward-compatibility, this behavior will be observed **only if both**
437 ``py_modules`` **and** ``packages`` **are not set**.
438 (**Note**: specifying ``ext_modules`` might also prevent auto-discover from
441 If setuptools detects modules or packages that are not supposed to be in the
442 distribution, please manually set ``py_modules`` and ``packages`` in your
443 ``setup.cfg`` or ``setup.py`` file.
444 If you are using a *flat-layout*, you can also consider switching to
446 * #2887: **[EXPERIMENTAL]** Added automatic configuration for the ``name`` metadata
447 -- by :user:`abravalheri`.
449 Setuptools will adopt the name of the top-level package (or module in the case
450 of single-module distributions), **only when** ``name`` **is not explicitly
453 Please note that it is not possible to automatically derive a single name when
454 the distribution consists of multiple top-level packages or modules.
455 * #3066: Added vendored dependencies for :pypi:`tomli`, :pypi:`validate-pyproject`.
457 These dependencies are used to read ``pyproject.toml`` files and validate them.
458 * #3067: **[EXPERIMENTAL]** When using ``pyproject.toml`` metadata,
459 the default value of ``include_package_data`` is changed to ``True``.
460 * #3068: **[EXPERIMENTAL]** Add support for ``pyproject.toml`` configuration
461 (as introduced by :pep:`621`). Configuration parameters not covered by
462 standards are handled in the ``[tool.setuptools]`` sub-table.
464 In the future, existing ``setup.cfg`` configuration
465 may be automatically converted into the ``pyproject.toml`` equivalent before taking effect
466 (as proposed in #1688). Meanwhile users can use automated tools like
467 :pypi:`ini2toml` to help in the transition.
469 Please note that the legacy backend is not guaranteed to work with
470 ``pyproject.toml`` configuration.
472 -- by :user:`abravalheri`
473 * #3125: Implicit namespaces (as introduced in :pep:`420`) are now considered by default
474 during :doc:`package discovery </userguide/package_discovery>`, when
475 ``setuptools`` configuration and project metadata are added to the
476 ``pyproject.toml`` file.
478 To disable this behaviour, use ``namespaces = False`` when explicitly setting
479 the ``[tool.setuptools.packages.find]`` section in ``pyproject.toml``.
481 This change is backwards compatible and does not affect the behaviour of
482 configuration done in ``setup.cfg`` or ``setup.py``.
483 * #3152: **[EXPERIMENTAL]** Added support for ``attr:`` and ``cmdclass`` configurations
484 in ``setup.cfg`` and ``pyproject.toml`` when ``package_dir`` is implicitly
485 found via auto-discovery.
486 * #3178: Postponed importing ``ctypes`` when hiding files on Windows.
487 This helps to prevent errors in systems that might not have ``libffi`` installed.
488 * #3179: Merge with pypa/distutils@267dbd25ac
490 Documentation changes
491 ^^^^^^^^^^^^^^^^^^^^^
492 * #3172: Added initial documentation about configuring ``setuptools`` via ``pyproject.toml``
493 (using standard project metadata).
497 * #3065: Refactored ``setuptools.config`` by separating configuration parsing (specific
498 to the configuration file format, e.g. ``setup.cfg``) and post-processing
499 (which includes directives such as ``file:`` that can be used across different
500 configuration formats).
509 * #2971: Deprecated upload_docs command, to be removed in the future.
510 * #3137: Use samefile from stdlib, supported on Windows since Python 3.2.
511 * #3170: Adopt nspektr (vendored) to implement Distribution._install_dependencies.
513 Documentation changes
514 ^^^^^^^^^^^^^^^^^^^^^
515 * #3144: Added documentation on using console_scripts from setup.py, which was previously only shown in setup.cfg -- by :user:`xhlulu`
516 * #3148: Added clarifications about ``MANIFEST.in``, that include links to PyPUG docs
517 and more prominent mentions to using a revision control system plugin as an
519 * #3148: Removed mention to ``pkg_resources`` as the recommended way of accessing data
520 files, in favour of importlib.resources.
521 Additionally more emphasis was put on the fact that *package data files* reside
522 **inside** the *package directory* (and therefore should be *read-only*).
526 * #3120: Added workaround for intermittent failures of backend tests on PyPy.
527 These tests now are marked with `XFAIL
528 <https://docs.pytest.org/en/stable/how-to/skipping.html>`_, instead of erroring
530 * #3124: Improved configuration for :pypi:`rst-linker` (extension used to build the
532 * #3133: Enhanced isolation of tests using virtual environments - PYTHONPATH is not leaking to spawned subprocesses -- by :user:`befeleme`
533 * #3147: Added options to provide a pre-built ``setuptools`` wheel or sdist for being
534 used during tests with virtual environments.
535 Paths for these pre-built distribution files can now be set via the environment
536 variables: ``PRE_BUILT_SETUPTOOLS_SDIST`` and ``PRE_BUILT_SETUPTOOLS_WHEEL``.
545 * #3093: Repaired automated release process.
554 * #3035: When loading distutils from the vendored copy, rewrite ``__name__`` to ensure consistent importing from inside and out.
563 * #3102: Prevent vendored importlib_metadata from loading distributions from older importlib_metadata.
564 * #3103: Fixed issue where string-based entry points would be omitted.
565 * #3107: Bump importlib_metadata to 4.11.1 addressing issue with parsing requirements in egg-info as found in PyPy.
574 * #2876: In the build backend, allow single config settings to be supplied.
575 * #2993: Removed workaround in distutils hack for get-pip now that pypa/get-pip#137 is closed.
576 * #3085: Setuptools no longer relies on ``pkg_resources`` for entry point handling.
577 * #3098: Bump vendored packaging to 21.3.
578 * Removed bootstrap script.
580 .. warning:: Users trying to install the unmaintained :pypi:`pathlib` backport
581 from PyPI/``sdist``/source code may find problems when using ``setuptools >= 60.9.0``.
582 This happens because during the installation, the unmaintained
583 implementation of ``pathlib`` is loaded and may cause compatibility problems
584 (it does not expose the same public API defined in the Python standard library).
586 Whenever possible users should avoid declaring ``pathlib`` as a dependency.
587 An alternative is to pre-build a wheel for ``pathlib`` using a separated
588 virtual environment with an older version of setuptools and install the
589 library directly from the pre-built wheel.
598 * #3091: Make ``concurrent.futures`` import lazy in vendored ``more_itertools``
599 package to a avoid importing threading as a side effect (which caused
600 `gevent/gevent#1865 <https://github.com/gevent/gevent/issues/1865>`__).
601 -- by :user:`maciejp-ro`
610 * #3084: When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer.
619 * #3085: Setuptools now vendors importlib_resources and importlib_metadata and jaraco.text. Setuptools no longer relies on pkg_resources for ensure_directory nor parse_requirements.
628 * #3072: Remove lorem_ipsum from jaraco.text when vendored.
637 * #3061: Vendored jaraco.text and use line processing from that library in pkg_resources.
641 * #3070: Avoid AttributeError in easy_install.create_home_path when sysconfig.get_config_vars values are not strings.
650 * #3043: Merge with pypa/distutils@bb018f1ac3 including consolidated behavior in sysconfig.get_platform (pypa/distutils#104).
651 * #3057: Don't include optional ``Home-page`` in metadata if no ``url`` is specified. -- by :user:`cdce8p`
652 * #3062: Merge with pypa/distutils@b53a824ec3 including improved support for lib directories on non-x64 Windows builds.
654 Documentation changes
655 ^^^^^^^^^^^^^^^^^^^^^
656 * #2897: Added documentation about wrapping ``setuptools.build_meta`` in a in-tree
657 custom backend. This is a :pep:`517`-compliant way of dynamically specifying
658 build dependencies (e.g. when platform, OS and other markers are not enough).
659 -- by :user:`abravalheri`
660 * #3034: Replaced occurrences of the defunct distutils-sig mailing list with pointers
661 to GitHub Discussions.
662 -- by :user:`ashemedai`
663 * #3056: The documentation has stopped suggesting to add ``wheel`` to
664 :pep:`517` requirements -- by :user:`webknjaz`
668 * #3054: Used Py3 syntax ``super().__init__()`` -- by :user:`imba-tjd`
677 * #3009: Remove filtering of distutils warnings.
678 * #3031: Suppress distutils replacement when building or testing CPython.
687 * #3026: Honor sysconfig variables in easy_install.
696 * #2993: In _distutils_hack, for get-pip, simulate existence of setuptools.
705 * #2918: Correct support for Python 3 native loaders.
714 * #2990: Set the ``.origin`` attribute of the ``distutils`` module to the module's ``__file__``.
723 * #2839: Removed ``requires`` sorting when installing wheels as an egg dir.
724 * #2953: Fixed a bug that easy install incorrectly parsed Python 3.10 version string.
725 * #3006: Fixed startup performance issue of Python interpreter due to imports of
726 costly modules in ``_distutils_hack`` -- by :user:`tiran`
728 Documentation changes
729 ^^^^^^^^^^^^^^^^^^^^^
730 * #2674: Added link to additional resources on packaging in Quickstart guide
731 * #3008: "In-tree" Sphinx extension for "favicons" replaced with ``sphinx-favicon``.
732 * #3008: SVG images (logo, banners, ...) optimised with the help of the ``scour``
737 * #2862: Added integration tests that focus on building and installing some packages in
738 the Python ecosystem via ``pip`` -- by :user:`abravalheri`
739 * #2952: Modified "vendoring" logic to keep license files.
740 * #2968: Improved isolation for some tests that where inadvertently using the project
741 root for builds, and therefore creating directories (e.g. ``build``, ``dist``,
742 ``*.egg-info``) that could interfere with the outcome of other tests
743 -- by :user:`abravalheri`.
744 * #2968: Introduced new test fixtures ``venv``, ``venv_without_setuptools``,
745 ``bare_venv`` that rely on the ``jaraco.envs`` package.
746 These new test fixtures were also used to remove the (currently problematic)
747 dependency on the ``pytest_virtualenv`` plugin.
748 * #2968: Removed ``tmp_src`` test fixture. Previously this fixture was copying all the
749 files and folders under the project root, including the ``.git`` directory,
750 which is error prone and increases testing time.
752 Since ``tmp_src`` was used to populate virtual environments (installing the
753 version of ``setuptools`` under test via the source tree), it was replaced by
754 the new ``setuptools_sdist`` and ``setuptools_wheel`` fixtures (that are build
755 only once per session testing and can be shared between all the workers for
765 * #3002: Suppress AttributeError when detecting get-pip.
774 * #2993: In _distutils_hack, bypass the distutils exception for pip when get-pip is being invoked, because it imports setuptools.
778 * #2989: Merge with pypa/distutils@788cc159. Includes fix for config vars missing from sysconfig.
787 * #2974: Setuptools now relies on the Python logging infrastructure to log messages. Instead of using ``distutils.log.*``, use ``logging.getLogger(name).*``.
788 * #2987: Sync with pypa/distutils@2def21c5d74fdd2fe7996ee4030ac145a9d751bd, including fix for missing get_versions attribute (#2969), more reliance on sysconfig from stdlib.
792 * #2962: Avoid attempting to use local distutils when the presiding version of Setuptools on the path doesn't have one.
793 * #2983: Restore 'add_shim' as the way to invoke the hook. Avoids compatibility issues between different versions of Setuptools with the distutils local implementation.
802 * #2980: Bypass distutils loader when setuptools module is no longer available on sys.path.
811 * #2958: In distutils_hack, only add the metadata finder once. In ensure_local_distutils, rely on a context manager for reliable manipulation.
812 * #2963: Merge with pypa/distutils@a5af364910. Includes revisited fix for pypa/distutils#15 and improved MinGW/Cygwin support from pypa/distutils#77.
821 * #2960: Install schemes fall back to default scheme for headers.
830 * #2954: Merge with pypa/distutils@eba2bcd310. Adds platsubdir to config vars available for substitution.
839 * #2940: Avoid KeyError in distutils hack when pip is imported during ensurepip.
848 * #2938: Select 'posix_user' for the scheme unless falling back to stdlib, then use 'unix_user'.
857 * #2944: Add support for extended install schemes in easy_install.
866 * #2896: Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUTILS=stdlib.
875 * #2935: Merge pypa/distutils@460b59f0e68dba17e2465e8dd421bbc14b994d1f.
884 * #2930: Require Python 3.7
893 * #2925: Merge with pypa/distutils@92082ee42c including introduction of deprecation warning on Version classes.
902 * #2914: Merge with pypa/distutils@8f2df0bf6.
911 * #2893: Restore deprecated support for newlines in the Summary field.
920 * #2902: Merge with pypa/distutils@85db7a41242.
924 * #2906: In ensure_local_distutils, re-use DistutilsMetaFinder to load the module. Avoids race conditions when _distutils_system_mod is employed.
933 * #2875: Introduce changes from pypa/distutils@514e9d0, including support for overrides from Debian and pkgsrc, unlocking the possibility of making SETUPTOOLS_USE_DISTUTILS=local the default again.
942 * #2885: Fixed errors when encountering LegacyVersions.
951 * #2497: Update packaging to 21.2.
952 * #2877: Back out deprecation of setup_requires and replace instead by a deprecation of setuptools.installer and fetch_build_egg. Now setup_requires is still supported when installed as part of a PEP 517 build, but is deprecated when an unsatisfied requirement is encountered.
953 * #2879: Bump packaging to 21.2.
955 Documentation changes
956 ^^^^^^^^^^^^^^^^^^^^^
957 * #2867: PNG/ICO images replaced with SVG in the docs.
958 * #2867: Added support to SVG "favicons" via "in-tree" Sphinx extension.
967 * #2880: Removed URL requirement for ``pytest-virtualenv`` in ``setup.cfg``.
968 PyPI rejects packages with dependencies external to itself.
969 Instead the test dependency was overwritten via ``tox.ini``
978 * #2856: Support for custom commands that inherit directly from ``distutils`` is
979 **deprecated**. Users should extend classes provided by setuptools instead.
983 * #2870: Started failing on invalid inline description with line breaks :class:`ValueError` -- by :user:`webknjaz`
987 * #2698: Exposed exception classes from ``distutils.errors`` via ``setuptools.errors``.
988 * #2866: Incorporate changes from pypa/distutils@f1b0a2b.
990 Documentation changes
991 ^^^^^^^^^^^^^^^^^^^^^
992 * #2227: Added sphinx theme customisations to display the new logo in the sidebar and
993 use its colours as "accent" in the documentation -- by :user:`abravalheri`
994 * #2227: Added new setuptools logo, including editable files and artwork documentation
995 -- by :user:`abravalheri`
996 * #2698: Added mentions to ``setuptools.errors`` as a way of handling custom command
998 * #2698: Added instructions to migrate from ``distutils.commands`` and
999 ``distutils.errors`` in the porting guide.
1000 * #2871: Added a note to the docs that it is possible to install
1001 ``setup.py``-less projects in editable mode with :doc:`pip v21.1+
1002 <pip:index>`, only having ``setup.cfg`` and ``pyproject.toml`` in
1003 project root -- by :user:`webknjaz`
1012 * #2849: Add fallback for custom ``build_py`` commands inheriting directly from
1013 :mod:`distutils`, while still handling ``include_package_data=True`` for
1023 * #2847: Suppress 'setup.py install' warning under bdist_wheel.
1032 * #2846: Move PkgResourcesDeprecationWarning above implicitly-called function so that it's in the namespace when version warnings are generated in an environment that contains them.
1041 * #1461: Fix inconsistency with ``include_package_data`` and ``packages_data`` in sdist
1042 by replacing the loop breaking mechanism between the ``sdist`` and
1043 ``egg_info`` commands -- by :user:`abravalheri`
1052 * #2497: Officially deprecated PEP 440 non-compliant versions.
1054 Documentation changes
1055 ^^^^^^^^^^^^^^^^^^^^^
1056 * #2832: Removed the deprecated ``data_files`` option from the example in the
1057 declarative configuration docs -- by :user:`abravalheri`
1058 * #2832: Change type of ``data_files`` option from ``dict`` to ``section`` in
1059 declarative configuration docs (to match previous example) -- by
1063 .. _setup_install_deprecation_note:
1071 * #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. See `Why you shouldn't invoke setup.py directly <https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html>`_ for more background.
1072 * #1988: Deprecated the ``bdist_rpm`` command. Binary packages should be built as wheels instead.
1073 -- by :user:`hugovk`
1074 * #2785: Replace ``configparser``'s ``readfp`` with ``read_file``, deprecated since Python 3.2.
1075 -- by :user:`hugovk`
1076 * #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.
1080 * #2762: Changed codecov.yml to configure the threshold to be lower
1081 -- by :user:`tanvimoharir`
1090 * #2757: Add windows arm64 launchers for scripts generated by easy_install.
1091 * #2800: Added ``--owner`` and ``--group`` options to the ``sdist`` command,
1092 for specifying file ownership within the produced tarball (similarly
1093 to the corresponding distutils ``sdist`` options).
1095 Documentation changes
1096 ^^^^^^^^^^^^^^^^^^^^^
1097 * #2792: Document how the legacy and non-legacy versions are compared, and reference to the PEP 440 scheme.
1106 * #2796: Merge with pypa/distutils@02e9f65ab0
1115 * #2773: Retain case in setup.cfg during sdist.
1124 * #2777: Build does not fail fast when ``use_2to3`` is supplied but set to a false value.
1133 * #2769: Build now fails fast when ``use_2to3`` is supplied.
1142 * #2765: In Distribution.finalize_options, suppress known removed entry points to avoid issues with older Setuptools.
1151 * #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.
1153 Documentation changes
1154 ^^^^^^^^^^^^^^^^^^^^^
1155 * #2746: add python_requires example
1164 * #2712: Added implicit globbing support for ``[options.data_files]`` values.
1166 Documentation changes
1167 ^^^^^^^^^^^^^^^^^^^^^
1168 * #2737: fix various syntax and style errors in code snippets in docs
1177 * #2722: Added support for ``SETUPTOOLS_EXT_SUFFIX`` environment variable to override the suffix normally detected from the ``sysconfig`` module.
1186 * #2465: Documentation is now published using the Furo theme.
1195 * #2724: Added detection of Windows ARM64 build environments using the ``VSCMD_ARG_TGT_ARCH`` environment variable.
1204 * #2692: Globs are now sorted in 'license_files' restoring reproducibility by eliminating variance from disk order.
1205 * #2714: Update to distutils at pypa/distutils@e2627b7.
1206 * #2715: Removed reliance on deprecated ssl.match_hostname by removing the ssl support. Now any index operations rely on the native SSL implementation.
1208 Documentation changes
1209 ^^^^^^^^^^^^^^^^^^^^^
1210 * #2604: Revamped the backward/cross tool compatibility section to remove
1212 Add some examples and the version since when ``entry_points`` are
1213 supported in declarative configuration.
1214 Tried to make the reading flow a bit leaner, gather some information
1215 that were a bit dispersed.
1224 * #2645: License files excluded via the ``MANIFEST.in`` but matched by either
1225 the ``license_file`` (deprecated) or ``license_files`` options,
1226 will be nevertheless included in the source distribution. - by :user:`cdce8p`
1230 * #2628: Write long description in message payload of PKG-INFO file. - by :user:`cdce8p`
1231 * #2645: Added ``License-File`` (multiple) to the output package metadata.
1232 The field will contain the path of a license file, matched by the
1233 ``license_file`` (deprecated) and ``license_files`` options,
1234 relative to ``.dist-info``. - by :user:`cdce8p`
1235 * #2678: Moved Setuptools' own entry points into declarative config.
1236 * #2680: Vendored :pypi:`more_itertools` for Setuptools.
1237 * #2681: Setuptools own setup.py no longer declares setup_requires, but instead expects wheel to be installed as declared by pyproject.toml.
1241 * #2650: Updated the docs build tooling to support the latest version of
1242 Towncrier and show the previews of not-yet-released setuptools versions
1243 in the changelog -- :user:`webknjaz`
1252 * #2640: Fixed handling of multiline license strings. - by :user:`cdce8p`
1253 * #2641: Setuptools will now always try to use the latest supported
1254 metadata version for ``PKG-INFO``. - by :user:`cdce8p`
1263 * #2653: Incorporated assorted changes from pypa/distutils.
1264 * #2657: Adopted docs from distutils.
1265 * #2663: Added Visual Studio Express 2017 support -- by :user:`dofuuz`
1269 * #2644: Fixed ``DeprecationWarning`` due to ``threading.Thread.setDaemon`` in tests -- by :user:`tirkarthi`
1270 * #2654: Made the changelog generator compatible
1271 with Towncrier >= 19.9 -- :user:`webknjaz`
1272 * #2664: Relax the deprecation message in the distutils hack.
1281 * #2620: The ``license_file`` option is now marked as deprecated.
1282 Use ``license_files`` instead. -- by :user:`cdce8p`
1286 * #2620: If neither ``license_file`` nor ``license_files`` is specified, the ``sdist``
1287 option will now auto-include files that match the following patterns:
1288 ``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS*``.
1289 This matches the behavior of ``bdist_wheel``. -- by :user:`cdce8p`
1293 * #2620: The ``license_file`` and ``license_files`` options now support glob patterns. -- by :user:`cdce8p`
1294 * #2632: Implemented ``VendorImporter.find_spec()`` method to get rid
1295 of ``ImportWarning`` that Python 3.10 emits when only the old-style
1296 importer hooks are present -- by :user:`webknjaz`
1298 Documentation changes
1299 ^^^^^^^^^^^^^^^^^^^^^
1300 * #2620: Added documentation for the ``license_files`` option. -- by :user:`cdce8p`
1309 * #2566: Remove the deprecated ``bdist_wininst`` command. Binary packages should be built as wheels instead. -- by :user:`hroncok`
1318 * #2608: Added informative error message to PEP 517 build failures owing to
1319 an empty ``setup.py`` -- by :user:`layday`
1325 No significant changes.
1334 * #2595: Reduced scope of dash deprecation warning to Setuptools/distutils only -- by :user:`melissa-kun-li`
1341 Documentation changes
1342 ^^^^^^^^^^^^^^^^^^^^^
1343 * #2584: Added ``sphinx-inline-tabs`` extension to allow for comparison of ``setup.py`` and its equivalent ``setup.cfg`` -- by :user:`amy-lei`
1347 * #2592: Made option keys in the ``[metadata]`` section of ``setup.cfg`` case-sensitive. Users having
1348 uppercase option spellings will get a warning suggesting to make them to lowercase
1349 -- by :user:`melissa-kun-li`
1358 * #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`
1367 * #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.
1371 * #1932: Handled :code:`AttributeError` by raising :code:`DistutilsSetupError` in :code:`dist.check_specifier()` when specifier is not a string -- by :user:`melissa-kun-li`
1372 * #2570: Correctly parse cmdclass in setup.cfg.
1374 Documentation changes
1375 ^^^^^^^^^^^^^^^^^^^^^
1376 * #2553: Added userguide example for markers in extras_require -- by :user:`pwoolvett`
1385 * #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`
1386 * #2573: Fixed error in uploading a Sphinx doc with the :code:`upload_docs` command. An html builder will be used.
1387 Note: :code:`upload_docs` is deprecated for PyPi, but is supported for other sites -- by :user:`melissa-kun-li`
1396 * #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.
1405 * #2537: Remove fallback support for fetch_build_eggs using easy_install. Now pip is required for setup_requires to succeed.
1406 * #2544: Removed 'easy_install' top-level model (runpy entry point) and 'easy_install' console script.
1407 * #2545: Removed support for eggsecutables.
1411 * #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``.
1420 * #2539: Fix AttributeError in Description validation.
1429 * #1390: Validation of Description field now is more lenient, emitting a warning and mangling the value to be valid (replacing newlines with spaces).
1438 * #2536: Reverted tag deduplication handling.
1447 * #1390: Newlines in metadata description/Summary now trigger a ValueError.
1448 * #2481: Define ``create_module()`` and ``exec_module()`` methods in ``VendorImporter``
1449 to get rid of ``ImportWarning`` -- by :user:`hroncok`
1450 * #2489: ``pkg_resources`` behavior for zipimport now matches the regular behavior, and finds
1451 ``.egg-info`` (previously would only find ``.dist-info``) -- by :user:`thatch`
1452 * #2529: Fixed an issue where version tags may be added multiple times
1461 * #2493: Use importlib.import_module() rather than the deprecated loader.load_module()
1462 in pkg_resources namespace declaration -- by :user:`encukou`
1464 Documentation changes
1465 ^^^^^^^^^^^^^^^^^^^^^
1466 * #2525: Fix typo in the document page about entry point. -- by :user:`jtr109`
1470 * #2534: Avoid hitting network during test_easy_install.
1479 * #2505: Disable inclusion of package data as it causes 'tests' to be included as data.
1488 * #2534: Avoid hitting network during test_virtualenv.test_test_command.
1497 * #2486: Project adopts jaraco/skeleton for shared package maintenance.
1501 * #2477: Restore inclusion of rst files in sdist.
1502 * #2484: Setuptools has replaced the master branch with the main branch.
1503 * #2485: Fixed failing test when pip 20.3+ is present.
1504 -- by :user:`yan12125`
1505 * #2487: Fix tests with pytest 6.2
1506 -- by :user:`yan12125`
1515 * #2435: Require Python 3.6 or later.
1517 Documentation changes
1518 ^^^^^^^^^^^^^^^^^^^^^
1519 * #2430: Fixed inconsistent RST title nesting levels caused by #2399
1520 -- by :user:`webknjaz`
1521 * #2430: Fixed a typo in Sphinx docs that made docs dev section disappear
1522 as a result of PR #2426 -- by :user:`webknjaz`
1526 * #2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils.
1534 Documentation changes
1535 ^^^^^^^^^^^^^^^^^^^^^
1536 * #2394: Extended towncrier news template to include change note categories.
1537 This allows to see what types of changes a given version introduces
1538 -- by :user:`webknjaz`
1539 * #2427: Started enforcing strict syntax and reference validation
1540 in the Sphinx docs -- by :user:`webknjaz`
1541 * #2428: Removed redundant Sphinx ``Makefile`` support -- by :user:`webknjaz`
1545 * #2401: Enabled test results reporting in AppVeyor CI
1546 -- by :user:`webknjaz`
1547 * #2420: Replace Python 3.9.0 beta with 3.9.0 final on GitHub Actions.
1548 * #2421: Python 3.9 Trove classifier got added to the dist metadata
1549 -- by :user:`webknjaz`
1557 Documentation changes
1558 ^^^^^^^^^^^^^^^^^^^^^
1559 * #2093: Finalized doc revamp.
1560 * #2097: doc: simplify index and group deprecated files
1561 * #2102: doc overhaul step 2: break main doc into multiple sections
1562 * #2111: doc overhaul step 3: update userguide
1563 * #2395: Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`
1564 * #2395: Added an illustrative explanation about the change notes to fragments dir -- by :user:`webknjaz`
1568 * #2379: Travis CI test suite now tests against PPC64.
1569 * #2413: Suppress EOF errors (and other exceptions) when importing lib2to3.
1579 * #2368: In distutils, restore support for monkeypatched CCompiler.spawn per pypa/distutils#15.
1589 * #2355: When pip is imported as part of a build, leave distutils patched.
1590 * #2380: There are some setuptools specific changes in the
1591 ``setuptools.command.bdist_rpm`` module that are no longer needed, because
1592 they are part of the ``bdist_rpm`` module in distutils in Python
1593 3.5.0. Therefore, code was removed from ``setuptools.command.bdist_rpm``.
1603 * #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.
1613 * #2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils#9).
1623 * #2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876.
1633 * #2357: Restored Python 3.5 support in distutils.util for missing ``subprocess._optim_args_from_interpreter_flags``.
1634 * #2358: Restored AIX support on Python 3.8 and earlier.
1635 * #2361: Add Python 3.10 support to _distutils_hack. Get the 'Loader' abstract class
1636 from importlib.abc rather than importlib.util.abc (alias removed in Python
1647 * #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.
1651 * #2334: In MSVC module, refine text in error message.
1661 * #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.
1671 * #2306: When running as a PEP 517 backend, setuptools does not try to install
1672 ``setup_requires`` itself. They are reported as build requirements for the
1673 frontend to install.
1683 * #2310: Updated vendored packaging version to 20.4.
1691 Documentation changes
1692 ^^^^^^^^^^^^^^^^^^^^^
1693 * #2300: Improve the ``safe_version`` function documentation
1697 * #2297: Once again, in stubs prefer exec_module to the deprecated load_module.
1707 * #2316: Removed warning when ``distutils`` is imported before ``setuptools`` when ``distutils`` replacement is not enabled.
1717 * #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.
1727 * #2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn.
1737 * #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.
1747 * #2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state.
1748 * #2249: Fix extension loading technique in stubs.
1758 * #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.
1768 * #2094: Removed pkg_resources.py2_warn module, which is no longer reachable.
1778 * #2228: Applied fix for pypa/distutils#3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file.
1788 * #2228: Disabled distutils adoption for now while emergent issues are addressed.
1798 * #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.
1802 * #2137: Removed (private) pkg_resources.RequirementParseError, now replaced by packaging.requirements.InvalidRequirement. Kept the name for compatibility, but users should catch InvalidRequirement instead.
1803 * #2180: Update vendored packaging in pkg_resources to 19.2.
1807 * #2199: Fix exception causes all over the codebase by using ``raise new_exception from old_exception``
1817 * #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.
1818 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)``.
1828 * #2071: Replaced references to the deprecated imp package with references to importlib
1838 * #1973: Removed ``pkg_resources.py31compat.makedirs`` in favor of the stdlib. Use ``os.makedirs()`` instead.
1839 * #2198: Restore ``__requires__`` directive in easy-install wrapper scripts.
1849 * #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.
1853 * #2195: Fix broken entry points generated by easy-install (pip editable installs).
1863 * #2194: Editable-installed entry points now load significantly faster on Python versions 3.8+.
1864 * #1471: Incidentally fixed by #2194 on Python 3.8 or when importlib_metadata is present.
1872 Documentation changes
1873 ^^^^^^^^^^^^^^^^^^^^^
1874 * #2156: Update mailing list pointer in developer docs
1876 Incorporate changes from v44.1.1:
1877 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1879 * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.
1889 * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.
1899 * #2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages.
1909 * #2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should use ``setuptools<45``.
1913 * #1700: Document all supported keywords by migrating the ones from distutils.
1923 * #1753: ``attr:`` now extracts variables through rudimentary examination of the AST,
1924 thereby supporting modules with third-party imports. If examining the AST
1925 fails to find the variable, ``attr:`` falls back to the old behavior of
1926 importing the module. Works on Python 3 only.
1932 No significant changes.
1942 * #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.
1946 * #2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards.
1947 * #2105: Filter ``2to3`` deprecation warnings from ``TestDevelop.test_2to3_user_mode``.
1957 * #2040: Deprecated the ``bdist_wininst`` command. Binary packages should be built as wheels instead.
1958 * #2062: Change 'Mac OS X' to 'macOS' in code.
1959 * #2075: Stop recognizing files ending with ``.dist-info`` as distribution metadata.
1960 * #2086: Deprecate 'use_2to3' functionality. Packagers are encouraged to use single-source solutions or build tool chains to manage conversions outside of setuptools.
1962 Documentation changes
1963 ^^^^^^^^^^^^^^^^^^^^^
1964 * #1698: Added documentation for ``build_meta`` (a bare minimum, not completed).
1968 * #2082: Filter ``lib2to3`` ``PendingDeprecationWarning`` and ``DeprecationWarning`` in tests,
1969 because ``lib2to3`` is `deprecated in Python 3.9 <https://bugs.python.org/issue40360>`_.
1975 No significant changes.
1985 * #1458: Added template for reporting Python 2 incompatibilities.
1991 No significant changes.
2001 * #308: Allow version number normalization to be bypassed by wrapping in a 'setuptools.sic()' call.
2002 * #1424: Prevent keeping files mode for package_data build. It may break a build if user's package data has read only flag.
2003 * #1431: In ``easy_install.check_site_dir``, ensure the installation directory exists.
2004 * #1563: In ``pkg_resources`` prefer ``find_spec`` (PEP 451) to ``find_module``.
2006 Incorporate changes from v44.1.0:
2007 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2009 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
2010 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
2011 * #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.
2021 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
2022 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
2023 * #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.
2033 * #65: Once again as in 3.0, removed the Features feature.
2037 * #1890: Fix vendored dependencies so importing ``setuptools.extern.some_module`` gives the same object as ``setuptools._vendor.some_module``. This makes Metadata picklable again.
2038 * #1899: Test suite now fails on warnings.
2040 Documentation changes
2041 ^^^^^^^^^^^^^^^^^^^^^
2042 * #2011: Fix broken link to distutils docs on package_data
2046 * #1991: Include pkg_resources test data in sdist, so tests can be executed from it.
2056 * #1557: Deprecated eggsecutable scripts and updated docs.
2057 * #1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+
2067 * #1905: Fixed defect in _imp, introduced in 41.6.0 when the 'tests' directory is not present.
2068 * #1941: Improve editable installs with PEP 518 build isolation:
2070 * The ``--user`` option is now always available. A warning is issued if the user site directory is not available.
2071 * The error shown when the install directory is not in ``PYTHONPATH`` has been turned into a warning.
2072 * #1981: Setuptools now declares its ``tests`` and ``docs`` dependencies in metadata (extras).
2073 * #1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9).
2077 * #1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info.
2087 * #1458: Add minimum sunset date and preamble to Python 2 warning.
2088 * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
2089 * #1974: Add Python 3 Only Trove Classifier and remove universal wheel declaration for more complete transition from Python 2.
2099 * #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.
2103 * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
2113 * #1908: Drop support for Python 3.4.
2123 * #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.
2127 * #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.
2136 * #1921: Fix support for easy_install's ``find-links`` option in ``setup.cfg``.
2137 * #1922: Build dependencies (setup_requires and tests_require) now install transitive dependencies indicated by extras.
2147 * #1918: Fix regression in handling wheels compatibility tags.
2157 * #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:
2158 * support for ``python_requires``
2159 * better support for wheels (proper handling of priority with respect to PEP 425 tags)
2160 * PEP 517/518 support
2161 * eggs are not supported
2162 * no support for the ``allow_hosts`` easy_install option (``index_url``/``find_links`` are still honored)
2163 * pip environment variables are honored (and take precedence over easy_install options)
2164 * #1898: Removed the "upload" and "register" commands in favor of :pypi:`twine`.
2168 * #1767: Add support for the ``license_files`` option in ``setup.cfg`` to automatically
2169 include multiple license files in a source distribution.
2170 * #1829: Update handling of wheels compatibility tags:
2171 * add support for manylinux2010
2172 * fix use of removed 'm' ABI flag in Python 3.8 on Windows
2173 * #1861: Fix empty namespace package installation from wheel.
2174 * #1877: Setuptools now exposes a new entry point hook "setuptools.finalize_distribution_options", enabling plugins like :pypi:`setuptools_scm` to configure options on the distribution at finalization time.
2184 * #479: Replace usage of deprecated ``imp`` module with local re-implementation in ``setuptools._imp``.
2194 * #1891: Fix code for detecting Visual Studio's version on Windows under Python 2.
2204 * #1811: Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019.
2205 * #1814: Fix ``pkg_resources.Requirement`` hash/equality implementation: take PEP 508 direct URL into account.
2206 * #1824: Fix tests when running under ``python3.10``.
2207 * #1878: Formally deprecated the ``test`` command, with the recommendation that users migrate to ``tox``.
2209 Documentation changes
2210 ^^^^^^^^^^^^^^^^^^^^^
2211 * #1860: Update documentation to mention the egg format is not supported by pip and dependency links support was dropped starting with pip 19.0.
2212 * #1862: Drop ez_setup documentation: deprecated for some time (last updated in 2016), and still relying on easy_install (deprecated too).
2213 * #1868: Drop most documentation references to (deprecated) EasyInstall.
2214 * #1884: Added a trove classifier to document support for Python 3.8.
2218 * #1886: Added Python 3.8 release to the Travis test matrix.
2228 * #1847: In declarative config, now traps errors when invalid ``python_requires`` values are supplied.
2238 * #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+.
2242 * #1858: Fixed failing integration test triggered by 'long_description_content_type' in packaging.
2252 * #479: Remove some usage of the deprecated ``imp`` module.
2256 * #1565: Changed html_sidebars from string to list of string as per
2257 https://www.sphinx-doc.org/en/master/changes.html#id58
2267 * #1697: Moved most of the constants from setup.py to setup.cfg
2268 * #1749: Fixed issue with the PEP 517 backend where building a source distribution would fail if any tarball existed in the destination directory.
2269 * #1750: Fixed an issue with PEP 517 backend where wheel builds would fail if the destination directory did not already exist.
2270 * #1756: Force metadata-version >= 1.2. when project urls are present.
2271 * #1769: Improve ``package_data`` check: ensure the dictionary values are lists/tuples of strings.
2272 * #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.
2273 * #1790: Added the file path to the error message when a ``UnicodeDecodeError`` occurs while reading a metadata file.
2275 Documentation changes
2276 ^^^^^^^^^^^^^^^^^^^^^
2277 * #1776: Use license classifiers rather than the license field.
2287 * #1671: Fixed issue with the PEP 517 backend that prevented building a wheel when the ``dist/`` directory contained existing ``.whl`` files.
2288 * #1709: In test.paths_on_python_path, avoid adding unnecessary duplicates to the PYTHONPATH.
2289 * #1741: In package_index, now honor "current directory" during a checkout of git and hg repositories under Windows
2299 * #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.
2309 * #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.
2310 * #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.
2311 * #1664: Added the path to the ``PKG-INFO`` or ``METADATA`` file in the exception
2312 text when the ``Version:`` header can't be found.
2314 Documentation changes
2315 ^^^^^^^^^^^^^^^^^^^^^
2316 * #1705: Removed some placeholder documentation sections referring to deprecated features.
2326 * #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``.
2327 * #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.
2328 * #1536: ``setuptools`` will now automatically include licenses if ``setup.cfg`` contains a ``license_file`` attribute, unless this file is manually excluded inside ``MANIFEST.in``.
2338 * #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.
2348 * #1666: Restore port in URL handling in package_index.
2358 * #1660: On Python 2, when reading config files, downcast options from text to bytes to satisfy distutils expectations.
2368 * #1551: File inputs for the ``license`` field in ``setup.cfg`` files now explicitly raise an error.
2372 * #1180: Add support for non-ASCII in setup.cfg (#1062). Add support for native strings on some parameters (#1136).
2373 * #1499: ``setuptools.package_index`` no longer relies on the deprecated ``urllib.parse.splituser`` per Python #27485.
2374 * #1544: Added tests for PackageIndex.download (for git URLs).
2375 * #1625: In PEP 517 build_meta builder, ensure that sdists are built as gztar per the spec.
2385 * #1594: PEP 517 backend no longer declares setuptools as a dependency as it can be assumed.
2395 * #1592: Fix invalid dependency on external six module (instead of vendored version).
2405 * #1590: Fixed regression where packages without ``author`` or ``author_email`` fields generated malformed package metadata.
2415 * #1541: Officially deprecated the ``requires`` parameter in ``setup()``.
2419 * #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.
2420 * #1545: Changed the warning class of all deprecation warnings; deprecation warning classes are no longer derived from ``DeprecationWarning`` and are thus visible by default.
2421 * #1554: ``build_meta.build_sdist`` now includes ``setup.py`` in source distributions by default.
2422 * #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.
2424 Documentation changes
2425 ^^^^^^^^^^^^^^^^^^^^^
2426 * #1395: Changed Pyrex references to Cython in the documentation.
2427 * #1456: Documented that the ``rpmbuild`` packages is required for the ``bdist_rpm`` command.
2428 * #1537: Documented how to use ``setup.cfg`` for ``src/ layouts``
2429 * #1539: Added minimum version column in ``setup.cfg`` metadata table.
2430 * #1552: Fixed a minor typo in the python 2/3 compatibility documentation.
2431 * #1553: Updated installation instructions to point to ``pip install`` instead of ``ez_setup.py``.
2432 * #1560: Updated ``setuptools`` distribution documentation to remove some outdated information.
2433 * #1564: Documented ``setup.cfg`` minimum version for version and project_urls.
2437 * #1533: Restricted the ``recursive-include setuptools/_vendor`` to contain only .py and .txt files.
2438 * #1572: Added the ``concurrent.futures`` backport ``futures`` to the Python 2.7 test suite requirements.
2448 * #1335: In ``pkg_resources.normalize_path``, fix issue on Cygwin when cwd contains symlinks.
2449 * #1502: Deprecated support for downloads from Subversion in package_index/easy_install.
2450 * #1517: Dropped use of six.u in favor of ``u""`` literals.
2451 * #1520: Added support for ``data_files`` in ``setup.cfg``.
2453 Documentation changes
2454 ^^^^^^^^^^^^^^^^^^^^^
2455 * #1525: Fixed rendering of the deprecation warning in easy_install doc.
2465 * #1480: Bump vendored pyparsing in pkg_resources to 2.2.1.
2475 * #1497: Updated gitignore in repo.
2485 * #1480: Bump vendored pyparsing to 2.2.1.
2495 * #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).
2505 * #1402: Fixed a bug with namespace packages under Python 3.6 when one package in
2506 current directory hides another which is installed.
2507 * #1427: Set timestamp of ``.egg-info`` directory whenever ``egg_info`` command is run.
2508 * #1474: ``build_meta.get_requires_for_build_sdist`` now does not include the ``wheel`` package anymore.
2509 * #1486: Suppress warnings in pkg_resources.handle_ns.
2513 * #1479: Remove internal use of six.binary_type.
2523 * #1466: Fix handling of Unicode arguments in PEP 517 backend
2533 * #1465: Fix regression with ``egg_info`` command when tagging is used.
2543 * #1410: Deprecated ``upload`` and ``register`` commands.
2544 * #1312: Introduced find_namespace_packages() to find PEP 420 namespace packages.
2545 * #1420: Added find_namespace: directive to config parser.
2546 * #1418: Solved race in when creating egg cache directories.
2547 * #1450: Upgraded vendored PyParsing from 2.1.10 to 2.2.0.
2548 * #1451: Upgraded vendored appdirs from 1.4.0 to 1.4.3.
2549 * #1388: Fixed "Microsoft Visual C++ Build Tools" link in exception when Visual C++ not found.
2550 * #1389: Added support for scripts which have unicode content.
2551 * #1416: Moved several Python version checks over to using ``six.PY2`` and ``six.PY3``.
2555 * #1441: Removed spurious executable permissions from files that don't need them.
2565 * #1342: Drop support for Python 3.3.
2569 * #1366: In package_index, fixed handling of encoded entities in URLs.
2570 * #1383: In pkg_resources VendorImporter, avoid removing packages imported from the root.
2572 Documentation changes
2573 ^^^^^^^^^^^^^^^^^^^^^
2574 * #1379: Minor doc fixes after actually using the new release process.
2575 * #1385: Removed section on non-package data files.
2576 * #1403: Fix developer's guide.
2580 * #1404: Fix PEP 518 configuration: set build requirements in ``pyproject.toml`` to ``["wheel"]``.
2590 * #1359: Support using "file:" to load a PEP 440-compliant package version from
2592 * #1360: Fixed issue with a mismatch between the name of the package and the
2593 name of the .dist-info file in wheel files
2594 * #1364: Add ``__dir__()`` implementation to ``pkg_resources.Distribution()`` that
2595 includes the attributes in the ``_provider`` instance variable.
2596 * #1365: Take the package_dir option into account when loading the version from
2599 Documentation changes
2600 ^^^^^^^^^^^^^^^^^^^^^
2601 * #1353: Added coverage badge to README.
2602 * #1356: Made small fixes to the developer guide documentation.
2603 * #1357: Fixed warnings in documentation builds and started enforcing that the
2604 docs build without warnings in tox.
2605 * #1376: Updated release process docs.
2609 * #1343: The ``setuptools`` specific ``long_description_content_type``,
2610 ``project_urls`` and ``provides_extras`` fields are now set consistently
2611 after any ``distutils`` ``setup_keywords`` calls, allowing them to override
2613 * #1352: Added ``tox`` environment for documentation builds.
2614 * #1354: Added ``towncrier`` for changelog management.
2615 * #1355: Add PR template.
2616 * #1368: Fixed tests which failed without network connectivity.
2617 * #1369: Added unit tests for PEP 425 compatibility tags support.
2618 * #1372: Stop testing Python 3.3 in Travis CI, now that the latest version of
2619 ``wheel`` no longer installs on it.
2624 * #1340: Update all PyPI URLs to reflect the switch to the
2625 new Warehouse codebase.
2626 * #1337: In ``pkg_resources``, now support loading resources
2627 for modules loaded by the ``SourcelessFileLoader``.
2628 * #1332: Silence spurious wheel related warnings on Windows.
2633 * #1297: Restore Unicode handling for Maintainer fields in
2639 * #1296: Setuptools now vendors its own direct dependencies, no
2640 longer relying on the dependencies as vendored by pkg_resources.
2642 * #296: Removed long-deprecated support for iteration on
2643 Version objects as returned by ``pkg_resources.parse_version``.
2644 Removed the ``SetuptoolsVersion`` and
2645 ``SetuptoolsLegacyVersion`` names as well. They should not
2646 have been used, but if they were, replace with
2647 ``Version`` and ``LegacyVersion`` from ``packaging.version``.
2652 * #1288: Add support for maintainer in PKG-INFO.
2657 * #1292: Avoid generating ``Provides-Extra`` in metadata when
2658 no extra is present (but environment markers are).
2663 * #1286: Add support for Metadata 2.1 (PEP 566).
2668 * #1285: Fixed RuntimeError in pkg_resources.parse_requirements
2669 on Python 3.7 (stemming from PEP 479).
2674 * #1271: Revert to Cython legacy ``build_ext`` behavior for
2680 * #1229: Expand imports in ``build_ext`` to refine detection of
2681 Cython availability.
2683 * #1270: When Cython is available, ``build_ext`` now uses the
2689 * #1257: In bdist_egg.scan_module, fix ValueError on Python 3.7.
2694 * #1231: Removed warning when PYTHONDONTWRITEBYTECODE is enabled.
2699 * #1210: Add support for PEP 345 Project-URL metadata.
2700 * #1207: Add support for ``long_description_type`` to setup.cfg
2701 declarative config as intended and documented.
2706 * #1232: Fix trailing slash handling in ``pkg_resources.ZipProvider``.
2711 * #1220: Fix ``data_files`` handling when installing from wheel.
2716 * fix Travis' Python 3.3 job.
2721 * #1214: fix handling of namespace packages when installing
2727 * #1212: fix encoding handling of metadata when installing
2733 * #1200: easy_install now support installing from wheels:
2734 they will be installed as standalone unzipped eggs.
2739 * #1208: Improve error message when failing to locate scripts
2740 in egg-info metadata.
2745 * #458: In order to support deterministic builds, Setuptools no
2746 longer allows packages to declare ``install_requires`` as
2747 unordered sequences (sets or dicts).
2752 * #878: Drop support for Python 2.6. Python 2.6 users should
2753 rely on 'setuptools < 37dev'.
2758 * #1190: In SSL support for package index operations, use SNI
2764 * #1175: Bug fixes to ``build_meta`` module.
2769 * #701: Fixed duplicate test discovery on Python 3.
2774 * #1193: Avoid test failures in bdist_egg when
2775 PYTHONDONTWRITEBYTECODE is set.
2780 * #1054: Support ``setup_requires`` in ``setup.cfg`` files.
2785 * #1132: Removed redundant and costly serialization/parsing step
2786 in ``EntryPoint.__init__``.
2788 * #844: ``bdist_egg --exclude-source-files`` now tested and works
2794 * #1143: Added ``setuptools.build_meta`` module, an implementation
2795 of PEP-517 for Setuptools-defined packages.
2797 * #1143: Added ``dist_info`` command for producing dist_info
2803 * #170: When working with Mercurial checkouts, use Windows-friendly
2804 syntax for suppressing output.
2806 * Inspired by #1134, performed substantial refactoring of
2807 ``pkg_resources.find_on_path`` to facilitate an optimization
2808 for paths with many non-version entries.
2813 * #1075: Add new ``Description-Content-Type`` metadata field. `See here for
2814 documentation on how to use this field.
2815 <https://packaging.python.org/specifications/#description-content-type>`_
2817 * #1068: Sort files and directories when building eggs for
2818 deterministic order.
2820 * #196: Remove caching of easy_install command in fetch_build_egg.
2821 Fixes issue where ``pytest-runner-N.N`` would satisfy the installation
2824 * #1129: Fix working set dependencies handling when replacing conflicting
2825 distributions (e.g. when using ``setup_requires`` with a conflicting
2826 transitive dependency, fix #1124).
2828 * #1133: Improved handling of README files extensions and added
2829 Markdown to the list of searched READMES.
2831 * #1135: Improve performance of pkg_resources import by not invoking
2832 ``access`` or ``stat`` and using ``os.listdir`` instead.
2837 * #1131: Make possible using several files within ``file:`` directive
2838 in metadata.long_description in ``setup.cfg``.
2843 * fix #1105: Fix handling of requirements with environment
2844 markers when declared in ``setup.cfg`` (same treatment as
2850 * #462: Don't assume a directory is an egg by the ``.egg``
2856 * #1093: Fix test command handler with extras_require.
2857 * #1112, #1091, #1115: Now using Trusty containers in
2858 Travis for CI and CD.
2863 * #1092: ``pkg_resources`` now uses ``inspect.getmro`` to
2864 resolve classes in method resolution order.
2869 * #1102: Restore behavior for empty extras.
2874 * #1099: Revert commit a3ec721, restoring intended purpose of
2875 extras as part of a requirement declaration.
2882 * support extras specifiers in install_requires requirements
2887 * #1081: Environment markers indicated in ``install_requires``
2888 are now processed and treated as nameless ``extras_require``
2889 with markers, allowing their metadata in requires.txt to be
2890 correctly generated.
2892 * #1053: Tagged commits are now released using Travis-CI
2893 build stages, meaning releases depend on passing tests on
2894 all supported Python versions (Linux) and not just the latest
2900 * #1083: Correct ``py31compat.makedirs`` to correctly honor
2901 ``exist_ok`` parameter.
2902 * #1083: Also use makedirs compatibility throughout setuptools.
2907 * #1083: Avoid race condition on directory creation in
2908 ``pkg_resources.ensure_directory``.
2910 * Removed deprecation of and restored support for
2911 ``upload_docs`` command for sites other than PyPI.
2912 Only warehouse is dropping support, but services like
2913 `devpi <http://doc.devpi.net/latest/>`_ continue to
2914 support docs built by setuptools' plugins. See
2915 `this comment <https://bitbucket.org/hpk42/devpi/issues/388/support-rtd-model-for-building-uploading#comment-34292423>`_
2916 for more context on the motivation for this change.
2921 * #1042: Fix import in py27compat module that still
2922 referenced six directly, rather than through the externs
2923 module (vendored packages hook).
2928 * #980 and others: Once again, Setuptools vendors all
2929 of its dependencies. It seems to be the case that in
2930 the Python ecosystem, all build tools must run without
2931 any dependencies (build, runtime, or otherwise). At
2932 such a point that a mechanism exists that allows
2933 build tools to have dependencies, Setuptools will adopt
2939 * #1015: Fix test failures on Python 3.7.
2941 * #1024: Add workaround for Jython #2581 in monkey module.
2946 * #992: Revert change introduced in v34.4.1, now
2949 * #1016: Revert change introduced in v35.0.0 per #1014,
2950 referencing #436. The approach had unintended
2951 consequences, causing sdist installs to be missing
2957 * #436: In egg_info.manifest_maker, no longer read
2958 the file list from the manifest file, and instead
2959 re-build it on each build. In this way, files removed
2960 from the specification will not linger in the manifest.
2961 As a result, any files manually added to the manifest
2962 will be removed on subsequent egg_info invocations.
2963 No projects should be manually adding files to the
2964 manifest and should instead use MANIFEST.in or SCM
2965 file finders to force inclusion of files in the manifest.
2970 * #1008: In MSVC support, use always the last version available for Windows SDK and UCRT SDK.
2972 * #1008: In MSVC support, fix "vcruntime140.dll" returned path with Visual Studio 2017.
2974 * #992: In msvc.msvc9_query_vcvarsall, ensure the
2975 returned dicts have str values and not Unicode for
2976 compatibility with os.environ.
2981 * #995: In MSVC support, add support for "Microsoft Visual Studio 2017" and "Microsoft Visual Studio Build Tools 2017".
2983 * #999 via #1007: Extend support for declarative package
2984 config in a setup.cfg file to include the options
2985 ``python_requires`` and ``py_modules``.
2990 * #967 (and #997): Explicitly import submodules of
2991 packaging to account for environments where the imports
2992 of those submodules is not implied by other behavior.
2997 * #993: Fix documentation upload by correcting
2998 rendering of content-type in _build_multipart
3004 * #988: Trap ``os.unlink`` same as ``os.remove`` in
3005 ``auto_chmod`` error handler.
3007 * #983: Fixes to invalid escape sequence deprecations on
3013 * #941: In the upload command, if the username is blank,
3014 default to ``getpass.getuser()``.
3016 * #971: Correct distutils findall monkeypatch to match
3017 appropriate versions (namely Python 3.4.6).
3022 * #966: Add support for reading dist-info metadata and
3023 thus locating Distributions from zip files.
3025 * #968: Allow '+' and '!' in egg fragments
3026 so that it can take package names that contain
3027 PEP 440 conforming version specifiers.
3032 * #953: More aggressively employ the compatibility issue
3033 originally added in #706.
3038 * #930: ``build_info`` now accepts two new parameters
3039 to optimize and customize the building of C libraries.
3044 * #947: Loosen restriction on the version of six required,
3045 restoring compatibility with environments relying on
3046 six 1.6.0 and later.
3051 * #882: Ensure extras are honored when building the
3053 * #913: Fix issue in develop if package directory has
3059 * #935: Fix glob syntax in graft.
3064 * #581: Instead of vendoring the growing list of
3065 dependencies that Setuptools requires to function,
3066 Setuptools now requires these dependencies just like
3067 any other project. Unlike other projects, however,
3068 Setuptools cannot rely on ``setup_requires`` to
3069 demand the dependencies it needs to install because
3070 its own machinery would be necessary to pull those
3071 dependencies if not present (a bootstrapping problem).
3072 As a result, Setuptools no longer supports self upgrade or
3073 installation in the general case. Instead, users are
3074 directed to use pip to install and upgrade using the
3075 ``wheel`` distributions of setuptools.
3077 Users are welcome to contrive other means to install
3078 or upgrade Setuptools using other means, such as
3079 pre-installing the Setuptools dependencies with pip
3080 or a bespoke bootstrap tool, but such usage is not
3081 recommended and is not supported.
3083 As discovered in #940, not all versions of pip will
3084 successfully install Setuptools from its pre-built
3085 wheel. If you encounter issues with "No module named
3086 six" or "No module named packaging", especially
3087 following a line "Running setup.py egg_info for package
3088 setuptools", then your pip is not new enough.
3090 There's an additional issue in pip where setuptools
3091 is upgraded concurrently with other source packages,
3092 described in pip #4253. The proposed workaround is to
3093 always upgrade Setuptools first prior to upgrading
3094 other packages that would upgrade Setuptools.
3099 * #921: Correct issue where certifi fallback not being
3105 Installation via pip, as indicated in the `Python Packaging
3106 User's Guide <https://packaging.python.org/installing/>`_,
3107 is the officially-supported mechanism for installing
3108 Setuptools, and this recommendation is now explicit in the
3109 much more concise README.
3111 Other edits and tweaks were made to the documentation. The
3112 codebase is unchanged.
3117 * #619: Removed support for the ``tag_svn_revision``
3118 distribution option. If Subversion tagging support is
3119 still desired, consider adding the functionality to
3120 setuptools_svn in setuptools_svn #2.
3125 * #866: Use ``dis.Bytecode`` on Python 3.4 and later in
3126 ``setuptools.depends``.
3131 * #889: Backport proposed fix for disabling interpolation in
3132 distutils.Distribution.parse_config_files.
3137 * #884: Restore support for running the tests under
3138 `pytest-runner <https://github.com/pytest-dev/pytest-runner>`_
3139 by ensuring that PYTHONPATH is honored in tests invoking
3145 * #706: Add rmtree compatibility shim for environments where
3146 rmtree fails when passed a unicode string.
3151 * #893: Only release sdist in zip format as warehouse now
3152 disallows releasing two different formats.
3157 * #704: More selectively ensure that 'rmtree' is not invoked with
3158 a byte string, enabling it to remove files that are non-ascii,
3161 * #712: In 'sandbox.run_setup', ensure that ``__file__`` is
3162 always a ``str``, modeling the behavior observed by the
3163 interpreter when invoking scripts and modules.
3168 * #891: In 'test' command on test failure, raise DistutilsError,
3169 suppression invocation of subsequent commands.
3174 * #890: Revert #849. ``global-exclude .foo`` will not match all
3175 ``*.foo`` files any more. Package authors must add an explicit
3176 wildcard, such as ``global-exclude *.foo``, to match all
3177 ``.foo`` files. See #886, #849.
3182 * #885: Fix regression where 'pkg_resources._rebuild_mod_path'
3183 would fail when a namespace package's '__path__' was not
3184 a list with a sort attribute.
3189 * #250: Install '-nspkg.pth' files for packages installed
3190 with 'setup.py develop'. These .pth files allow
3191 namespace packages installed by pip or develop to
3192 co-mingle. This change required the removal of the
3193 change for #805 and pip #1924, introduced in 28.3.0 and implicated
3194 in #870, but means that namespace packages not in a
3195 site packages directory will no longer work on Python
3196 earlier than 3.5, whereas before they would work on
3197 Python not earlier than 3.3.
3202 * #879: For declarative config:
3204 - 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.
3206 - packages find: directive now supports fine tuning from a subsection. The same arguments as for find() are accepted.
3211 * #394 via #862: Added support for `declarative package
3212 config in a setup.cfg file
3213 <https://setuptools.pypa.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files>`_.
3218 * #850: In test command, invoke unittest.main with
3219 indication not to exit the process.
3224 * #854: Bump to vendored Packaging 16.8.
3229 * #846: Also trap 'socket.error' when opening URLs in
3232 * #849: Manifest processing now matches the filename
3233 pattern anywhere in the filename and not just at the
3234 start. Restores behavior found prior to 28.5.0.
3239 * #864: Drop support for Python 3.2. Systems requiring
3240 Python 3.2 support must use 'setuptools < 30'.
3242 * #825: Suppress warnings for single files.
3244 * #830 via #843: Once again restored inclusion of data
3245 files to sdists, but now trap TypeError caused by
3246 techniques employed rjsmin and similar.
3251 * #861: Re-release of v29.0.1 with the executable script
3252 launchers bundled. Now, launchers are included by default
3253 and users that want to disable this behavior must set the
3254 environment variable
3255 'SETUPTOOLS_INSTALL_WINDOWS_SPECIFIC_FILES' to
3256 a false value like "false" or "0".
3261 * #841: Drop special exception for packages invoking
3262 win32com during the build/install process. See
3263 Distribute #118 for history.
3268 * #629: Per the discussion, refine the sorting to use version
3269 value order for more accurate detection of the latest
3270 available version when scanning for packages. See also
3273 * #837: Rely on the config var "SO" for Python 3.3.0 only
3274 when determining the ext filename.
3279 * #827: Update PyPI root for dependency links.
3281 * #833: Backed out changes from #830 as the implementation
3282 seems to have problems in some cases.
3287 * #832: Moved much of the namespace package handling
3288 functionality into a separate module for re-use in something
3290 * #830: ``sdist`` command no longer suppresses the inclusion
3291 of data files, re-aligning with the expectation of distutils
3292 and addressing #274 and #521.
3297 * #816: Fix manifest file list order in tests.
3302 * #629: When scanning for packages, ``pkg_resources`` now
3303 ignores empty egg-info directories and gives precedence to
3304 packages whose versions are lexicographically greatest,
3305 a rough approximation for preferring the latest available
3311 * #810: Tests are now invoked with tox and not setup.py test.
3312 * #249 and #450 via #764: Avoid scanning the whole tree
3313 when building the manifest. Also fixes a long-standing bug
3314 where patterns in ``MANIFEST.in`` had implicit wildcard
3315 matching. This caused ``global-exclude .foo`` to exclude
3316 all ``*.foo`` files, but also ``global-exclude bar.py`` to
3317 exclude ``foo_bar.py``.
3322 * #732: Now extras with a hyphen are honored per PEP 426.
3323 * #811: Update to pyparsing 2.1.10.
3324 * Updated ``setuptools.command.sdist`` to re-use most of
3325 the functionality directly from ``distutils.command.sdist``
3326 for the ``add_defaults`` method with strategic overrides.
3327 See #750 for rationale.
3328 * #760 via #762: Look for certificate bundle where SUSE
3329 Linux typically presents it. Use ``certifi.where()`` to locate
3335 * #809: In ``find_packages()``, restore support for excluding
3336 a parent package without excluding a child package.
3338 * #805: Disable ``-nspkg.pth`` behavior on Python 3.3+ where
3339 PEP-420 functionality is adequate. Fixes pip #1924.
3344 * #803: Bump certifi to 2016.9.26.
3349 * #733: Do not search excluded directories for packages.
3350 This introduced a backwards incompatible change in ``find_packages()``
3351 so that ``find_packages(exclude=['foo']) == []``, excluding subpackages of ``foo``.
3352 Previously, ``find_packages(exclude=['foo']) == ['foo.bar']``,
3353 even though the parent ``foo`` package was excluded.
3355 * #795: Bump certifi.
3357 * #719: Suppress decoding errors and instead log a warning
3358 when metadata cannot be decoded.
3363 * #790: In MSVC monkeypatching, explicitly patch each
3364 function by name in the target module instead of inferring
3365 the module from the function's ``__module__``. Improves
3366 compatibility with other packages that might have previously
3367 patched distutils functions (i.e. NumPy).
3372 * #794: In test command, add installed eggs to PYTHONPATH
3373 when invoking tests so that subprocesses will also have the
3374 dependencies available. Fixes `tox 330
3375 <https://github.com/tox-dev/tox/issues/330>`_.
3377 * #795: Update vendored pyparsing 2.1.9.
3382 * #520 and #513: Suppress ValueErrors in fixup_namespace_packages
3385 * Nicer, more consistent interfaces for msvc monkeypatching.
3390 * #779 via #781: Fix circular import.
3395 * #778: Fix MSVC monkeypatching.
3400 * Introduce the (private) ``monkey`` module to encapsulate
3401 the distutils monkeypatching behavior.
3406 * Now use Warehouse by default for
3407 ``upload``, patching ``distutils.config.PyPIRCCommand`` to
3408 affect default behavior.
3410 Any config in .pypirc should be updated to replace
3412 https://pypi.python.org/pypi/
3416 https://upload.pypi.org/legacy/
3418 Similarly, any passwords stored in the keyring should be
3419 updated to use this new value for "system".
3421 The ``upload_docs`` command will continue to use the python.org
3422 site, but the command is now deprecated. Users are urged to use
3423 Read The Docs instead.
3425 * #776: Use EXT_SUFFIX for py_limited_api renaming.
3427 * #774 and #775: Use LegacyVersion from packaging when
3428 detecting numpy versions.
3433 * Re-release of 26.1.0 with pytest pinned to allow for automated
3434 deployment and thus proper packaging environment variables,
3435 fixing issues with missing executable launchers.
3440 * #763: ``pkg_resources.get_default_cache`` now defers to the
3441 :pypi:`appdirs` project to
3442 resolve the cache directory. Adds a vendored dependency on
3443 appdirs to pkg_resources.
3448 * #748: By default, sdists are now produced in gzipped tarfile
3449 format by default on all platforms, adding forward compatibility
3450 for the same behavior in Python 3.6 (See Python #27819).
3452 * #459 via #736: On Windows with script launchers,
3453 sys.argv[0] now reflects
3454 the name of the entry point, consistent with the behavior in
3455 distlib and pip wrappers.
3457 * #752 via #753: When indicating ``py_limited_api`` to Extension,
3458 it must be passed as a keyword argument.
3463 * Add Extension(py_limited_api=True). When set to a truthy value,
3464 that extension gets a filename appropriate for code using Py_LIMITED_API.
3465 When used correctly this allows a single compiled extension to work on
3466 all future versions of CPython 3.
3467 The py_limited_api argument only controls the filename. To be
3468 compatible with multiple versions of Python 3, the C extension
3469 will also need to set -DPy_LIMITED_API=... and be modified to use
3470 only the functions in the limited API.
3475 * #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).
3477 * #731: Bump certifi.
3479 * Style updates. See #740, #741, #743, #744, #742, #747.
3481 * #735: include license file.
3486 * #612 via #730: Add a LICENSE file which needs to be provided by the terms of
3492 * #725: revert ``library_dir_option`` patch (Error is related to ``numpy.distutils`` and make errors on non Numpy users).
3498 * #723: Improve patch for ``library_dir_option``.
3505 * #707: Fix Python 2 compatibility for MSVC by catching errors properly.
3506 * #715: Fix unquoted libpaths by patching ``library_dir_option``.
3511 * #714 and #704: Revert fix as it breaks other components
3512 downstream that can't handle unicode. See #709, #710,
3518 * #704: Fix errors when installing a zip sdist that contained
3519 files named with non-ascii characters on Windows would
3520 crash the install when it attempted to clean up the build.
3521 * #646: MSVC compatibility - catch errors properly in
3522 RegistryInfo.lookup.
3523 * #702: Prevent UnboundLocalError when initial working_set
3529 * #686: Fix issue in sys.path ordering by pkg_resources when
3530 rewrite technique is "raw".
3531 * #699: Fix typo in msvc support.
3536 * #609: Setuptools will now try to download a distribution from
3537 the next possible download location if the first download fails.
3538 This means you can now specify multiple links as ``dependency_links``
3539 and all links will be tried until a working download link is encountered.
3544 * #688: Fix AttributeError in setup.py when invoked not from
3545 the current directory.
3550 * Cleanup of setup.py script.
3552 * Fixed documentation builders by allowing setup.py
3553 to be imported without having bootstrapped the
3556 * More style cleanup. See #677, #678, #679, #681, #685.
3561 * #674: Default ``sys.path`` manipulation by easy-install.pth
3562 is now "raw", meaning that when writing easy-install.pth
3563 during any install operation, the ``sys.path`` will not be
3564 rewritten and will no longer give preference to easy_installed
3567 To retain the old behavior when using any easy_install
3568 operation (including ``setup.py install`` when setuptools is
3569 present), set the environment variable:
3571 SETUPTOOLS_SYS_PATH_TECHNIQUE=rewrite
3573 This project hopes that that few if any environments find it
3574 necessary to retain the old behavior, and intends to drop
3575 support for it altogether in a future release. Please report
3576 any relevant concerns in the ticket for this change.
3581 * #398: Fix shebang handling on Windows in script
3582 headers where spaces in ``sys.executable`` would
3583 produce an improperly-formatted shebang header,
3584 introduced in 12.0 with the fix for #188.
3586 * #663, #670: More style updates.
3591 * #516: Disable ``os.link`` to avoid hard linking
3592 in ``sdist.make_distribution``, avoiding errors on
3593 systems that support hard links but not on the
3594 file system in which the build is occurring.
3599 * #667: Update Metadata-Version to 1.2 when
3600 ``python_requires`` is supplied.
3605 * #631: Add support for ``python_requires`` keyword.
3610 * More style updates. See #660, #661, #641.
3615 * #659: ``setup.py`` now will fail fast and with a helpful
3616 error message when the necessary metadata is missing.
3617 * More style updates. See #656, #635, #640,
3618 #644, #650, #652, and #655.
3623 * Updated style in much of the codebase to match
3624 community expectations. See #632, #633, #634,
3625 #637, #639, #638, #642, #648.
3630 * If MSVC++14 is needed ``setuptools.msvc`` now redirect
3631 user to Visual C++ Build Tools web page.
3636 * #625 and #626: Fixes on ``setuptools.msvc`` mainly
3637 for Python 2 and Linux.
3642 * Pull Request #174: Add more aggressive support for
3643 standalone Microsoft Visual C++ compilers in
3644 msvc9compiler patch.
3645 Particularly : Windows SDK 6.1 and 7.0
3646 (MSVC++ 9.0), Windows SDK 7.1 (MSVC++ 10.0),
3647 Visual C++ Build Tools 2015 (MSVC++14)
3648 * Renamed ``setuptools.msvc9_support`` to
3649 ``setuptools.msvc``.
3654 Re-release of v23.2.0, which was missing the intended
3657 * #623: Remove used of deprecated 'U' flag when reading
3663 * #619: Deprecated ``tag_svn_revision`` distribution
3669 * #611: Removed ARM executables for CLI and GUI script
3670 launchers on Windows. If this was a feature you cared
3671 about, please comment in the ticket.
3672 * #604: Removed docs building support. The project
3673 now relies on documentation hosted at
3674 https://setuptools.pypa.io/.
3679 * #604: Restore repository for upload_docs command
3680 to restore publishing of docs during release.
3685 * #589: Upload releases to pypi.io using the upload
3686 hostname and legacy path.
3691 * #589: Releases are now uploaded to pypi.io (Warehouse)
3692 even when releases are made on Twine via Travis.
3697 * #589: Releases are now uploaded to pypi.io (Warehouse).
3702 * #190: On Python 2, if unicode is passed for packages to
3703 ``build_py`` command, it will be handled just as with
3709 Intended to be v21.3.0, but jaraco accidentally released as
3712 * #598: Setuptools now lists itself first in the User-Agent
3713 for web requests, better following the guidelines in
3715 <https://tools.ietf.org/html/rfc7231#section-5.5.3>`_.
3720 * Minor fixes to changelog and docs.
3725 * #261: Exclude directories when resolving globs in
3731 * #539: In the easy_install get_site_dirs, honor all
3732 paths found in ``site.getsitepackages``.
3737 * #572: In build_ext, now always import ``_CONFIG_VARS``
3738 from ``distutils`` rather than from ``sysconfig``
3739 to allow ``distutils.sysconfig.customize_compiler``
3740 configure the OS X compiler for ``-dynamiclib``.
3745 * Removed ez_setup.py from Setuptools sdist. The
3746 bootstrap script will be maintained in its own
3747 branch and should be generally be retrieved from
3748 its canonical location at
3749 https://bootstrap.pypa.io/ez_setup.py.
3754 * #553: egg_info section is now generated in a
3755 deterministic order, matching the order generated
3756 by earlier versions of Python. Except on Python 2.6,
3757 order is preserved when existing settings are present.
3758 * #556: Update to Packaging 16.7, restoring support
3759 for deprecated ``python_implmentation`` marker.
3760 * #555: Upload command now prompts for a password
3761 when uploading to PyPI (or other repository) if no
3762 password is present in .pypirc or in the keyring.
3767 * #548: Update certify version to 2016.2.28
3768 * #545: Safely handle deletion of non-zip eggs in rotate
3774 * Issue #544: Fix issue with extra environment marker
3775 processing in WorkingSet due to refactor in v20.7.0.
3780 * Issue #543: Re-release so that latest release doesn't
3781 cause déjà vu with distribute and setuptools 0.7 in
3787 * Refactored extra environment marker processing
3789 * Issue #533: Fixed intermittent test failures.
3790 * Issue #536: In msvc9_support, trap additional exceptions
3791 that might occur when importing
3792 ``distutils.msvc9compiler`` in mingw environments.
3793 * Issue #537: Provide better context when package
3794 metadata fails to decode in UTF-8.
3799 * Issue #523: Restored support for environment markers,
3800 now honoring 'extra' environment markers.
3805 * Issue #523: Disabled support for environment markers
3806 introduced in v20.5.
3811 * Issue #503: Restore support for PEP 345 environment
3812 markers by updating to Packaging 16.6.
3817 * New release process that relies on
3818 `bumpversion <https://github.com/peritus/bumpversion>`_
3819 and Travis CI for continuous deployment.
3820 * Project versioning semantics now follow
3821 `semver <https://semver.org>`_ precisely.
3822 The 'v' prefix on version numbers now also allows
3823 version numbers to be referenced in the changelog,
3824 e.g. http://setuptools.pypa.io/en/latest/history.html#v20-6-0.
3829 * BB Pull Request #185, #470: Add support for environment markers
3830 in requirements in install_requires, setup_requires,
3831 tests_require as well as adding a test for the existing
3832 extra_requires machinery.
3837 * Issue #422: Moved hosting to
3838 `Github <https://github.com/pypa/setuptools>`_
3839 from `Bitbucket <https://bitbucket.org/pypa/setuptools>`_.
3840 Issues have been migrated, though all issues and comments
3841 are attributed to bb-migration. So if you have a particular
3842 issue or issues to which you've been subscribed, you will
3843 want to "watch" the equivalent issue in Github.
3844 The Bitbucket project will be retained for the indefinite
3845 future, but Github now hosts the canonical project repository.
3850 * Issue #519: Remove import hook when reloading the
3851 ``pkg_resources`` module.
3852 * BB Pull Request #184: Update documentation in ``pkg_resources``
3853 around new ``Requirement`` implementation.
3858 * BB Pull Request #179: ``pkg_resources.Requirement`` objects are
3859 now a subclass of ``packaging.requirements.Requirement``,
3860 allowing any environment markers and url (if any) to be
3861 affiliated with the requirement
3862 * BB Pull Request #179: Restore use of RequirementParseError
3863 exception unintentionally dropped in 20.2.
3868 * Issue #502: Correct regression in parsing of multiple
3869 version specifiers separated by commas and spaces.
3874 * Issue #499: Restore compatibility for legacy versions
3875 by bumping to packaging 16.4.
3880 * Changelog now includes release dates and links to PEPs.
3881 * BB Pull Request #173: Replace dual PEP 345 _markerlib implementation
3882 and PEP 426 implementation of environment marker support from
3883 packaging 16.1 and PEP 508. Fixes Issue #122.
3884 See also BB Pull Request #175, BB Pull Request #168, and
3885 BB Pull Request #164. Additionally:
3887 - ``Requirement.parse`` no longer retains the order of extras.
3888 - ``parse_requirements`` now requires that all versions be
3889 PEP-440 compliant, as revealed in #499. Packages released
3890 with invalid local versions should be re-released using
3891 the proper local version syntax, e.g. ``mypkg-1.0+myorg.1``.
3896 * Update ``upload_docs`` command to also honor keyring
3897 for password resolution.
3902 * Added support for using passwords from keyring in the upload
3903 command. See `the upload docs
3904 <https://setuptools.pypa.io/en/latest/setuptools.html#upload-upload-source-and-or-egg-distributions-to-pypi>`_
3910 * Issue #118: Once again omit the package metadata (egg-info)
3911 from the list of outputs in ``--record``. This version of setuptools
3912 can no longer be used to upgrade pip earlier than 6.0.
3917 * Off-project PR: `0dcee79 <https://github.com/pypa/setuptools/commit/0dcee791dfdcfacddaaec79b29f30a347a147413>`_ and `f9bd9b9 <https://github.com/pypa/setuptools/commit/f9bd9b9f5df54ef5a0bf8d16c3a889ab8c640580>`_
3918 For FreeBSD, also `honor root certificates from ca_root_nss <https://github.com/pypa/setuptools/commit/3ae46c30225eb46e1f5aada1a19e88b79f04dc72>`_.
3923 * Issue #491: Correct regression incurred in 19.4 where
3924 a double-namespace package installed using pip would
3930 * Restore compatibility for PyPy 3 compatibility lost in
3931 19.4.1 addressing Issue #487.
3932 * ``setuptools.launch`` shim now loads scripts in a new
3933 namespace, avoiding getting relative imports from
3934 the setuptools package on Python 2.
3939 * Added a new entry script ``setuptools.launch``,
3940 implementing the shim found in
3941 ``pip.util.setuptools_build``. Use this command to launch
3942 distutils-only packages under setuptools in the same way that
3943 pip does, causing the setuptools monkeypatching of distutils
3944 to be invoked prior to invoking a script. Useful for debugging
3945 or otherwise installing a distutils-only package under
3946 setuptools when pip isn't available or otherwise does not
3947 expose the desired functionality. For example::
3949 $ python -m setuptools.launch setup.py develop
3951 * Issue #488: Fix dual manifestation of Extension class in
3952 extension packages installed as dependencies when Cython
3958 * Issue #486: Correct TypeError when getfilesystemencoding
3960 * Issue #139: Clarified the license as MIT.
3961 * BB Pull Request #169: Removed special handling of command
3962 spec in scripts for Jython.
3967 * Issue #487: Use direct invocation of ``importlib.machinery``
3968 in ``pkg_resources`` to avoid missing detection on relevant
3974 * Issue #341: Correct error in path handling of package data
3975 files in ``build_py`` command when package is empty.
3976 * Distribute #323, Issue #141, Issue #207, and
3977 BB Pull Request #167: Another implementation of
3978 ``pkg_resources.WorkingSet`` and ``pkg_resources.Distribution``
3979 that supports replacing an extant package with a new one,
3980 allowing for setup_requires dependencies to supersede installed
3981 packages for the session.
3986 * Issue #229: Implement new technique for readily incorporating
3987 dependencies conditionally from vendored copies or primary
3988 locations. Adds a new dependency on six.
3993 * BB Pull Request #163: Add get_command_list method to Distribution.
3994 * BB Pull Request #162: Add missing whitespace to multiline string
4000 * Issue #476: Cast version to string (using default encoding)
4001 to avoid creating Unicode types on Python 2 clients.
4002 * Issue #477: In Powershell downloader, use explicit rendering
4003 of strings, rather than rely on ``repr``, which can be
4004 incorrect (especially on Python 2).
4009 * Issue #215: The bootstrap script ``ez_setup.py`` now
4010 automatically detects
4011 the latest version of setuptools (using PyPI JSON API) rather
4012 than hard-coding a particular value.
4013 * Issue #475: Fix incorrect usage in _translate_metadata2.
4018 * Issue #442: Use RawConfigParser for parsing .pypirc file.
4019 Interpolated values are no longer honored in .pypirc files.
4024 * Issue #440: Prevent infinite recursion when a SandboxViolation
4025 or other UnpickleableException occurs in a sandbox context
4026 with setuptools hidden. Fixes regression introduced in Setuptools
4032 * Deprecated ``egg_info.get_pkg_info_revision``.
4033 * Issue #471: Don't rely on repr for an HTML attribute value in
4035 * Issue #419: Avoid errors in FileMetadata when the metadata directory
4037 * Issue #472: Remove deprecated use of 'U' in mode parameter
4043 * Issue #469: Refactored logic for Issue #419 fix to re-use metadata
4044 loading from Provider.
4049 * Update dependency on certify.
4050 * BB Pull Request #160: Improve detection of gui script in
4051 ``easy_install._adjust_header``.
4052 * Made ``test.test_args`` a non-data property; alternate fix
4053 for the issue reported in BB Pull Request #155.
4054 * Issue #453: In ``ez_setup`` bootstrap module, unload all
4055 ``pkg_resources`` modules following download.
4056 * BB Pull Request #158: Honor PEP-488 when excluding
4057 files for namespace packages.
4058 * Issue #419 and BB Pull Request #144: Add experimental support for
4059 reading the version info from distutils-installed metadata rather
4060 than using the version in the filename.
4065 * Issue #464: Correct regression in invocation of superclass on old-style
4071 * Issue #439: When installing entry_point scripts under development,
4072 omit the version number of the package, allowing any version of the
4078 * In preparation for dropping support for Python 3.2, a warning is
4079 now logged when pkg_resources is imported on Python 3.2 or earlier
4081 * `Add support for python_platform_implementation environment marker
4082 <https://github.com/pypa/setuptools/commit/94416707fd59a65f4a8f7f70541d6b3fc018b626>`_.
4083 * `Fix dictionary mutation during iteration
4084 <https://github.com/pypa/setuptools/commit/57ebfa41e0f96b97e599ecd931b7ae8a143e096e>`_.
4089 * Issue #446: Test command now always invokes unittest, even
4090 if no test suite is supplied.
4095 * Correct another regression in setuptools.findall
4096 where the fix for Python #12885 was lost.
4101 * Issue #425: Correct regression in setuptools.findall.
4106 * BB Pull Request #135: Setuptools now allows disabling of
4107 the manipulation of the sys.path
4108 during the processing of the easy-install.pth file. To do so, set
4109 the environment variable ``SETUPTOOLS_SYS_PATH_TECHNIQUE`` to
4110 anything but "rewrite" (consider "raw"). During any install operation
4111 with manipulation disabled, setuptools packages will be appended to
4114 Future versions may change the default behavior to disable
4115 manipulation. If so, the default behavior can be retained by setting
4116 the variable to "rewrite".
4118 * Issue #257: ``easy_install --version`` now shows more detail
4119 about the installation location and Python version.
4121 * Refactor setuptools.findall in preparation for re-submission
4127 * Issue #412: More efficient directory search in ``find_packages``.
4132 * Upgrade to vendored packaging 15.3.
4137 * Issue #401: Fix failure in test suite.
4142 * Dropped support for builds with Pyrex. Only Cython is supported.
4143 * Issue #288: Detect Cython later in the build process, after
4144 ``setup_requires`` dependencies are resolved.
4145 Projects backed by Cython can now be readily built
4146 with a ``setup_requires`` dependency. For example::
4148 ext = setuptools.Extension('mylib', ['src/CythonStuff.pyx', 'src/CStuff.c'])
4152 setup_requires=['cython'],
4155 For compatibility with older versions of setuptools, packagers should
4156 still include ``src/CythonMod.c`` in the source distributions or
4157 require that Cython be present before building source distributions.
4158 However, for systems with this build of setuptools, Cython will be
4159 downloaded on demand.
4160 * Issue #396: Fixed test failure on OS X.
4161 * BB Pull Request #136: Remove excessive quoting from shebang headers
4167 * Backed out unintended changes to pkg_resources, restoring removal of
4168 deprecated imp module (`ref
4169 <https://bitbucket.org/pypa/setuptools/commits/f572ec9563d647fa8d4ffc534f2af8070ea07a8b#comment-1881283>`_).
4174 * Issue #380: Add support for range operators on environment
4180 * Issue #378: Do not use internal importlib._bootstrap module.
4181 * Issue #390: Disallow console scripts with path separators in
4182 the name. Removes unintended functionality and brings behavior
4183 into parity with pip.
4188 * BB Pull Request #130: Better error messages for errors in
4189 parsed requirements.
4190 * BB Pull Request #133: Removed ``setuptools.tests`` from the
4192 * BB Pull Request #129: Address deprecation warning due to usage
4198 * Issue #373: Provisionally expose
4199 ``pkg_resources._initialize_master_working_set``, allowing for
4200 imperative re-initialization of the master working set.
4205 * Updated to Packaging 15.1 to address Packaging #28.
4206 * Fix ``setuptools.sandbox._execfile()`` with Python 3.1.
4211 * BB Pull Request #126: DistributionNotFound message now lists the package or
4212 packages that required it. E.g.::
4214 pkg_resources.DistributionNotFound: The 'colorama>=0.3.1' distribution was not found and is required by smlib.log.
4216 Note that zc.buildout once dependended on the string rendering of this
4217 message to determine the package that was not found. This expectation
4218 has since been changed, but older versions of buildout may experience
4219 problems. See Buildout #242 for details.
4224 * Issue #307: Removed PEP-440 warning during parsing of versions
4225 in ``pkg_resources.Distribution``.
4226 * Issue #364: Replace deprecated usage with recommended usage of
4227 ``EntryPoint.load``.
4232 * Issue #254: When creating temporary egg cache on Unix, use mode 755
4233 for creating the directory to avoid the subsequent warning if
4234 the directory is group writable.
4239 * Issue #137: Update ``Distribution.hashcmp`` so that Distributions with
4240 None for pyversion or platform can be compared against Distributions
4241 defining those attributes.
4246 * Issue #360: Removed undesirable behavior from test runs, preventing
4247 write tests and installation to system site packages.
4252 * BB Pull Request #125: Add ``__ne__`` to Requirement class.
4253 * Various refactoring of easy_install.
4258 * Bootstrap script now accepts ``--to-dir`` to customize save directory or
4259 allow for re-use of existing repository of setuptools versions. See
4260 BB Pull Request #112 for background.
4261 * Issue #285: ``easy_install`` no longer will default to installing
4262 packages to the "user site packages" directory if it is itself installed
4263 there. Instead, the user must pass ``--user`` in all cases to install
4264 packages to the user site packages.
4265 This behavior now matches that of "pip install". To configure
4266 an environment to always install to the user site packages, consider
4267 using the "install-dir" and "scripts-dir" parameters to easy_install
4268 through an appropriate distutils config file.
4273 * Issue #359: Include pytest.ini in the sdist so invocation of py.test on the
4274 sdist honors the pytest configuration.
4279 Re-release of 13.0. Intermittent connectivity issues caused the release
4280 process to fail and PyPI uploads no longer accept files for 13.0.
4285 * Issue #356: Back out BB Pull Request #119 as it requires Setuptools 10 or later
4286 as the source during an upgrade.
4287 * Removed build_py class from setup.py. According to 892f439d216e, this
4288 functionality was added to support upgrades from old Distribute versions,
4294 * BB Pull Request #119: Restore writing of ``setup_requires`` to metadata
4295 (previously added in 8.4 and removed in 9.0).
4300 * Documentation is now linked using the rst.linker package.
4301 * Fix ``setuptools.command.easy_install.extract_wininst_cfg()``
4302 with Python 2.6 and 2.7.
4303 * Issue #354. Added documentation on building setuptools
4309 * Issue #345: Unload all modules under pkg_resources during
4310 ``ez_setup.use_setuptools()``.
4311 * Issue #336: Removed deprecation from ``ez_setup.use_setuptools``,
4312 as it is clearly still used by buildout's bootstrap. ``ez_setup``
4313 remains deprecated for use by individual packages.
4314 * Simplified implementation of ``ez_setup.use_setuptools``.
4319 * BB Pull Request #118: Soften warning for non-normalized versions in
4325 * Issue #339: Correct Attribute reference in ``cant_write_to_target``.
4326 * Issue #336: Deprecated ``ez_setup.use_setuptools``.
4331 * Issue #335: Fix script header generation on Windows.
4336 * Fixed incorrect class attribute in ``install_scripts``. Tests would be nice.
4341 * Issue #331: Fixed ``install_scripts`` command on Windows systems corrupting
4347 * Restore ``setuptools.command.easy_install.sys_executable`` for pbr
4348 compatibility. For the future, tools should construct a CommandSpec
4354 * Issue #188: Setuptools now support multiple entities in the value for
4355 ``build.executable``, such that an executable of "/usr/bin/env my-python" may
4356 be specified. This means that systems with a specified executable whose name
4357 has spaces in the path must be updated to escape or quote that value.
4358 * Deprecated ``easy_install.ScriptWriter.get_writer``, replaced by ``.best()``
4359 with slightly different semantics (no force_windows flag).
4364 * Issue #327: Formalize and restore support for any printable character in an
4370 * Expose ``EntryPoint.resolve`` in place of EntryPoint._load, implementing the
4371 simple, non-requiring load. Deprecated all uses of ``EntryPoint._load``
4372 except for calling with no parameters, which is just a shortcut for
4373 ``ep.require(); ep.resolve();``.
4375 Apps currently invoking ``ep.load(require=False)`` should instead do the
4376 following if wanting to avoid the deprecating warning::
4378 getattr(ep, "resolve", lambda: ep.load(require=False))()
4383 * Pip #2326: Report deprecation warning at stacklevel 2 for easier diagnosis.
4388 * Issue #281: Since Setuptools 6.1 (Issue #268), a ValueError would be raised
4389 in certain cases where VersionConflict was raised with two arguments, which
4390 occurred in ``pkg_resources.WorkingSet.find``. This release adds support
4391 for indicating the dependent packages while maintaining support for
4392 a VersionConflict when no dependent package context is known. New unit tests
4393 now capture the expected interface.
4398 * Interop #3: Upgrade to Packaging 15.0; updates to PEP 440 so that >1.7 does
4399 not exclude 1.7.1 but does exclude 1.7.0 and 1.7.0.post1.
4404 * Issue #323: Fix regression in entry point name parsing.
4409 * Deprecated use of EntryPoint.load(require=False). Passing a boolean to a
4410 function to select behavior is an anti-pattern. Instead use
4411 ``Entrypoint._load()``.
4412 * Substantial refactoring of all unit tests. Tests are now much leaner and
4413 re-use a lot of fixtures and contexts for better clarity of purpose.
4418 * Issue #320: Added a compatibility implementation of
4419 ``sdist._default_revctrl``
4420 so that systems relying on that interface do not fail (namely, Ubuntu 12.04
4421 and similar Debian releases).
4426 * Issue #319: Fixed issue installing pure distutils packages.
4431 * Issue #313: Removed built-in support for subversion. Projects wishing to
4432 retain support for subversion will need to use a third party library. The
4433 extant implementation is being ported to :pypi:`setuptools_svn`.
4434 * Issue #315: Updated setuptools to hide its own loaded modules during
4435 installation of another package. This change will enable setuptools to
4436 upgrade (or downgrade) itself even when its own metadata and implementation
4442 * Prefer vendored packaging library `as recommended
4443 <https://github.com/pypa/setuptools/commit/170657b68f4b92e7e1bf82f5e19a831f5744af67>`_.
4448 * Issue #312: Restored presence of pkg_resources API tests (doctest) to sdist.
4453 * Issue #314: Disabled support for ``setup_requires`` metadata to avoid issue
4454 where Setuptools was unable to upgrade over earlier versions.
4459 * BB Pull Request #106: Now write ``setup_requires`` metadata.
4464 * Issue #311: Decoupled pkg_resources from setuptools once again.
4465 ``pkg_resources`` is now a package instead of a module.
4470 * Issue #306: Suppress warnings about Version format except in select scenarios
4471 (such as installation).
4476 * BB Pull Request #85: Search egg-base when adding egg-info to manifest.
4481 * Upgrade ``packaging`` to 14.5, giving preference to "rc" as designator for
4482 release candidates over "c".
4483 * PEP-440 warnings are now raised as their own class,
4484 ``pkg_resources.PEP440Warning``, instead of RuntimeWarning.
4485 * Disabled warnings on empty versions.
4490 * Upgrade ``packaging`` to 14.4, fixing an error where there is a
4491 different result for if 2.0.5 is contained within >2.0dev and >2.0.dev even
4492 though normalization rules should have made them equal.
4493 * Issue #296: Add warning when a version is parsed as legacy. This warning will
4494 make it easier for developers to recognize deprecated version numbers.
4499 * Issue #296: Restored support for ``__hash__`` on parse_version results.
4504 * Issue #296: Restored support for ``__getitem__`` and sort operations on
4505 parse_version result.
4510 * Issue #296: Restore support for iteration over parse_version result, but
4511 deprecated that usage with a warning. Fixes failure with buildout.
4516 * Implement PEP 440 within
4517 pkg_resources and setuptools. This change
4518 deprecates some version numbers such that they will no longer be installable
4519 without using the ``===`` escape hatch. See `the changes to test_resources
4520 <https://bitbucket.org/pypa/setuptools/commits/dcd552da643c4448056de84c73d56da6d70769d5#chg-setuptools/tests/test_resources.py>`_
4521 for specific examples of version numbers and specifiers that are no longer
4522 supported. Setuptools now "vendors" the `packaging
4523 <https://github.com/pypa/packaging>`_ library.
4528 * Issue #80, Issue #209: Eggs that are downloaded for ``setup_requires``,
4529 ``test_requires``, etc. are now placed in a ``./.eggs`` directory instead of
4530 directly in the current directory. This choice of location means the files
4531 can be readily managed (removed, ignored). Additionally,
4532 later phases or invocations of setuptools will not detect the package as
4533 already installed and ignore it for permanent install (See #209).
4535 This change is indicated as backward-incompatible as installations that
4536 depend on the installation in the current directory will need to account for
4537 the new location. Systems that ignore ``*.egg`` will probably need to be
4538 adapted to ignore ``.eggs``. The files will need to be manually moved or
4539 will be retrieved again. Most use cases will require no attention.
4544 * Issue #268: When resolving package versions, a VersionConflict now reports
4545 which package previously required the conflicting version.
4550 * Issue #262: Fixed regression in pip install due to egg-info directories
4551 being omitted. Re-opens Issue #118.
4556 * Issue #259: Fixed regression with namespace package handling on ``single
4557 version, externally managed`` installs.
4562 * Issue #100: When building a distribution, Setuptools will no longer match
4563 default files using platform-dependent case sensitivity, but rather will
4564 only match the files if their case matches exactly. As a result, on Windows
4565 and other case-insensitive file systems, files with names such as
4566 'readme.txt' or 'README.TXT' will be omitted from the distribution and a
4567 warning will be issued indicating that 'README.txt' was not found. Other
4568 filenames affected are:
4573 - setup.py (or the script name)
4576 Any users producing distributions with filenames that match those above
4577 case-insensitively, but not case-sensitively, should rename those files in
4578 their repository for better portability.
4579 * BB Pull Request #72: When using ``single_version_externally_managed``, the
4580 exclusion list now includes Python 3.2 ``__pycache__`` entries.
4581 * BB Pull Request #76 and BB Pull Request #78: lines in top_level.txt are now
4582 ordered deterministically.
4583 * Issue #118: The egg-info directory is now no longer included in the list
4585 * Issue #258: Setuptools now patches distutils msvc9compiler to
4586 recognize the specially-packaged compiler package for easy extension module
4587 support on Python 2.6, 2.7, and 3.2.
4592 * Issue #237: ``pkg_resources`` now uses explicit detection of Python 2 vs.
4593 Python 3, supporting environments where builtins have been patched to make
4594 Python 3 look more like Python 2.
4599 * Issue #240: Based on real-world performance measures against 5.4, zip
4600 manifests are now cached in all circumstances. The
4601 ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` environment variable is no longer
4602 relevant. The observed "memory increase" referenced in the 5.4 release
4603 notes and detailed in Issue #154 was likely not an increase over the status
4604 quo, but rather only an increase over not storing the zip info at all.
4609 * Issue #242: Use absolute imports in svn_utils to avoid issues if the
4610 installing package adds an xml module to the path.
4615 * Issue #239: Fix typo in 5.5 such that fix did not take.
4620 * Issue #239: Setuptools now includes the setup_requires directive on
4621 Distribution objects and validates the syntax just like install_requires
4622 and tests_require directives.
4627 * Issue #236: Corrected regression in execfile implementation for Python 2.6.
4632 * Python #7776: (ssl_support) Correct usage of host for validation when
4633 tunneling for HTTPS.
4638 * Issue #154: ``pkg_resources`` will now cache the zip manifests rather than
4639 re-processing the same file from disk multiple times, but only if the
4640 environment variable ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` is set. Clients
4641 that package many modules in the same zip file will see some improvement
4642 in startup time by enabling this feature. This feature is not enabled by
4643 default because it causes a substantial increase in memory usage.
4648 * Issue #185: Make svn tagging work on the new style SVN metadata.
4650 * Prune revision control directories (e.g .svn) from base path
4651 as well as sub-directories.
4656 * Added a `Developer Guide
4657 <https://setuptools.pypa.io/en/latest/developer-guide.html>`_ to the official
4659 * Some code refactoring and cleanup was done with no intended behavioral
4661 * During install_egg_info, the generated lines for namespace package .pth
4662 files are now processed even during a dry run.
4667 * Issue #202: Implemented more robust cache invalidation for the ZipImporter,
4668 building on the work in Issue #168. Special thanks to Jurko Gospodnetic and
4674 * Issue #220: Restored script templates.
4679 * Renamed script templates to end with .tmpl now that they no longer need
4680 to be processed by 2to3. Fixes spurious syntax errors during build/install.
4685 * Issue #218: Re-release of 3.8.1 to signal that it supersedes 4.x.
4686 * Incidentally, script templates were updated not to include the triple-quote
4689 3.7.1 and 3.8.1 and 4.0.1
4690 -------------------------
4692 * Issue #213: Use legacy StringIO behavior for compatibility under pbr.
4693 * Issue #218: Setuptools 3.8.1 superseded 4.0.1, and 4.x was removed
4694 from the available versions to install.
4699 * Issue #210: ``setup.py develop`` now copies scripts in binary mode rather
4700 than text mode, matching the behavior of the ``install`` command.
4705 * Extend Issue #197 workaround to include all Python 3 versions prior to
4711 * Issue #193: Improved handling of Unicode filenames when building manifests.
4716 * Issue #203: Honor proxy settings for Powershell downloader in the bootstrap
4722 * Issue #168: More robust handling of replaced zip files and stale caches.
4723 Fixes ZipImportError complaining about a 'bad local header'.
4728 * Issue #199: Restored ``install._install`` for compatibility with earlier
4734 * Issue #195: Follow symbolic links in find_packages (restoring behavior
4736 * Issue #197: On Python 3.1, PKG-INFO is now saved in a UTF-8 encoding instead
4737 of ``sys.getpreferredencoding`` to match the behavior on Python 2.6-3.4.
4738 * Issue #192: Preferred bootstrap location is now
4739 https://bootstrap.pypa.io/ez_setup.py (mirrored from former location).
4744 * Issue #184: Correct failure where find_package over-matched packages
4745 when directory traversal isn't short-circuited.
4750 * Issue #183: Really fix test command with Python 3.1.
4755 * Issue #183: Fix additional regression in test command on Python 3.1.
4760 * Issue #180: Fix regression in test command not caught by py.test-run tests.
4765 * Issue #176: Add parameter to the test command to support a custom test
4766 runner: --test-runner or -r.
4767 * Issue #177: Now assume most common invocation to install command on
4768 platforms/environments without stack support (issuing a warning). Setuptools
4769 now installs naturally on IronPython. Behavior on CPython should be
4775 * Add ``include`` parameter to ``setuptools.find_packages()``.
4780 * BB Pull Request #39: Add support for C++ targets from Cython ``.pyx`` files.
4781 * Issue #162: Update dependency on certifi to 1.0.1.
4782 * Issue #164: Update dependency on wincertstore to 0.2.
4787 * Issue #161: Restore Features functionality to allow backward compatibility
4788 (for Features) until the uses of that functionality is sufficiently removed.
4793 * Correct typo in previous bugfix.
4798 * Issue #157: Restore support for Python 2.6 in bootstrap script where
4799 ``zipfile.ZipFile`` does not yet have support for context managers.
4804 * Issue #125: Prevent Subversion support from creating a ~/.subversion
4805 directory just for checking the presence of a Subversion repository.
4806 * Issue #12: Namespace packages are now imported lazily. That is, the mere
4807 declaration of a namespace package in an egg on ``sys.path`` no longer
4808 causes it to be imported when ``pkg_resources`` is imported. Note that this
4809 change means that all of a namespace package's ``__init__.py`` files must
4810 include a ``declare_namespace()`` call in order to ensure that they will be
4811 handled properly at runtime. In 2.x it was possible to get away without
4812 including the declaration, but only at the cost of forcing namespace
4813 packages to be imported early, which 3.0 no longer does.
4814 * Issue #148: When building (bdist_egg), setuptools no longer adds
4815 ``__init__.py`` files to namespace packages. Any packages that rely on this
4816 behavior will need to create ``__init__.py`` files and include the
4817 ``declare_namespace()``.
4818 * Issue #7: Setuptools itself is now distributed as a zip archive in addition to
4819 tar archive. ez_setup.py now uses zip archive. This approach avoids the potential
4820 security vulnerabilities presented by use of tar archives in ez_setup.py.
4821 It also leverages the security features added to ZipFile.extract in Python 2.7.4.
4822 * Issue #65: Removed deprecated Features functionality.
4823 * BB Pull Request #28: Remove backport of ``_bytecode_filenames`` which is
4824 available in Python 2.6 and later, but also has better compatibility with
4825 Python 3 environments.
4826 * Issue #156: Fix spelling of __PYVENV_LAUNCHER__ variable.
4831 * Issue #141: Restored fix for allowing setup_requires dependencies to
4832 override installed dependencies during setup.
4833 * Issue #128: Fixed issue where only the first dependency link was honored
4834 in a distribution where multiple dependency links were supplied.
4839 * Issue #144: Read long_description using codecs module to avoid errors
4840 installing on systems where LANG=C.
4845 * Issue #139: Fix regression in re_finder for CVS repos (and maybe Git repos
4851 * Issue #129: Suppress inspection of ``*.whl`` files when searching for files
4852 in a zip-imported file.
4853 * Issue #131: Fix RuntimeError when constructing an egg fetcher.
4858 * Fix NameError during installation with Python implementations (e.g. Jython)
4859 not containing parser module.
4860 * Fix NameError in ``sdist:re_finder``.
4865 * Issue #124: Fixed error in list detection in upload_docs.
4870 * Issue #121: Exempt lib2to3 pickled grammars from DirectorySandbox.
4871 * Issue #41: Dropped support for Python 2.4 and Python 2.5. Clients requiring
4872 setuptools for those versions of Python should use setuptools 1.x.
4873 * Removed ``setuptools.command.easy_install.HAS_USER_SITE``. Clients
4874 expecting this boolean variable should use ``site.ENABLE_USER_SITE``
4876 * Removed ``pkg_resources.ImpWrapper``. Clients that expected this class
4877 should use ``pkgutil.ImpImporter`` instead.
4882 * Issue #116: Correct TypeError when reading a local package index on Python
4888 * Issue #114: Use ``sys.getfilesystemencoding`` for decoding config in
4889 ``bdist_wininst`` distributions.
4891 * Issue #105 and Issue #113: Establish a more robust technique for
4892 determining the terminal encoding::
4894 1. Try ``getpreferredencoding``
4895 2. If that returns US_ASCII or None, try the encoding from
4896 ``getdefaultlocale``. If that encoding was a "fallback" because Python
4897 could not figure it out from the environment or OS, encoding remains
4899 3. If the encoding is resolved, then make sure Python actually implements
4901 4. On the event of an error or unknown codec, revert to fallbacks
4902 (UTF-8 on Darwin, ASCII on everything else).
4903 5. On the encoding is 'mac-roman' on Darwin, use UTF-8 as 'mac-roman' was
4904 a bug on older Python releases.
4906 On a side note, it would seem that the encoding only matters for when SVN
4907 does not yet support ``--xml`` and when getting repository and svn version
4908 numbers. The ``--xml`` technique should yield UTF-8 according to some
4909 messages on the SVN mailing lists. So if the version numbers are always
4910 7-bit ASCII clean, it may be best to only support the file parsing methods
4911 for legacy SVN releases and support for SVN without the subprocess command
4912 would simple go away as support for the older SVNs does.
4917 * Issue #27: ``easy_install`` will now use credentials from .pypirc if
4918 present for connecting to the package index.
4919 * BB Pull Request #21: Omit unwanted newlines in ``package_index._encode_auth``
4920 when the username/password pair length indicates wrapping.
4925 * Issue #99: Fix filename encoding issues in SVN support.
4930 * Remove exuberant warning in SVN support when SVN is not used.
4935 * Address security vulnerability in SSL match_hostname check as reported in
4937 * Prefer :pypi:`backports.ssl_match_hostname` for backport
4938 implementation if present.
4939 * Correct NameError in ``ssl_support`` module (``socket.error``).
4944 * Issue #26: Add support for SVN 1.7. Special thanks to Philip Thiem for the
4946 * Issue #93: Wheels are now distributed with every release. Note that as
4947 reported in Issue #108, as of Pip 1.4, scripts aren't installed properly
4948 from wheels. Therefore, if using Pip to install setuptools from a wheel,
4949 the ``easy_install`` command will not be available.
4950 * Setuptools "natural" launcher support, introduced in 1.0, is now officially
4956 * Fixed behavior of NameError handling in 'script template (dev).py' (script
4957 launcher for 'develop' installs).
4958 * ``ez_setup.py`` now ensures partial downloads are cleaned up following
4960 * Distribute #363 and Issue #55: Skip an sdist test that fails on locales
4966 * Distribute #349: ``sandbox.execfile`` now opens the target file in binary
4967 mode, thus honoring a BOM in the file when compiled.
4972 * Issue #69: Second attempt at fix (logic was reversed).
4977 * Issue #77: Fix error in upload command (Python 2.4).
4982 * Fix NameError in previous patch.
4987 * Issue #69: Correct issue where 404 errors are returned for URLs with
4988 fragments in them (such as #egg=).
4993 * Issue #75: Add ``--insecure`` option to ez_setup.py to accommodate
4994 environments where a trusted SSL connection cannot be validated.
4995 * Issue #76: Fix AttributeError in upload command with Python 2.4.
5000 * Issue #71 (Distribute #333): EasyInstall now puts less emphasis on the
5001 condition when a host is blocked via ``--allow-hosts``.
5002 * Issue #72: Restored Python 2.4 compatibility in ``ez_setup.py``.
5007 * Issue #60: On Windows, Setuptools supports deferring to another launcher,
5008 such as Vinay Sajip's `pylauncher <https://bitbucket.org/pypa/pylauncher>`_
5009 (included with Python 3.3) to launch console and GUI scripts and not install
5010 its own launcher executables. This experimental functionality is currently
5011 only enabled if the ``SETUPTOOLS_LAUNCHER`` environment variable is set to
5012 "natural". In the future, this behavior may become default, but only after
5013 it has matured and seen substantial adoption. The ``SETUPTOOLS_LAUNCHER``
5014 also accepts "executable" to force the default behavior of creating launcher
5016 * Issue #63: Bootstrap script (ez_setup.py) now prefers Powershell, curl, or
5017 wget for retrieving the Setuptools tarball for improved security of the
5018 install. The script will still fall back to a simple ``urlopen`` on
5019 platforms that do not have these tools.
5020 * Issue #65: Deprecated the ``Features`` functionality.
5021 * Issue #52: In ``VerifyingHTTPSConn``, handle a tunnelled (proxied)
5024 Backward-Incompatible Changes
5025 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5027 This release includes a couple of backward-incompatible changes, but most if
5028 not all users will find 1.0 a drop-in replacement for 0.9.
5030 * Issue #50: Normalized API of environment marker support. Specifically,
5031 removed line number and filename from SyntaxErrors when returned from
5032 ``pkg_resources.invalid_marker``. Any clients depending on the specific
5033 string representation of exceptions returned by that function may need to
5034 be updated to account for this change.
5035 * Issue #50: SyntaxErrors generated by ``pkg_resources.invalid_marker`` are
5036 normalized for cross-implementation consistency.
5037 * Removed ``--ignore-conflicts-at-my-risk`` and ``--delete-conflicting``
5038 options to easy_install. These options have been deprecated since 0.6a11.
5043 * Issue #53: Fix NameErrors in ``_vcs_split_rev_from_url``.
5048 * Issue #49: Correct AttributeError on PyPy where a hashlib.HASH object does
5049 not have a ``.name`` attribute.
5050 * Issue #34: Documentation now refers to bootstrap script in code repository
5051 referenced by bookmark.
5052 * Add underscore-separated keys to environment markers (markerlib).
5057 * Issue #44: Test failure on Python 2.4 when MD5 hash doesn't have a ``.name``
5063 * Python #17980: Fix security vulnerability in SSL certificate validation.
5068 * Issue #43: Fix issue (introduced in 0.9.1) with version resolution when
5069 upgrading over other releases of Setuptools.
5074 * Issue #42: Fix new ``AttributeError`` introduced in last fix.
5079 * Issue #42: Fix regression where blank checksums would trigger an
5085 * Distribute #386: Allow other positional and keyword arguments to os.open.
5086 * Corrected dependency on certifi mis-referenced in 0.9.
5091 * ``package_index`` now validates hashes other than MD5 in download links.
5096 * Code base now runs on Python 2.4 - Python 3.3 without Python 2to3
5102 * Distribute #375: Yet another fix for yet another regression.
5107 * Distribute #375: Repair AttributeError created in last release (redo).
5108 * Issue #30: Added test for get_cache_path.
5113 * Distribute #375: Repair AttributeError created in last release.
5118 * Issue #21: Restore Python 2.4 compatibility in ``test_easy_install``.
5119 * Distribute #375: Merged additional warning from Distribute 0.6.46.
5120 * Now honor the environment variable
5121 ``SETUPTOOLS_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT`` in addition to the now
5122 deprecated ``DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT``.
5127 * Issue #20: Fix comparison of parsed SVN version on Python 3.
5132 * Issue #1: Disable installation of Windows-specific files on non-Windows systems.
5133 * Use new sysconfig module with Python 2.7 or >=3.2.
5138 * Issue #14: Use markerlib when the ``parser`` module is not available.
5139 * Issue #10: ``ez_setup.py`` now uses HTTPS to download setuptools from PyPI.
5144 * Fix NameError (Issue #3) again - broken in bad merge.
5149 * Merged Setuptools and Distribute. See docs/merge.txt for details.
5151 Added several features that were slated for setuptools 0.6c12:
5153 * Index URL now defaults to HTTPS.
5154 * Added experimental environment marker support. Now clients may designate a
5155 PEP-426 environment marker for "extra" dependencies. Setuptools uses this
5156 feature in ``setup.py`` for optional SSL and certificate validation support
5157 on older platforms. Based on Distutils-SIG discussions, the syntax is
5158 somewhat tentative. There should probably be a PEP with a firmer spec before
5159 the feature should be considered suitable for use.
5160 * Added support for SSL certificate validation when installing packages from
5166 * Issue #3: Fixed NameError in SSL support.
5171 * Move warning check in ``get_cache_path`` to follow the directory creation
5172 to avoid errors when the cache path does not yet exist. Fixes the error
5173 reported in Distribute #375.
5178 * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
5184 * Correct AttributeError in ``ResourceManager.get_cache_path`` introduced in
5190 * Distribute #375: Issue a warning if the PYTHON_EGG_CACHE or otherwise
5191 customized egg cache location specifies a directory that's group- or
5197 * Distribute #379: ``distribute_setup.py`` now traps VersionConflict as well,
5198 restoring ability to upgrade from an older setuptools version.
5203 * ``distribute_setup.py`` has been updated to allow Setuptools 0.7 to
5204 satisfy use_setuptools.
5209 * Distribute #378: Restore support for Python 2.4 Syntax (regression in 0.6.42).
5214 * External links finder no longer yields duplicate links.
5215 * Distribute #337: Moved site.py to setuptools/site-patch.py (graft of very old
5216 patch from setuptools trunk which inspired PR #31).
5221 * Distribute #27: Use public api for loading resources from zip files rather than
5222 the private method ``_zip_directory_cache``.
5223 * Added a new function ``easy_install.get_win_launcher`` which may be used by
5224 third-party libraries such as buildout to get a suitable script launcher.
5229 * Distribute #376: brought back cli.exe and gui.exe that were deleted in the
5235 * Add support for console launchers on ARM platforms.
5236 * Fix possible issue in GUI launchers where the subsystem was not supplied to
5238 * Launcher build script now refactored for robustness.
5239 * Distribute #375: Resources extracted from a zip egg to the file system now also
5240 check the contents of the file against the zip contents during each
5241 invocation of get_resource_filename.
5246 * Distribute #371: The launcher manifest file is now installed properly.
5251 * Distribute #143: Launcher scripts, including easy_install itself, are now
5252 accompanied by a manifest on 32-bit Windows environments to avoid the
5253 Installer Detection Technology and thus undesirable UAC elevation described
5254 in `this Microsoft article
5255 <http://technet.microsoft.com/en-us/library/cc709628%28WS.10%29.aspx>`_.
5260 * BB Pull Request #35: In Buildout #64, it was reported that
5261 under Python 3, installation of distutils scripts could attempt to copy
5262 the ``__pycache__`` directory as a file, causing an error, apparently only
5263 under Windows. Easy_install now skips all directories when processing
5270 Note this release is backward-incompatible with distribute 0.6.23-0.6.34 in
5271 how it parses version numbers.
5273 * Distribute #278: Restored compatibility with distribute 0.6.22 and setuptools
5274 0.6. Updated the documentation to match more closely with the version
5275 parsing as intended in setuptools 0.6.
5280 * Distribute #341: 0.6.33 fails to build under Python 2.4.
5285 * Fix 2 errors with Jython 2.5.
5286 * Fix 1 failure with Jython 2.5 and 2.7.
5287 * Disable workaround for Jython scripts on Linux systems.
5288 * Distribute #336: ``setup.py`` no longer masks failure exit code when tests fail.
5289 * Fix issue in pkg_resources where try/except around a platform-dependent
5290 import would trigger hook load failures on Mercurial. See pull request 32
5292 * Distribute #341: Fix a ResourceWarning.
5297 * Fix test suite with Python 2.6.
5298 * Fix some DeprecationWarnings and ResourceWarnings.
5299 * Distribute #335: Backed out ``setup_requires`` superseding installed requirements
5300 until regression can be addressed.
5305 * Distribute #303: Make sure the manifest only ever contains UTF-8 in Python 3.
5306 * Distribute #329: Properly close files created by tests for compatibility with
5308 * Work around Jython #1980 and Jython #1981.
5309 * Distribute #334: Provide workaround for packages that reference ``sys.__stdout__``
5310 such as numpy does. This change should address pypa/virtualenv#359 as long
5311 as the system encoding is UTF-8 or the IO encoding is specified in the
5314 PYTHONIOENCODING=utf8 pip install numpy
5316 * Fix for encoding issue when installing from Windows executable on Python 3.
5317 * Distribute #323: Allow ``setup_requires`` requirements to supersede installed
5318 requirements. Added some new keyword arguments to existing pkg_resources
5319 methods. Also had to updated how __path__ is handled for namespace packages
5320 to ensure that when a new egg distribution containing a namespace package is
5321 placed on sys.path, the entries in __path__ are found in the same order they
5322 would have been in had that egg been on the path when pkg_resources was
5328 * Distribute #328: Clean up temporary directories in distribute_setup.py.
5329 * Fix fatal bug in distribute_setup.py.
5334 * BB Pull Request #14: Honor file permissions in zip files.
5335 * Distribute #327: Merged pull request #24 to fix a dependency problem with pip.
5336 * Merged pull request #23 to fix pypa/virtualenv#301.
5337 * If Sphinx is installed, the ``upload_docs`` command now runs ``build_sphinx``
5338 to produce uploadable documentation.
5339 * Distribute #326: ``upload_docs`` provided mangled auth credentials under Python 3.
5340 * Distribute #320: Fix check for "creatable" in distribute_setup.py.
5341 * Distribute #305: Remove a warning that was triggered during normal operations.
5342 * Distribute #311: Print metadata in UTF-8 independent of platform.
5343 * Distribute #303: Read manifest file with UTF-8 encoding under Python 3.
5344 * Distribute #301: Allow to run tests of namespace packages when using 2to3.
5345 * Distribute #304: Prevent import loop in site.py under Python 3.3.
5346 * Distribute #283: Re-enable scanning of ``*.pyc`` / ``*.pyo`` files on Python 3.3.
5347 * Distribute #299: The develop command didn't work on Python 3, when using 2to3,
5348 as the egg link would go to the Python 2 source. Linking to the 2to3'd code
5349 in build/lib makes it work, although you will have to rebuild the module
5351 * Distribute #306: Even if 2to3 is used, we build in-place under Python 2.
5352 * Distribute #307: Prints the full path when .svn/entries is broken.
5353 * Distribute #313: Support for sdist subcommands (Python 2.7)
5354 * Distribute #314: test_local_index() would fail an OS X.
5355 * Distribute #310: Non-ascii characters in a namespace __init__.py causes errors.
5356 * Distribute #218: Improved documentation on behavior of ``package_data`` and
5357 ``include_package_data``. Files indicated by ``package_data`` are now included
5359 * ``distribute_setup.py`` now allows a ``--download-base`` argument for retrieving
5360 distribute from a specified location.
5365 * Distribute #294: setup.py can now be invoked from any directory.
5366 * Scripts are now installed honoring the umask.
5367 * Added support for .dist-info directories.
5368 * Distribute #283: Fix and disable scanning of ``*.pyc`` / ``*.pyo`` files on
5374 * Support current snapshots of CPython 3.3.
5375 * Distribute now recognizes README.rst as a standard, default readme file.
5376 * Exclude 'encodings' modules when removing modules from sys.modules.
5377 Workaround for #285.
5378 * Distribute #231: Don't fiddle with system python when used with buildout
5384 * Distribute #183: Symlinked files are now extracted from source distributions.
5385 * Distribute #227: Easy_install fetch parameters are now passed during the
5386 installation of a source distribution; now fulfillment of setup_requires
5387 dependencies will honor the parameters passed to easy_install.
5392 * Distribute #258: Workaround a cache issue
5393 * Distribute #260: distribute_setup.py now accepts the --user parameter for
5394 Python 2.6 and later.
5395 * Distribute #262: package_index.open_with_auth no longer throws LookupError
5397 * Distribute #269: AttributeError when an exception occurs reading Manifest.in
5398 on late releases of Python.
5399 * Distribute #272: Prevent TypeError when namespace package names are unicode
5400 and single-install-externally-managed is used. Also fixes PIP issue
5402 * Distribute #273: Legacy script launchers now install with Python2/3 support.
5407 * Distribute #249: Added options to exclude 2to3 fixers
5412 * Distribute #244: Fixed a test
5413 * Distribute #243: Fixed a test
5414 * Distribute #239: Fixed a test
5415 * Distribute #240: Fixed a test
5416 * Distribute #241: Fixed a test
5417 * Distribute #237: Fixed a test
5418 * Distribute #238: easy_install now uses 64bit executable wrappers on 64bit Python
5419 * Distribute #208: Fixed parsed_versions, it now honors post-releases as noted in the documentation
5420 * Distribute #207: Windows cli and gui wrappers pass CTRL-C to child python process
5421 * Distribute #227: easy_install now passes its arguments to setup.py bdist_egg
5422 * Distribute #225: Fixed a NameError on Python 2.5, 2.4
5427 * Distribute #225: FIxed a regression on py2.4
5432 * Distribute #135: Include url in warning when processing URLs in package_index.
5433 * Distribute #212: Fix issue where easy_instal fails on Python 3 on windows installer.
5434 * Distribute #213: Fix typo in documentation.
5439 * Distribute #206: AttributeError: 'HTTPMessage' object has no attribute 'getheaders'
5444 * Distribute #210: Fixed a regression introduced by Distribute #204 fix.
5449 * Support 'DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT' environment
5450 variable to allow to disable installation of easy_install-${version} script.
5451 * Support Python >=3.1.4 and >=3.2.1.
5452 * Distribute #204: Don't try to import the parent of a namespace package in
5454 * Distribute #196: Tolerate responses with multiple Content-Length headers
5455 * Distribute #205: Sandboxing doesn't preserve working_set. Leads to setup_requires
5461 * Builds sdist gztar even on Windows (avoiding Distribute #193).
5462 * Distribute #192: Fixed metadata omitted on Windows when package_dir
5463 specified with forward-slash.
5464 * Distribute #195: Cython build support.
5465 * Distribute #200: Issues with recognizing 64-bit packages on Windows.
5470 * Fixed typo in bdist_egg
5471 * Several issues under Python 3 has been solved.
5472 * Distribute #146: Fixed missing DLL files after easy_install of windows exe package.
5477 * Distribute #170: Fixed unittest failure. Thanks to Toshio.
5478 * Distribute #171: Fixed race condition in unittests cause deadlocks in test suite.
5479 * Distribute #143: Fixed a lookup issue with easy_install.
5480 Thanks to David and Zooko.
5481 * Distribute #174: Fixed the edit mode when its used with setuptools itself
5486 * Distribute #160: 2.7 gives ValueError("Invalid IPv6 URL")
5487 * Distribute #150: Fixed using ~/.local even in a --no-site-packages virtualenv
5488 * Distribute #163: scan index links before external links, and don't use the md5 when
5489 comparing two distributions
5494 * Distribute #149: Fixed various failures on 2.3/2.4
5499 * Found another case of SandboxViolation - fixed
5500 * Distribute #15 and Distribute #48: Introduced a socket timeout of 15 seconds on url openings
5501 * Added indexsidebar.html into MANIFEST.in
5502 * Distribute #108: Fixed TypeError with Python3.1
5503 * Distribute #121: Fixed --help install command trying to actually install.
5504 * Distribute #112: Added an os.makedirs so that Tarek's solution will work.
5505 * Distribute #133: Added --no-find-links to easy_install
5506 * Added easy_install --user
5507 * Distribute #100: Fixed develop --user not taking '.' in PYTHONPATH into account
5508 * Distribute #134: removed spurious UserWarnings. Patch by VanLindberg
5509 * Distribute #138: cant_write_to_target error when setup_requires is used.
5510 * Distribute #147: respect the sys.dont_write_bytecode flag
5515 * Reverted change made for the DistributionNotFound exception because
5516 zc.buildout uses the exception message to get the name of the
5522 * Distribute #90: unknown setuptools version can be added in the working set
5523 * Distribute #87: setupt.py doesn't try to convert distribute_setup.py anymore
5524 Initial Patch by arfrever.
5525 * Distribute #89: added a side bar with a download link to the doc.
5526 * Distribute #86: fixed missing sentence in pkg_resources doc.
5527 * Added a nicer error message when a DistributionNotFound is raised.
5528 * Distribute #80: test_develop now works with Python 3.1
5529 * Distribute #93: upload_docs now works if there is an empty sub-directory.
5530 * Distribute #70: exec bit on non-exec files
5531 * Distribute #99: now the standalone easy_install command doesn't uses a
5532 "setup.cfg" if any exists in the working directory. It will use it
5533 only if triggered by ``install_requires`` from a setup.py call
5534 (install, develop, etc).
5535 * Distribute #101: Allowing ``os.devnull`` in Sandbox
5536 * Distribute #92: Fixed the "no eggs" found error with MacPort
5537 (platform.mac_ver() fails)
5538 * Distribute #103: test_get_script_header_jython_workaround not run
5539 anymore under py3 with C or POSIX local. Contributed by Arfrever.
5540 * Distribute #104: removed the assertion when the installation fails,
5541 with a nicer message for the end user.
5542 * Distribute #100: making sure there's no SandboxViolation when
5543 the setup script patches setuptools.
5548 * Added "check_packages" in dist. (added in Setuptools 0.6c11)
5549 * Fixed the DONT_PATCH_SETUPTOOLS state.
5554 * Distribute #58: Added --user support to the develop command
5555 * Distribute #11: Generated scripts now wrap their call to the script entry point
5556 in the standard "if name == 'main'"
5557 * Added the 'DONT_PATCH_SETUPTOOLS' environment variable, so virtualenv
5558 can drive an installation that doesn't patch a global setuptools.
5559 * Reviewed unladen-swallow specific change from
5560 http://code.google.com/p/unladen-swallow/source/detail?spec=svn875&r=719
5561 and determined that it no longer applies. Distribute should work fine with
5562 Unladen Swallow 2009Q3.
5563 * Distribute #21: Allow PackageIndex.open_url to gracefully handle all cases of a
5564 httplib.HTTPException instead of just InvalidURL and BadStatusLine.
5565 * Removed virtual-python.py from this distribution and updated documentation
5566 to point to the actively maintained virtualenv instead.
5567 * Distribute #64: use_setuptools no longer rebuilds the distribute egg every
5569 * use_setuptools now properly respects the requested version
5570 * use_setuptools will no longer try to import a distribute egg for the
5571 wrong Python version
5572 * Distribute #74: no_fake should be True by default.
5573 * Distribute #72: avoid a bootstrapping issue with easy_install -U
5578 * Unified the bootstrap file so it works on both py2.x and py3k without 2to3
5579 (patch by Holger Krekel)
5584 * Distribute #65: cli.exe and gui.exe are now generated at build time,
5585 depending on the platform in use.
5587 * Distribute #67: Fixed doc typo (PEP 381/PEP 382).
5589 * Distribute no longer shadows setuptools if we require a 0.7-series
5590 setuptools. And an error is raised when installing a 0.7 setuptools with
5593 * When run from within buildout, no attempt is made to modify an existing
5594 setuptools egg, whether in a shared egg directory or a system setuptools.
5596 * Fixed a hole in sandboxing allowing builtin file to write outside of
5602 * Added the generation of ``distribute_setup_3k.py`` during the release.
5603 This closes Distribute #52.
5605 * Added an upload_docs command to easily upload project documentation to
5606 PyPI's https://pythonhosted.org. This close issue Distribute #56.
5608 * Fixed a bootstrap bug on the use_setuptools() API.
5616 * Fixed a bunch of calls to file() that caused crashes on Python 3.
5621 * Fixed a bug in sorting that caused bootstrap to fail on Python 3.
5629 * Added Python 3 support; see docs/python3.txt.
5630 This closes Old Setuptools #39.
5632 * Added option to run 2to3 automatically when installing on Python 3.
5633 This closes issue Distribute #31.
5635 * Fixed invalid usage of requirement.parse, that broke develop -d.
5636 This closes Old Setuptools #44.
5638 * Fixed script launcher for 64-bit Windows.
5639 This closes Old Setuptools #2.
5641 * KeyError when compiling extensions.
5642 This closes Old Setuptools #41.
5647 * Fixed bootstrap not working on Windows. This closes issue Distribute #49.
5649 * Fixed 2.6 dependencies. This closes issue Distribute #50.
5651 * Make sure setuptools is patched when running through easy_install
5652 This closes Old Setuptools #40.
5660 * package_index.urlopen now catches BadStatusLine and malformed url errors.
5661 This closes Distribute #16 and Distribute #18.
5663 * zip_ok is now False by default. This closes Old Setuptools #33.
5665 * Fixed invalid URL error catching. Old Setuptools #20.
5667 * Fixed invalid bootstraping with easy_install installation (Distribute #40).
5668 Thanks to Florian Schulze for the help.
5670 * Removed buildout/bootstrap.py. A new repository will create a specific
5671 bootstrap.py script.
5677 * The bootstrap process leave setuptools alone if detected in the system
5678 and --root or --prefix is provided, but is not in the same location.
5679 This closes Distribute #10.
5687 * Packages required at build time where not fully present at install time.
5688 This closes Distribute #12.
5690 * Protected against failures in tarfile extraction. This closes Distribute #10.
5692 * Made Jython api_tests.txt doctest compatible. This closes Distribute #7.
5694 * sandbox.py replaced builtin type file with builtin function open. This
5695 closes Distribute #6.
5697 * Immediately close all file handles. This closes Distribute #3.
5699 * Added compatibility with Subversion 1.6. This references Distribute #1.
5704 * Avoid a call to /usr/bin/sw_vers on OSX and use the official platform API
5705 instead. Based on a patch from ronaldoussoren. This closes issue #5.
5707 * Fixed a SandboxViolation for mkdir that could occur in certain cases.
5708 This closes Distribute #13.
5710 * Allow to find_on_path on systems with tight permissions to fail gracefully.
5711 This closes Distribute #9.
5713 * Corrected inconsistency between documentation and code of add_entry.
5714 This closes Distribute #8.
5716 * Immediately close all file handles. This closes Distribute #3.
5721 * Immediately close all file handles. This closes Distribute #3.
5726 * Fixed a missing files problem when using Windows source distributions on
5727 non-Windows platforms, due to distutils not handling manifest file line
5730 * Updated Pyrex support to work with Pyrex 0.9.6 and higher.
5732 * Minor changes for Jython compatibility, including skipping tests that can't
5735 * Fixed not installing eggs in ``install_requires`` if they were also used for
5736 ``setup_requires`` or ``tests_require``.
5738 * Fixed not fetching eggs in ``install_requires`` when running tests.
5740 * Allow ``ez_setup.use_setuptools()`` to upgrade existing setuptools
5741 installations when called from a standalone ``setup.py``.
5743 * Added a warning if a namespace package is declared, but its parent package
5744 is not also declared as a namespace.
5746 * Support Subversion 1.5
5748 * Removed use of deprecated ``md5`` module if ``hashlib`` is available
5750 * Fixed ``bdist_wininst upload`` trying to upload the ``.exe`` twice
5752 * Fixed ``bdist_egg`` putting a ``native_libs.txt`` in the source package's
5753 ``.egg-info``, when it should only be in the built egg's ``EGG-INFO``.
5755 * Ensure that _full_name is set on all shared libs before extensions are
5756 checked for shared lib usage. (Fixes a bug in the experimental shared
5757 library build support.)
5759 * Fix to allow unpacked eggs containing native libraries to fail more
5760 gracefully under Google App Engine (with an ``ImportError`` loading the
5761 C-based module, instead of getting a ``NameError``).
5763 * Fixed ``win32.exe`` support for .pth files, so unnecessary directory nesting
5764 is flattened out in the resulting egg. (There was a case-sensitivity
5765 problem that affected some distributions, notably ``pywin32``.)
5767 * Prevent ``--help-commands`` and other junk from showing under Python 2.5
5768 when running ``easy_install --help``.
5770 * Fixed GUI scripts sometimes not executing on Windows
5772 * Fixed not picking up dependency links from recursive dependencies.
5774 * Only make ``.py``, ``.dll`` and ``.so`` files executable when unpacking eggs
5776 * Changes for Jython compatibility
5778 * Improved error message when a requirement is also a directory name, but the
5779 specified directory is not a source package.
5781 * Fixed ``--allow-hosts`` option blocking ``file:`` URLs
5783 * Fixed HTTP SVN detection failing when the page title included a project
5784 name (e.g. on SourceForge-hosted SVN)
5786 * Fix Jython script installation to handle ``#!`` lines better when
5787 ``sys.executable`` is a script.
5789 * Removed use of deprecated ``md5`` module if ``hashlib`` is available
5791 * Keep site directories (e.g. ``site-packages``) from being included in
5797 * Fixed ``distutils.filelist.findall()`` crashing on broken symlinks, and
5798 ``egg_info`` command failing on new, uncommitted SVN directories.
5800 * Fix import problems with nested namespace packages installed via
5801 ``--root`` or ``--single-version-externally-managed``, due to the
5802 parent package not having the child package as an attribute.
5804 * ``ftp:`` download URLs now work correctly.
5806 * The default ``--index-url`` is now ``https://pypi.python.org/simple``, to use
5807 the Python Package Index's new simpler (and faster!) REST API.
5812 * Added ``--egg-path`` option to ``develop`` command, allowing you to force
5813 ``.egg-link`` files to use relative paths (allowing them to be shared across
5814 platforms on a networked drive).
5816 * Fix not building binary RPMs correctly.
5818 * Fix "eggsecutables" (such as setuptools' own egg) only being runnable with
5819 bash-compatible shells.
5821 * Fix ``#!`` parsing problems in Windows ``.exe`` script wrappers, when there
5822 was whitespace inside a quoted argument or at the end of the ``#!`` line
5823 (a regression introduced in 0.6c4).
5825 * Fix ``test`` command possibly failing if an older version of the project
5826 being tested was installed on ``sys.path`` ahead of the test source
5829 * Fix ``find_packages()`` treating ``ez_setup`` and directories with ``.`` in
5830 their names as packages.
5832 * EasyInstall no longer aborts the installation process if a URL it wants to
5833 retrieve can't be downloaded, unless the URL is an actual package download.
5834 Instead, it issues a warning and tries to keep going.
5836 * Fixed distutils-style scripts originally built on Windows having their line
5837 endings doubled when installed on any platform.
5839 * Added ``--local-snapshots-ok`` flag, to allow building eggs from projects
5840 installed using ``setup.py develop``.
5842 * Fixed not HTML-decoding URLs scraped from web pages
5847 * Fix uploaded ``bdist_rpm`` packages being described as ``bdist_egg``
5848 packages under Python versions less than 2.5.
5850 * Fix uploaded ``bdist_wininst`` packages being described as suitable for
5851 "any" version by Python 2.5, even if a ``--target-version`` was specified.
5853 * Fixed ``.dll`` files on Cygwin not having executable permissions when an egg
5854 is installed unzipped.
5859 * Overhauled Windows script wrapping to support ``bdist_wininst`` better.
5860 Scripts installed with ``bdist_wininst`` will always use ``#!python.exe`` or
5861 ``#!pythonw.exe`` as the executable name (even when built on non-Windows
5862 platforms!), and the wrappers will look for the executable in the script's
5863 parent directory (which should find the right version of Python).
5865 * Fix ``upload`` command not uploading files built by ``bdist_rpm`` or
5866 ``bdist_wininst`` under Python 2.3 and 2.4.
5868 * Add support for "eggsecutable" headers: a ``#!/bin/sh`` script that is
5869 prepended to an ``.egg`` file to allow it to be run as a script on Unix-ish
5870 platforms. (This is mainly so that setuptools itself can have a single-file
5871 installer on Unix, without doing multiple downloads, dealing with firewalls,
5874 * Fix problem with empty revision numbers in Subversion 1.4 ``entries`` files
5876 * Use cross-platform relative paths in ``easy-install.pth`` when doing
5877 ``develop`` and the source directory is a subdirectory of the installation
5880 * Fix a problem installing eggs with a system packaging tool if the project
5881 contained an implicit namespace package; for example if the ``setup()``
5882 listed a namespace package ``foo.bar`` without explicitly listing ``foo``
5883 as a namespace package.
5885 * Added support for HTTP "Basic" authentication using ``http://user:pass@host``
5886 URLs. If a password-protected page contains links to the same host (and
5887 protocol), those links will inherit the credentials used to access the
5890 * Removed all special support for Sourceforge mirrors, as Sourceforge's
5891 mirror system now works well for non-browser downloads.
5893 * Fixed not recognizing ``win32.exe`` installers that included a custom
5896 * Fixed not allowing ``os.open()`` of paths outside the sandbox, even if they
5897 are opened read-only (e.g. reading ``/dev/urandom`` for random numbers, as
5898 is done by ``os.urandom()`` on some platforms).
5900 * Fixed a problem with ``.pth`` testing on Windows when ``sys.executable``
5901 has a space in it (e.g., the user installed Python to a ``Program Files``
5907 * Fixed breakages caused by Subversion 1.4's new "working copy" format
5909 * You can once again use "python -m easy_install" with Python 2.4 and above.
5911 * Python 2.5 compatibility fixes added.
5916 * The ``ez_setup`` module displays the conflicting version of setuptools (and
5917 its installation location) when a script requests a version that's not
5920 * Running ``setup.py develop`` on a setuptools-using project will now install
5921 setuptools if needed, instead of only downloading the egg.
5923 * Windows script wrappers now support quoted arguments and arguments
5924 containing spaces. (Patch contributed by Jim Fulton.)
5926 * The ``ez_setup.py`` script now actually works when you put a setuptools
5927 ``.egg`` alongside it for bootstrapping an offline machine.
5929 * A writable installation directory on ``sys.path`` is no longer required to
5930 download and extract a source distribution using ``--editable``.
5932 * Generated scripts now use ``-x`` on the ``#!`` line when ``sys.executable``
5933 contains non-ASCII characters, to prevent deprecation warnings about an
5934 unspecified encoding when the script is run.
5939 * Fixed ``AttributeError`` when trying to download a ``setup_requires``
5940 dependency when a distribution lacks a ``dependency_links`` setting.
5942 * Made ``zip-safe`` and ``not-zip-safe`` flag files contain a single byte, so
5943 as to play better with packaging tools that complain about zero-length
5946 * Made ``setup.py develop`` respect the ``--no-deps`` option, which it
5947 previously was ignoring.
5949 * Support ``extra_path`` option to ``setup()`` when ``install`` is run in
5950 backward-compatibility mode.
5952 * Source distributions now always include a ``setup.cfg`` file that explicitly
5953 sets ``egg_info`` options such that they produce an identical version number
5954 to the source distribution's version number. (Previously, the default
5955 version number could be different due to the use of ``--tag-date``, or if
5956 the version was overridden on the command line that built the source
5959 * EasyInstall now includes setuptools version information in the
5960 ``User-Agent`` string sent to websites it visits.
5965 * Fix ``register`` not obeying name/version set by ``egg_info`` command, if
5966 ``egg_info`` wasn't explicitly run first on the same command line.
5968 * Added ``--no-date`` and ``--no-svn-revision`` options to ``egg_info``
5969 command, to allow suppressing tags configured in ``setup.cfg``.
5971 * Fixed redundant warnings about missing ``README`` file(s); it should now
5972 appear only if you are actually a source distribution.
5974 * Fix creating Python wrappers for non-Python scripts
5976 * Fix ``ftp://`` directory listing URLs from causing a crash when used in the
5977 "Home page" or "Download URL" slots on PyPI.
5979 * Fix ``sys.path_importer_cache`` not being updated when an existing zipfile
5980 or directory is deleted/overwritten.
5982 * Fix not recognizing HTML 404 pages from package indexes.
5984 * Allow ``file://`` URLs to be used as a package index. URLs that refer to
5985 directories will use an internally-generated directory listing if there is
5986 no ``index.html`` file in the directory.
5988 * Allow external links in a package index to be specified using
5989 ``rel="homepage"`` or ``rel="download"``, without needing the old
5990 PyPI-specific visible markup.
5992 * Suppressed warning message about possibly-misspelled project name, if an egg
5993 or link for that project name has already been seen.
5998 * Fix ``bdist_egg`` not including files in subdirectories of ``.egg-info``.
6000 * Allow ``.py`` files found by the ``include_package_data`` option to be
6001 automatically included. Remove duplicate data file matches if both
6002 ``include_package_data`` and ``package_data`` are used to refer to the same
6005 * Fix local ``--find-links`` eggs not being copied except with
6008 * Fix sometimes not detecting local packages installed outside of "site"
6011 * Fix mysterious errors during initial ``setuptools`` install, caused by
6012 ``ez_setup`` trying to run ``easy_install`` twice, due to a code fallthru
6013 after deleting the egg from which it's running.
6018 * Don't install or update a ``site.py`` patch when installing to a
6019 ``PYTHONPATH`` directory with ``--multi-version``, unless an
6020 ``easy-install.pth`` file is already in use there.
6022 * Construct ``.pth`` file paths in such a way that installing an egg whose
6023 name begins with ``import`` doesn't cause a syntax error.
6025 * Fixed a bogus warning message that wasn't updated since the 0.5 versions.
6030 * Strip ``module`` from the end of compiled extension modules when computing
6031 the name of a ``.py`` loader/wrapper. (Python's import machinery ignores
6032 this suffix when searching for an extension module.)
6034 * Better ambiguity management: accept ``#egg`` name/version even if processing
6035 what appears to be a correctly-named distutils file, and ignore ``.egg``
6036 files with no ``-``, since valid Python ``.egg`` files always have a version
6037 number (but Scheme eggs often don't).
6039 * Support ``file://`` links to directories in ``--find-links``, so that
6040 easy_install can build packages from local source checkouts.
6042 * Added automatic retry for Sourceforge mirrors. The new download process is
6043 to first just try dl.sourceforge.net, then randomly select mirror IPs and
6044 remove ones that fail, until something works. The removed IPs stay removed
6045 for the remainder of the run.
6047 * Ignore bdist_dumb distributions when looking at download URLs.
6052 * Added ``test_loader`` keyword to support custom test loaders
6054 * Added ``setuptools.file_finders`` entry point group to allow implementing
6055 revision control plugins.
6057 * Added ``--identity`` option to ``upload`` command.
6059 * Added ``dependency_links`` to allow specifying URLs for ``--find-links``.
6061 * Enhanced test loader to scan packages as well as modules, and call
6062 ``additional_tests()`` if present to get non-unittest tests.
6064 * Support namespace packages in conjunction with system packagers, by omitting
6065 the installation of any ``__init__.py`` files for namespace packages, and
6066 adding a special ``.pth`` file to create a working package in
6069 * Made ``--single-version-externally-managed`` automatic when ``--root`` is
6070 used, so that most system packagers won't require special support for
6073 * Fixed ``setup_requires``, ``tests_require``, etc. not using ``setup.cfg`` or
6074 other configuration files for their option defaults when installing, and
6075 also made the install use ``--multi-version`` mode so that the project
6076 directory doesn't need to support .pth files.
6078 * ``MANIFEST.in`` is now forcibly closed when any errors occur while reading
6079 it. Previously, the file could be left open and the actual error would be
6080 masked by problems trying to remove the open file on Windows systems.
6082 * Process ``dependency_links.txt`` if found in a distribution, by adding the
6083 URLs to the list for scanning.
6085 * Use relative paths in ``.pth`` files when eggs are being installed to the
6086 same directory as the ``.pth`` file. This maximizes portability of the
6087 target directory when building applications that contain eggs.
6089 * Added ``easy_install-N.N`` script(s) for convenience when using multiple
6092 * Added automatic handling of installation conflicts. Eggs are now shifted to
6093 the front of sys.path, in an order consistent with where they came from,
6094 making EasyInstall seamlessly co-operate with system package managers.
6096 The ``--delete-conflicting`` and ``--ignore-conflicts-at-my-risk`` options
6097 are now no longer necessary, and will generate warnings at the end of a
6098 run if you use them.
6100 * Don't recursively traverse subdirectories given to ``--find-links``.
6105 * Fixed the ``develop`` command ignoring ``--find-links``.
6107 * Added exhaustive testing of the install directory, including a spawn test
6108 for ``.pth`` file support, and directory writability/existence checks. This
6109 should virtually eliminate the need to set or configure ``--site-dirs``.
6111 * Added ``--prefix`` option for more do-what-I-mean-ishness in the absence of
6114 * Enhanced ``PYTHONPATH`` support so that you don't have to put any eggs on it
6115 manually to make it work. ``--multi-version`` is no longer a silent
6116 default; you must explicitly use it if installing to a non-PYTHONPATH,
6117 non-"site" directory.
6119 * Expand ``$variables`` used in the ``--site-dirs``, ``--build-directory``,
6120 ``--install-dir``, and ``--script-dir`` options, whether on the command line
6121 or in configuration files.
6123 * Improved SourceForge mirror processing to work faster and be less affected
6124 by transient HTML changes made by SourceForge.
6126 * PyPI searches now use the exact spelling of requirements specified on the
6127 command line or in a project's ``install_requires``. Previously, a
6128 normalized form of the name was used, which could lead to unnecessary
6129 full-index searches when a project's name had an underscore (``_``) in it.
6131 * EasyInstall can now download bare ``.py`` files and wrap them in an egg,
6132 as long as you include an ``#egg=name-version`` suffix on the URL, or if
6133 the ``.py`` file is listed as the "Download URL" on the project's PyPI page.
6134 This allows third parties to "package" trivial Python modules just by
6135 linking to them (e.g. from within their own PyPI page or download links
6138 * The ``--always-copy`` option now skips "system" and "development" eggs since
6139 they can't be reliably copied. Note that this may cause EasyInstall to
6140 choose an older version of a package than what you expected, or it may cause
6141 downloading and installation of a fresh version of what's already installed.
6143 * The ``--find-links`` option previously scanned all supplied URLs and
6144 directories as early as possible, but now only directories and direct
6145 archive links are scanned immediately. URLs are not retrieved unless a
6146 package search was already going to go online due to a package not being
6147 available locally, or due to the use of the ``--update`` or ``-U`` option.
6149 * Fixed the annoying ``--help-commands`` wart.
6154 * The ``sdist`` command no longer uses the traditional ``MANIFEST`` file to
6155 create source distributions. ``MANIFEST.in`` is still read and processed,
6156 as are the standard defaults and pruning. But the manifest is built inside
6157 the project's ``.egg-info`` directory as ``SOURCES.txt``, and it is rebuilt
6158 every time the ``egg_info`` command is run.
6160 * Added the ``include_package_data`` keyword to ``setup()``, allowing you to
6161 automatically include any package data listed in revision control or
6164 * Added the ``exclude_package_data`` keyword to ``setup()``, allowing you to
6165 trim back files included via the ``package_data`` and
6166 ``include_package_data`` options.
6168 * Fixed ``--tag-svn-revision`` not working when run from a source
6171 * Added warning for namespace packages with missing ``declare_namespace()``
6173 * Added ``tests_require`` keyword to ``setup()``, so that e.g. packages
6174 requiring ``nose`` to run unit tests can make this dependency optional
6175 unless the ``test`` command is run.
6177 * Made all commands that use ``easy_install`` respect its configuration
6178 options, as this was causing some problems with ``setup.py install``.
6180 * Added an ``unpack_directory()`` driver to ``setuptools.archive_util``, so
6181 that you can process a directory tree through a processing filter as if it
6182 were a zipfile or tarfile.
6184 * Added an internal ``install_egg_info`` command to use as part of old-style
6185 ``install`` operations, that installs an ``.egg-info`` directory with the
6188 * Added a ``--single-version-externally-managed`` option to the ``install``
6189 command so that you can more easily wrap a "flat" egg in a system package.
6191 * Enhanced ``bdist_rpm`` so that it installs single-version eggs that
6192 don't rely on a ``.pth`` file. The ``--no-egg`` option has been removed,
6193 since all RPMs are now built in a more backwards-compatible format.
6195 * Support full roundtrip translation of eggs to and from ``bdist_wininst``
6196 format. Running ``bdist_wininst`` on a setuptools-based package wraps the
6197 egg in an .exe that will safely install it as an egg (i.e., with metadata
6198 and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
6199 back into an ``.egg`` file or directory and install it as such.
6201 * Fixed ``.pth`` file processing picking up nested eggs (i.e. ones inside
6202 "baskets") when they weren't explicitly listed in the ``.pth`` file.
6204 * If more than one URL appears to describe the exact same distribution, prefer
6205 the shortest one. This helps to avoid "table of contents" CGI URLs like the
6208 * Quote arguments to python.exe (including python's path) to avoid problems
6209 when Python (or a script) is installed in a directory whose name contains
6212 * Support full roundtrip translation of eggs to and from ``bdist_wininst``
6213 format. Running ``bdist_wininst`` on a setuptools-based package wraps the
6214 egg in an .exe that will safely install it as an egg (i.e., with metadata
6215 and entry-point wrapper scripts), and ``easy_install`` can turn the .exe
6216 back into an ``.egg`` file or directory and install it as such.
6221 * Fixed some problems building extensions when Pyrex was installed, especially
6222 with Python 2.4 and/or packages using SWIG.
6224 * Made ``develop`` command accept all the same options as ``easy_install``,
6225 and use the ``easy_install`` command's configuration settings as defaults.
6227 * Made ``egg_info --tag-svn-revision`` fall back to extracting the revision
6228 number from ``PKG-INFO`` in case it is being run on a source distribution of
6229 a snapshot taken from a Subversion-based project.
6231 * Automatically detect ``.dll``, ``.so`` and ``.dylib`` files that are being
6232 installed as data, adding them to ``native_libs.txt`` automatically.
6234 * Fixed some problems with fresh checkouts of projects that don't include
6235 ``.egg-info/PKG-INFO`` under revision control and put the project's source
6236 code directly in the project directory. If such a package had any
6237 requirements that get processed before the ``egg_info`` command can be run,
6238 the setup scripts would fail with a "Missing 'Version:' header and/or
6239 PKG-INFO file" error, because the egg runtime interpreted the unbuilt
6240 metadata in a directory on ``sys.path`` (i.e. the current directory) as
6241 being a corrupted egg. Setuptools now monkeypatches the distribution
6242 metadata cache to pretend that the egg has valid version information, until
6243 it has a chance to make it actually be so (via the ``egg_info`` command).
6245 * Update for changed SourceForge mirror format
6247 * Fixed not installing dependencies for some packages fetched via Subversion
6249 * Fixed dependency installation with ``--always-copy`` not using the same
6250 dependency resolution procedure as other operations.
6252 * Fixed not fully removing temporary directories on Windows, if a Subversion
6253 checkout left read-only files behind
6255 * Fixed some problems building extensions when Pyrex was installed, especially
6256 with Python 2.4 and/or packages using SWIG.
6261 * Fixed not being able to install Windows script wrappers using Python 2.3
6266 * Added support for "traditional" PYTHONPATH-based non-root installation, and
6267 also the convenient ``virtual-python.py`` script, based on a contribution
6268 by Ian Bicking. The setuptools egg now contains a hacked ``site`` module
6269 that makes the PYTHONPATH-based approach work with .pth files, so that you
6270 can get the full EasyInstall feature set on such installations.
6272 * Added ``--no-deps`` and ``--allow-hosts`` options.
6274 * Improved Windows ``.exe`` script wrappers so that the script can have the
6275 same name as a module without confusing Python.
6277 * Changed dependency processing so that it's breadth-first, allowing a
6278 depender's preferences to override those of a dependee, to prevent conflicts
6279 when a lower version is acceptable to the dependee, but not the depender.
6280 Also, ensure that currently installed/selected packages aren't given
6281 precedence over ones desired by a package being installed, which could
6282 cause conflict errors.
6287 * Fixed missing gui/cli .exe files in distribution. Fixed bugs in tests.
6292 * Added ``gui_scripts`` entry point group to allow installing GUI scripts
6293 on Windows and other platforms. (The special handling is only for Windows;
6294 other platforms are treated the same as for ``console_scripts``.)
6296 * Improved error message when trying to use old ways of running
6297 ``easy_install``. Removed the ability to run via ``python -m`` or by
6298 running ``easy_install.py``; ``easy_install`` is the command to run on all
6299 supported platforms.
6301 * Improved wrapper script generation and runtime initialization so that a
6302 VersionConflict doesn't occur if you later install a competing version of a
6303 needed package as the default version of that package.
6305 * Fixed a problem parsing version numbers in ``#egg=`` links.
6310 * Added ``console_scripts`` entry point group to allow installing scripts
6311 without the need to create separate script files. On Windows, console
6312 scripts get an ``.exe`` wrapper so you can just type their name. On other
6313 platforms, the scripts are written without a file extension.
6315 * EasyInstall can now install "console_scripts" defined by packages that use
6316 ``setuptools`` and define appropriate entry points. On Windows, console
6317 scripts get an ``.exe`` wrapper so you can just type their name. On other
6318 platforms, the scripts are installed without a file extension.
6320 * Using ``python -m easy_install`` or running ``easy_install.py`` is now
6321 DEPRECATED, since an ``easy_install`` wrapper is now available on all
6327 * Added support for building "old-style" RPMs that don't install an egg for
6328 the target package, using a ``--no-egg`` option.
6330 * The ``build_ext`` command now works better when using the ``--inplace``
6331 option and multiple Python versions. It now makes sure that all extensions
6332 match the current Python version, even if newer copies were built for a
6333 different Python version.
6335 * The ``upload`` command no longer attaches an extra ``.zip`` when uploading
6336 eggs, as PyPI now supports egg uploads without trickery.
6338 * The ``ez_setup`` script/module now displays a warning before downloading
6339 the setuptools egg, and attempts to check the downloaded egg against an
6340 internal MD5 checksum table.
6342 * Fixed the ``--tag-svn-revision`` option of ``egg_info`` not finding the
6343 latest revision number; it was using the revision number of the directory
6344 containing ``setup.py``, not the highest revision number in the project.
6346 * Added ``eager_resources`` setup argument
6348 * The ``sdist`` command now recognizes Subversion "deleted file" entries and
6349 does not include them in source distributions.
6351 * ``setuptools`` now embeds itself more thoroughly into the distutils, so that
6352 other distutils extensions (e.g. py2exe, py2app) will subclass setuptools'
6353 versions of things, rather than the native distutils ones.
6355 * Added ``entry_points`` and ``setup_requires`` arguments to ``setup()``;
6356 ``setup_requires`` allows you to automatically find and download packages
6357 that are needed in order to *build* your project (as opposed to running it).
6359 * ``setuptools`` now finds its commands, ``setup()`` argument validators, and
6360 metadata writers using entry points, so that they can be extended by
6361 third-party packages. See `Creating distutils Extensions
6362 <https://setuptools.pypa.io/en/latest/setuptools.html#creating-distutils-extensions>`_
6365 * The vestigial ``depends`` command has been removed. It was never finished
6366 or documented, and never would have worked without EasyInstall - which it
6367 pre-dated and was never compatible with.
6369 * EasyInstall now does MD5 validation of downloads from PyPI, or from any link
6370 that has an "#md5=..." trailer with a 32-digit lowercase hex md5 digest.
6372 * EasyInstall now handles symlinks in target directories by removing the link,
6373 rather than attempting to overwrite the link's destination. This makes it
6374 easier to set up an alternate Python "home" directory (as described in
6375 the Non-Root Installation section of the docs).
6377 * Added support for handling MacOS platform information in ``.egg`` filenames,
6378 based on a contribution by Kevin Dangoor. You may wish to delete and
6379 reinstall any eggs whose filename includes "darwin" and "Power_Macintosh",
6380 because the format for this platform information has changed so that minor
6381 OS X upgrades (such as 10.4.1 to 10.4.2) do not cause eggs built with a
6382 previous OS version to become obsolete.
6384 * easy_install's dependency processing algorithms have changed. When using
6385 ``--always-copy``, it now ensures that dependencies are copied too. When
6386 not using ``--always-copy``, it tries to use a single resolution loop,
6387 rather than recursing.
6389 * Fixed installing extra ``.pyc`` or ``.pyo`` files for scripts with ``.py``
6392 * Added ``--site-dirs`` option to allow adding custom "site" directories.
6393 Made ``easy-install.pth`` work in platform-specific alternate site
6394 directories (e.g. ``~/Library/Python/2.x/site-packages`` on Mac OS X).
6396 * If you manually delete the current version of a package, the next run of
6397 EasyInstall against the target directory will now remove the stray entry
6398 from the ``easy-install.pth`` file.
6400 * EasyInstall now recognizes URLs with a ``#egg=project_name`` fragment ID
6401 as pointing to the named project's source checkout. Such URLs have a lower
6402 match precedence than any other kind of distribution, so they'll only be
6403 used if they have a higher version number than any other available
6404 distribution, or if you use the ``--editable`` option. The ``#egg``
6405 fragment can contain a version if it's formatted as ``#egg=proj-ver``,
6406 where ``proj`` is the project name, and ``ver`` is the version number. You
6407 *must* use the format for these values that the ``bdist_egg`` command uses;
6408 i.e., all non-alphanumeric runs must be condensed to single underscore
6411 * Added the ``--editable`` option; see Editing and Viewing Source Packages
6412 in the docs. Also, slightly changed the behavior of the
6413 ``--build-directory`` option.
6415 * Fixed the setup script sandbox facility not recognizing certain paths as
6416 valid on case-insensitive platforms.
6421 * The zip-safety scanner now checks for modules that might be used with
6422 ``python -m``, and marks them as unsafe for zipping, since Python 2.4 can't
6423 handle ``-m`` on zipped modules.
6425 * Fix ``python -m easy_install`` not working due to setuptools being installed
6426 as a zipfile. Update safety scanner to check for modules that might be used
6427 as ``python -m`` scripts.
6429 * Misc. fixes for win32.exe support, including changes to support Python 2.4's
6430 changed ``bdist_wininst`` format.
6435 * Fix breakage of the "develop" command that was caused by the addition of
6436 ``--always-unzip`` to the ``easy_install`` command.
6441 * Put the ``easy_install`` module back in as a module, as it's needed for
6442 ``python -m`` to run it!
6444 * Allow ``--find-links/-f`` to accept local directories or filenames as well
6450 * Include ``svn:externals`` directories in source distributions as well as
6451 normal subversion-controlled files and directories.
6453 * Added ``exclude=patternlist`` option to ``setuptools.find_packages()``
6455 * Changed --tag-svn-revision to include an "r" in front of the revision number
6456 for better readability.
6458 * Added ability to build eggs without including source files (except for any
6459 scripts, of course), using the ``--exclude-source-files`` option to
6462 * ``setup.py install`` now automatically detects when an "unmanaged" package
6463 or module is going to be on ``sys.path`` ahead of a package being installed,
6464 thereby preventing the newer version from being imported. If this occurs,
6465 a warning message is output to ``sys.stderr``, but installation proceeds
6466 anyway. The warning message informs the user what files or directories
6467 need deleting, and advises them they can also use EasyInstall (with the
6468 ``--delete-conflicting`` option) to do it automatically.
6470 * The ``egg_info`` command now adds a ``top_level.txt`` file to the metadata
6471 directory that lists all top-level modules and packages in the distribution.
6472 This is used by the ``easy_install`` command to find possibly-conflicting
6473 "unmanaged" packages when installing the distribution.
6475 * Added ``zip_safe`` and ``namespace_packages`` arguments to ``setup()``.
6476 Added package analysis to determine zip-safety if the ``zip_safe`` flag
6477 is not given, and advise the author regarding what code might need changing.
6479 * Fixed the swapped ``-d`` and ``-b`` options of ``bdist_egg``.
6481 * EasyInstall now automatically detects when an "unmanaged" package or
6482 module is going to be on ``sys.path`` ahead of a package you're installing,
6483 thereby preventing the newer version from being imported. By default, it
6484 will abort installation to alert you of the problem, but there are also
6485 new options (``--delete-conflicting`` and ``--ignore-conflicts-at-my-risk``)
6486 available to change the default behavior. (Note: this new feature doesn't
6487 take effect for egg files that were built with older ``setuptools``
6488 versions, because they lack the new metadata file required to implement it.)
6490 * The ``easy_install`` distutils command now uses ``DistutilsError`` as its
6491 base error type for errors that should just issue a message to stderr and
6492 exit the program without a traceback.
6494 * EasyInstall can now be given a path to a directory containing a setup
6495 script, and it will attempt to build and install the package there.
6497 * EasyInstall now performs a safety analysis on module contents to determine
6498 whether a package is likely to run in zipped form, and displays
6499 information about what modules may be doing introspection that would break
6500 when running as a zipfile.
6502 * Added the ``--always-unzip/-Z`` option, to force unzipping of packages that
6503 would ordinarily be considered safe to unzip, and changed the meaning of
6504 ``--zip-ok/-z`` to "always leave everything zipped".
6509 * The "egg_info" command now always sets the distribution metadata to "safe"
6510 forms of the distribution name and version, so that distribution files will
6511 be generated with parseable names (i.e., ones that don't include '-' in the
6512 name or version). Also, this means that if you use the various ``--tag``
6513 options of "egg_info", any distributions generated will use the tags in the
6514 version, not just egg distributions.
6516 * Added support for defining command aliases in distutils configuration files,
6517 under the "[aliases]" section. To prevent recursion and to allow aliases to
6518 call the command of the same name, a given alias can be expanded only once
6519 per command-line invocation. You can define new aliases with the "alias"
6520 command, either for the local, global, or per-user configuration.
6522 * Added "rotate" command to delete old distribution files, given a set of
6523 patterns to match and the number of files to keep. (Keeps the most
6524 recently-modified distribution files matching each pattern.)
6526 * Added "saveopts" command that saves all command-line options for the current
6527 invocation to the local, global, or per-user configuration file. Useful for
6528 setting defaults without having to hand-edit a configuration file.
6530 * Added a "setopt" command that sets a single option in a specified distutils
6533 * There is now a separate documentation page for setuptools; revision
6534 history that's not specific to EasyInstall has been moved to that page.
6539 * Added "upload" support for egg and source distributions, including a bug
6540 fix for "upload" and a temporary workaround for lack of .egg support in
6546 * Beefed up the "sdist" command so that if you don't have a MANIFEST.in, it
6547 will include all files under revision control (CVS or Subversion) in the
6548 current directory, and it will regenerate the list every time you create a
6549 source distribution, not just when you tell it to. This should make the
6550 default "do what you mean" more often than the distutils' default behavior
6551 did, while still retaining the old behavior in the presence of MANIFEST.in.
6553 * Fixed the "develop" command always updating .pth files, even if you
6554 specified ``-n`` or ``--dry-run``.
6556 * Slightly changed the format of the generated version when you use
6557 ``--tag-build`` on the "egg_info" command, so that you can make tagged
6558 revisions compare *lower* than the version specified in setup.py (e.g. by
6559 using ``--tag-build=dev``).
6564 * Added ``develop`` command to ``setuptools``-based packages. This command
6565 installs an ``.egg-link`` pointing to the package's source directory, and
6566 script wrappers that ``execfile()`` the source versions of the package's
6567 scripts. This lets you put your development checkout(s) on sys.path without
6568 having to actually install them. (To uninstall the link, use
6569 use ``setup.py develop --uninstall``.)
6571 * Added ``egg_info`` command to ``setuptools``-based packages. This command
6572 just creates or updates the "projectname.egg-info" directory, without
6573 building an egg. (It's used by the ``bdist_egg``, ``test``, and ``develop``
6576 * Enhanced the ``test`` command so that it doesn't install the package, but
6577 instead builds any C extensions in-place, updates the ``.egg-info``
6578 metadata, adds the source directory to ``sys.path``, and runs the tests
6579 directly on the source. This avoids an "unmanaged" installation of the
6580 package to ``site-packages`` or elsewhere.
6582 * Made ``easy_install`` a standard ``setuptools`` command, moving it from
6583 the ``easy_install`` module to ``setuptools.command.easy_install``. Note
6584 that if you were importing or extending it, you must now change your imports
6585 accordingly. ``easy_install.py`` is still installed as a script, but not as
6591 * Setup scripts using setuptools can now list their dependencies directly in
6592 the setup.py file, without having to manually create a ``depends.txt`` file.
6593 The ``install_requires`` and ``extras_require`` arguments to ``setup()``
6594 are used to create a dependencies file automatically. If you are manually
6595 creating ``depends.txt`` right now, please switch to using these setup
6596 arguments as soon as practical, because ``depends.txt`` support will be
6597 removed in the 0.6 release cycle. For documentation on the new arguments,
6598 see the ``setuptools.dist.Distribution`` class.
6600 * Setup scripts using setuptools now always install using ``easy_install``
6601 internally, for ease of uninstallation and upgrading.
6603 * Added ``--always-copy/-a`` option to always copy needed packages to the
6604 installation directory, even if they're already present elsewhere on
6605 sys.path. (In previous versions, this was the default behavior, but now
6606 you must request it.)
6608 * Added ``--upgrade/-U`` option to force checking PyPI for latest available
6609 version(s) of all packages requested by name and version, even if a matching
6610 version is available locally.
6612 * Added automatic installation of dependencies declared by a distribution
6613 being installed. These dependencies must be listed in the distribution's
6614 ``EGG-INFO`` directory, so the distribution has to have declared its
6615 dependencies by using setuptools. If a package has requirements it didn't
6616 declare, you'll still have to deal with them yourself. (E.g., by asking
6617 EasyInstall to find and install them.)
6619 * Added the ``--record`` option to ``easy_install`` for the benefit of tools
6620 that run ``setup.py install --record=filename`` on behalf of another
6626 * Fixed not setting script permissions to allow execution.
6628 * Improved sandboxing so that setup scripts that want a temporary directory
6629 (e.g. pychecker) can still run in the sandbox.
6634 * Fix stupid stupid refactoring-at-the-last-minute typos. :(
6639 * Added support for "self-installation" bootstrapping. Packages can now
6640 include ``ez_setup.py`` in their source distribution, and add the following
6641 to their ``setup.py``, in order to automatically bootstrap installation of
6642 setuptools as part of their setup process::
6644 from ez_setup import use_setuptools
6647 from setuptools import setup
6650 * Added support for converting ``.win32.exe`` installers to eggs on the fly.
6651 EasyInstall will now recognize such files by name and install them.
6653 * Fixed a problem with picking the "best" version to install (versions were
6654 being sorted as strings, rather than as parsed values)
6659 * Added support for the distutils "verbose/quiet" and "dry-run" options, as
6660 well as the "optimize" flag.
6662 * Support downloading packages that were uploaded to PyPI (by scanning all
6663 links on package pages, not just the homepage/download links).
6668 * Add progress messages to the search/download process so that you can tell
6669 what URLs it's reading to find download links. (Hopefully, this will help
6670 people report out-of-date and broken links to package authors, and to tell
6671 when they've asked for a package that doesn't exist.)
6676 * Added ``ez_setup.py`` installer/bootstrap script to make initial setuptools
6677 installation easier, and to allow distributions using setuptools to avoid
6678 having to include setuptools in their source distribution.
6680 * All downloads are now managed by the ``PackageIndex`` class (which is now
6681 subclassable and replaceable), so that embedders can more easily override
6682 download logic, give download progress reports, etc. The class has also
6683 been moved to the new ``setuptools.package_index`` module.
6685 * The ``Installer`` class no longer handles downloading, manages a temporary
6686 directory, or tracks the ``zip_ok`` option. Downloading is now handled
6687 by ``PackageIndex``, and ``Installer`` has become an ``easy_install``
6688 command class based on ``setuptools.Command``.
6690 * There is a new ``setuptools.sandbox.run_setup()`` API to invoke a setup
6691 script in a directory sandbox, and a new ``setuptools.archive_util`` module
6692 with an ``unpack_archive()`` API. These were split out of EasyInstall to
6693 allow reuse by other tools and applications.
6695 * ``setuptools.Command`` now supports reinitializing commands using keyword
6696 arguments to set/reset options. Also, ``Command`` subclasses can now set
6697 their ``command_consumes_arguments`` attribute to ``True`` in order to
6698 receive an ``args`` option containing the rest of the command line.
6700 * Added support for installing scripts
6702 * Added support for setting options via distutils configuration files, and
6703 using distutils' default options as a basis for EasyInstall's defaults.
6705 * Renamed ``--scan-url/-s`` to ``--find-links/-f`` to free up ``-s`` for the
6706 script installation directory option.
6708 * Use ``urllib2`` instead of ``urllib``, to allow use of ``https:`` URLs if
6709 Python includes SSL support.
6714 * Added ``--scan-url`` and ``--index-url`` options, to scan download pages
6715 and search PyPI for needed packages.
6720 * Restrict ``--build-directory=DIR/-b DIR`` option to only be used with single
6721 URL installs, to avoid running the wrong setup.py.
6726 * Added ``--build-directory=DIR/-b DIR`` option.
6728 * Added "installation report" that explains how to use 'require()' when doing
6729 a multiversion install or alternate installation directory.
6731 * Added SourceForge mirror auto-select (Contributed by Ian Bicking)
6733 * Added "sandboxing" that stops a setup script from running if it attempts to
6734 write to the filesystem outside of the build area
6736 * Added more workarounds for packages with quirky ``install_data`` hacks
6741 * Added new options to ``bdist_egg`` to allow tagging the egg's version number
6742 with a subversion revision number, the current date, or an explicit tag
6743 value. Run ``setup.py bdist_egg --help`` to get more information.
6745 * Added subversion download support for ``svn:`` and ``svn+`` URLs, as well as
6746 automatic recognition of HTTP subversion URLs (Contributed by Ian Bicking)
projects / platform / upstream / python3-setuptools.git / blob