Setuptools

=======


Breaking Changes
----------------
* 3151: Made ``setup.py develop --user`` install to the user site packages directory even if it is disabled in the current interpreter.

Changes
-------
* 3153: When resolving requirements use both canonical and normalized names -- by :user:`ldaniluk`
* 3167: Honor unix file mode in ZipFile when installing wheel via ``install_as_egg`` -- by :user:`delijati`

Misc
----
* 3088: Fixed duplicated tag with the ``dist-info`` command.
* 3247: Fixed problem preventing ``readme`` specified as dynamic in ``pyproject.toml``
from being dynamically specified in ``setup.py``.

=======


Misc
----
* 3233: Included missing test file ``setupcfg_examples.txt`` in ``sdist``.
* 3233: Added script that allows developers to download ``setupcfg_examples.txt`` prior to
running tests. By caching these files it should be possible to run the test suite
offline.

=======


Changes
-------
* 3229: Disabled automatic download of ``trove-classifiers`` to facilitate reproducibility.

Misc
----
* 3229: Updated ``pyproject.toml`` validation via ``validate-pyproject`` v0.7.1.
* 3229: New internal tool made available for updating the code responsible for
the validation of ``pyproject.toml``.
This tool can be executed via ``tox -e generate-validation-code``.

=======


Changes
-------
* 3215: Ignored a subgroup of invalid ``pyproject.toml`` files that use the ``[project]``
table to specify only ``requires-python`` (**transitional**).

.. warning::
Please note that future releases of setuptools will halt the build process
if a ``pyproject.toml`` file that does not match doc:`the PyPA Specification
<PyPUG:specifications/section-distribution-metadata>` is given.
* 3215: Updated ``pyproject.toml`` validation, as generated by ``validate-pyproject==0.6.1``.
* 3218: Prevented builds from erroring if the project specifies metadata via
``pyproject.toml``, but uses other files (e.g. ``setup.py``) to complement it,
without setting ``dynamic`` properly.

.. important::
This is a **transitional** behaviour.
Future releases of ``setuptools`` may simply ignore externally set metadata
not backed by ``dynamic`` or even halt the build with an error.
* 3224: Merge changes from pypa/distutilse1d5c9b1f6

Documentation changes
---------------------
* 3217: Fixed typo in ``pyproject.toml`` example in Quickstart -- by :user:`pablo-cardenas`.

Misc
----
* 3223: Fixed missing requirements with environment markers when
``optional-dependencies`` is set in ``pyproject.toml``.

=======


Misc
----
* 3212: Fixed missing dependencies when running ``setup.py install``.
Note that calling ``setup.py install`` directly is still deprecated and
will be removed in future versions of ``setuptools``.
Please check the release notes for :ref:`setup_install_deprecation_note`.

=======


Deprecations
------------
* 3206: Changed ``setuptools.convert_path`` to an internal function that is not exposed
as part of setuptools API.
Future releases of ``setuptools`` are likely to remove this function.

Changes
-------
* 3202: Changed behaviour of auto-discovery to not explicitly expand ``package_dir``
for flat-layouts and to not use relative paths starting with ``./``.
* 3203: Prevented ``pyproject.toml`` parsing from overwriting
``dist.include_package_data`` explicitly set in ``setup.py`` with default
value.
* 3208: Added a warning for non existing files listed with the ``file`` directive in
``setup.cfg`` and ``pyproject.toml``.
* 3208: Added a default value for dynamic ``classifiers`` in ``pyproject.toml`` when
files are missing and errors being ignored.
* 3211: Disabled auto-discovery when distribution class has a ``configuration``
attribute (e.g. when the ``setup.py`` script contains ``setup(...,
configuration=...)``). This is done to ensure extension-only packages created
with ``numpy.distutils.misc_util.Configuration`` are not broken by the safe
guard
behaviour to avoid accidental multiple top-level packages in a flat-layout.

.. note::
Users that don't set ``packages``, ``py_modules``, or ``configuration`` are
still likely to observe the auto-discovery behavior, which may halt the
build if the project contains multiple directories and/or multiple Python
files directly under the project root.

To disable auto-discovery please explicitly set either ``packages`` or
``py_modules``. Alternatively you can also configure :ref:`custom-discovery`.