![[BACK]](/icons/back.gif){kind=icon}
Up to [cvs.NetBSD.org] / pkgsrc / devel / py-setuptools
Request diff between arbitrary revisions
Keyword substitution: kv
Default branch: MAIN
py-setuptools: updated to 75.4.0 v75.4.0 Features Added support for the environment variable SETUPTOOLS_DANGEROUSLY_SKIP_PYPROJECT_VALIDATION=true, allowing users to bypass the validation of pyproject.toml. This option should be used only as a last resort when resolving dependency issues, as it may lead to improper functioning. Users who enable this setting are responsible for ensuring that pyproject.toml complies with setuptools requirements. Require Python 3.9 or later. Remove dependency on importlib_resources and the vendored copy of the library. Instead, setuptools consistently rely on stdlib's importlib.resources (available on Python 3.9+). Setuptools' bdist_wheel implementation no longer produces wheels with the m SOABI flag (pymalloc-related). This flag was removed on Python 3.8+ (see :obj:`sys.abiflags`). Updated vendored packaging version to 24.2. Bugfixes Merge with pypa/distutils@251797602, including fix for dirutil.mkpath handling in pypa/distutils.
py-setuptools: updated to 75.1.0 v75.1.0 Features Deprecated bdist_wheel.universal configuration. Bugfixes Removed reference to upload_docs module in entry points. v75.0.0 Features Declare also the dependencies used by distutils (adds jaraco.collections). Deprecations and Removals Removed upload_docs command. Merge with pypa/distutils@7283751. Removed the register and upload commands and the config module that backs them. Removed the borland compiler. Replaced vendored dependencies with natural dependencies. Cygwin C compiler now gets compilers from sysconfig.
py-setuptools: update to 74.1.2. v74.1.2 ======= Bugfixes -------- - Fixed TypeError in sdist filelist processing by adding support for pathlib Paths for the build_base. (#4615) - Removed degraded and deprecated ``test_integration`` (easy_install) from the test suite. (#4632) v74.1.1 ======= Bugfixes -------- - Fixed TypeError in ``msvc.EnvironmentInfo.return_env`` when no runtime redistributables are installed. (#1902) v74.1.0 ======= Features -------- - Added support for defining ``ext-modules`` via ``pyproject.toml`` (**EXPERIMENTAL**, may change in future releases). (#4568) Bugfixes -------- - Merge with pypa/distutils@3dcdf8567, removing the duplicate vendored copy of packaging. (#4622) - Restored ``setuptools.msvc.Environmentinfo`` as it is used externally. (#4625)
py-setuptools: updated to 74.0.0 v74.0.0 Features Changed the type of error raised by setuptools.command.easy_install.CommandSpec.from_param on unsupported argument from AttributeError to TypeError Added detection of ARM64 variant of MSVC Made setuptools.package_index.Credential a typing.NamedTuple Reraise error from setuptools.command.easy_install.auto_chmod instead of nonsensical TypeError: 'Exception' object is not subscriptable Fully typed all collection attributes in pkg_resources Automatically exclude .tox|.nox|.venv directories from sdist. Deprecations and Removals Removed the monkeypatching of distutils._msvccompiler. Now all compiler logic is consolidated in distutils. Synced with pypa/distutils@58fe058e4, including consolidating Visual Studio 2017 support
py-setuptools: update to 73.0.1. v73.0.1 ======= Bugfixes -------- - Remove `abc.ABCMeta` metaclass from abstract classes. `pypa/setuptools#4503 <https://github.com/pypa/setuptools/pull/4503>`_ had an unintended consequence of causing potential ``TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases`` -- by :user:`Avasam` (#4579) v73.0.0 ======= Features -------- - Mark abstract base classes and methods with `abc.ABC` and `abc.abstractmethod` -- by :user:`Avasam` (#4503) - Changed the order of type checks in ``setuptools.command.easy_install.CommandSpec.from_param`` to support any `collections.abc.Iterable` of `str` param -- by :user:`Avasam` (#4505) Bugfixes -------- - Prevent an error in ``bdist_wheel`` if ``compression`` is set to a `str` (even if valid) after finalizing options but before running the command. -- by :user:`Avasam` (#4383) - Raises an exception when ``py_limited_api`` is used in a build with ``Py_GIL_DISABLED``. This is currently not supported (python/cpython#111506). (#4420) - Synced with pypa/distutils@30b7331 including fix for modified check on empty sources (pypa/distutils#284). Deprecations and Removals ------------------------- - ``setuptools`` is replacing the usages of :pypi:`ordered_set` with simple instances of ``dict[Hashable, None]``. This is done to remove the extra dependency and it is possible because since Python 3.7, ``dict`` maintain insertion order. (#4574) Misc ---- - #4534, #4546, #4554, #4559, #4565
py-setuptools: updated to 72.1.0 v72.1.0 Features Restore the tests command and deprecate access to the module. v72.0.0 Deprecations and Removals The test command has been removed. Users relying on 'setup.py test' will need to migrate to another test runner or pin setuptools before this version.
py-setuptools: updated to 71.1.0 v71.1.0 Features Added return types to typed public functions Marked pkg_resources as py.typed
py-setuptools: update to 71.0.4. v71.0.4 ======= Bugfixes -------- - Removed lingering unused code around Distribution._patched_dist. (#4489) v71.0.3 ======= Bugfixes -------- - Reset the backports module when enabling vendored packages. (#4476) v71.0.2 ======= Bugfixes -------- - Include all vendored files in the sdist. (#4480) v71.0.1 ======= Bugfixes -------- - Restored package data that went missing in 71.0. This change also incidentally causes tests to be installed once again. (#4475) v71.0.0 ======= Deprecations and Removals ------------------------- - Now setuptools declares its own dependencies in the ``core`` extra. Dependencies are still vendored for bootstrapping purposes, but setuptools will prefer installed dependencies if present. The ``core`` extra is used for informational purposes and should *not* be declared in package metadata (e.g. ``build-requires``). Downstream packagers can de-vendor by simply removing the ``setuptools/_vendor`` directory. Since Setuptools now prefers installed dependencies, those installing to an environment with old, incompatible dependencies will not work. In that case, either uninstall the incompatible dependencies or upgrade them to satisfy those declared in ``core``. (#2825)
py-setuptools: updated to 70.2.0 v70.2.0 Features Updated distutils including significant changes to support Cygwin and mingw compilers. Bugfixes Fix distribution name normalisation (PEP 625) for valid versions that are not canonical (e.g. 1.0-2).
py-setuptools: update to 70.1.1. v70.1.1 ======= Misc ---- - #4429 v70.1.0 ======= Features -------- - Adopted the ``bdist_wheel`` command from the ``wheel`` project -- by :user:`agronholm` (#1386) - Improve error message when ``pkg_resources.ZipProvider`` tries to extract resources with a missing Egg -- by :user:`Avasam` Added variables and parameter type annotations to ``pkg_resources`` to be nearly on par with typeshed.\* -- by :user:`Avasam` \* Excluding ``TypeVar`` and ``overload``. Return types are currently inferred. (#4246) - Migrated Setuptools' own config to pyproject.toml (#4310) Bugfixes -------- - Prevent a ``TypeError: 'NoneType' object is not callable`` when ``shutil_rmtree`` is called without an ``onexc`` parameter on Python<=3.11 -- by :user:`Avasam` (#4382) - Replace use of mktemp with can_symlink from the stdlib test suite. (#4403) - Improvement for ``attr:`` directives in configuration to handle more edge cases related to complex ``package_dir``. (#4405) - Fix accidental implicit string concatenation. (#4411) Misc ---- - #4365, #4422
py-setuptools: update to 70.0.0. v70.0.0 ======= Features -------- - Emit a warning when ``[tools.setuptools]`` is present in ``pyproject.toml`` and will be ignored. -- by :user:`SnoopJ` (#4150) - Improved `AttributeError` error message if ``pkg_resources.EntryPoint.require`` is called without extras or distribution Gracefully "do nothing" when trying to activate a ``pkg_resources.Distribution`` with a `None` location, rather than raising a `TypeError` -- by :user:`Avasam` (#4262) - Typed the dynamically defined variables from `pkg_resources` -- by :user:`Avasam` (#4267) - Modernized and refactored VCS handling in package_index. (#4332) Bugfixes -------- - In install command, use super to call the superclass methods. Avoids race conditions when monkeypatching from _distutils_system_mod occurs late. (#4136) - Fix finder template for lenient editable installs of implicit nested namespaces constructed by using ``package_dir`` to reorganise directory structure. (#4278) - Fix an error with `UnicodeDecodeError` handling in ``pkg_resources`` when trying to read files in UTF-8 with a fallback -- by :user:`Avasam` (#4348) Improved Documentation ---------------------- - Uses RST substitution to put badges in 1 line. (#4312) Deprecations and Removals ------------------------- - Further adoption of UTF-8 in ``setuptools``. This change regards mostly files produced and consumed during the build process (e.g. metadata files, script wrappers, automatically updated config files, etc..) Although precautions were taken to minimize disruptions, some edge cases might be subject to backwards incompatibility. Support for ``"locale"`` encoding is now **deprecated**. (#4309) - Remove ``setuptools.convert_path`` after long deprecation period. This function was never defined by ``setuptools`` itself, but rather a side-effect of an import for internal usage. (#4322) - Remove fallback for customisations of ``distutils``' ``build.sub_command`` after long deprecated period. Users are advised to import ``build`` directly from ``setuptools.command.build``. (#4322) - Removed ``typing_extensions`` from vendored dependencies -- by :user:`Avasam` (#4324) - Remove deprecated ``setuptools.dep_util``. The provided alternative is ``setuptools.modified``. (#4360) Misc ---- - #4255, #4280, #4282, #4308, #4348
py-setuptools: updated to 69.5.1 v69.5.1 No significant changes. v69.5.0 Features Refresh unpinned vendored dependencies. Updated vendored packaging to version 24.0. v69.4.0 Features Merged with pypa/distutils@55982565e, including interoperability improvements for rfc822_escape, dynamic resolution of config_h_filename for Python 3.13 compatibility, added support for the z/OS compiler, modernized compiler options in unixcompiler, fixed accumulating flags bug after compile/link, fixed enconding warnings, and general quality improvements.
py-setuptools: updated to 69.2.0 v69.2.0 Features - Explicitly use ``encoding="locale"`` for ``.pth`` files whenever possible, to reduce ``EncodingWarnings``. This avoid errors with UTF-8 (see discussion in python/cpython-77102). Bugfixes - Clarify some `pkg_resources` methods return `bytes`, not `str`. Also return an empty `bytes` in ``EmptyProvider._get`` - Return an empty `list` by default in ``pkg_resources.ResourceManager.cleanup_resources`` - Made ``pkg_resoursces.NullProvider``'s ``has_metadata`` and ``metadata_isdir`` methods return actual booleans like all other Providers.
py-setuptools: updated to 69.1.0 v69.1.0 ======= Features -------- - Updated and removed obsolete Python < 3.8 code and comments. - Updated `pkg_resources` to use stdlib `importlib.machinery` instead of ``importlib_machinery`` Bugfixes -------- - In tests, rely on pytest-home for reusable fixture. - Explicitely marked as ``Protocol`` and fixed missing ``self`` argument in interfaces ``pkg_resources.IMetadataProvider`` and ``pkg_resources.IResourceProvider`` - Restored expectation that egg-link files would be named with dash separators for compatibility with pip prior to version 24. Improved Documentation ---------------------- - Updated documentation referencing obsolete Python 3.7 code. - Changed ``versionadded`` for "Type information included by default" feature from ``v68.3.0`` to ``v69.0.0`` - Described the auto-generated files - Updated "Quickstart" to describe the current status of ``setup.cfg`` and ``pyproject.toml``
Pullup ticket #6830 - requested by wiz devel/py-setuptools: build fix (via patch) Stop fetching in install phase
py-setuptools: convert to wheel.mk Standardizes this package a lot. Stops download in install phase. Bump PKGREVISION.
py-setuptools: updated to 69.0.2 v69.0.2 Bugfixes Added missing estimated date for removing setuptools.dep_util (deprecated in v69.0.0). v69.0.1 Bugfixes Fixed imports of setuptools.dep_util.newer_group. A deprecation warning is issued instead of a hard failure. v69.0.0 Features Include type information (py.typed, *.pyi) by default Exported distutils.dep_util and setuptools.dep_util through setuptools.modified Bugfixes Replaced hardcoded numeric values with :obj:`dis.opmap`, fixing problem with 3.13.0a1. Deprecations and Removals Configuring project version and egg_info.tag_* in such a way that results in invalid version strings (according to PEP 440) is no longer permitted. Removed deprecated egg_base option from dist_info. Note that the dist_info command is considered internal to the way setuptools build backend works and not intended for public usage. The parsing of the deprecated metadata.license_file and metadata.requires fields in setup.cfg is no longer supported. Users are expected to move to metadata.license_files and options.install_requires (respectively). Passing config_settings to setuptools.build_meta with deprecated values for --global-option is no longer allowed. Removed deprecated namespace-packages from pyproject.toml. Users are asked to use :doc:`implicit namespace packages <PyPUG:guides/packaging-namespace-packages>` (as defined in PEP 420). Added strict enforcement for project.dynamic in pyproject.toml. This removes the transitional ability of users configuring certain parameters via setup.py without making the necessary changes to pyproject.toml (as mandated by PEP 621). Removed handling of --config-settings["--build-option"] in setuptools.build_meta from build-backend API hooks other than build_wheel. This was motivate by errors caused when passing this option.
py-setuptools: adapt for Python base package change While here, make this package standalone, depending only on the pip coming with Python (and not distutils). This adds support for Python 3.12. Bump PKGREVISION.
py-setuptools: updated to 68.2.2 v68.2.2 Bugfixes Improve backwards compatibility with deprecated CLI practices. v68.2.1 Bugfixes Avoid using caching attributes in Distribution.metadata for requirements. This is done for backwards compatibility with customizations that attempt to modify install_requires or extras_require at a late point (still not recommended). v68.2.0 Features Rework how setuptools internally handles dependencies/install_requires and optional-dependencies/extras_require. Improve the generated PKG-INFO files, by adding Requires-Dist fields. Previously, these fields would be omitted in favour of a non-standard *.egg-info/requires.txt file (which is still generated for the time being). Improve atomicity when writing PKG-INFO files to avoid race conditions with importlib.metadata. Bugfixes Fix the name given to the *-nspkg.pth files in editable installs, ensuring they are unique per distribution. Workaround some limitations on pkg_resources-style legacy namespaces in the meta path finder for editable installations.
py-setuptools: update to 68.0.0. v68.0.0 ------- Breaking Changes ^^^^^^^^^^^^^^^^ * #3948: Removed verification for existing ``depends.txt`` file (deprecated since v0.5a4). * #3948: Remove autofixing of broken ``.egg-info`` directories containing the ``-`` character in their base name (without suffix). They should no longer be produced by sufficiently new versions of ``setuptools`` (warning introduced in 2005). * #3948: Remove deprecated APIs in ``easy_install``: ``get_script_args``, ``get_script_header`` and ``get_writer``. The direct usage of ``easy_install`` has been deprecated since v58.3.0, and the warnings regarding these APIs predate that version. * #3948: Removed ``egg_info.get_pkg_info_revision`` (deprecated since 2015). * #3948: Removed ``setuptools.dist._get_unpatched`` (deprecated since 2016) * #3948: Removed support for SVN in ``setuptools.package_index`` (deprecated since 2018). * #3948: Removed support for invalid ``pyproject.toml`` files. During the implementation of PEP 621, it was identified that some users were producing invalid files. As a transitional measure, the validation was relaxed for a few use cases. The grace period, however, came to an end. Changes ^^^^^^^ * #3760: Added symlink support to launcher for installed executables -- by :user:`eugene-sevostianov-sc` * #3926: Updated vendored ``packaging`` version from 23.0 to 23.1 -- by :user:`MetRonnie` * #3950: Implemented workaround for old versions of ``vswhere``, which miss the ``-requiresAny`` parameter, such as the ones distributed together with Visual Studio 2017 < 15.6. * #3952: Changed ``DistutilsMetaFinder`` to skip ``spec_for_pip`` on Python >= 3.12. * #3952: Removed ``_distutils_hack.remove_shim`` on Python >= 3.12 (since ``distutils`` was removed from the standard library, ``DistutilsMetaFinder`` cannot be disabled on Python >= 3.12). Misc ^^^^ * #3920: Add a link to deprecation warning in ``pkg_resources`` and improve ``stacklevel`` for better visibility.
py-setuptools: updated to 67.7.2 v67.7.2 Misc * Fixed wrong URLs used in warnings and logs. v67.7.1 Misc * Fixes setuptools.dist:invalid_unless_false when value is false don't raise error v67.7.0 Changes * Overhaul warning system for better visibility. Documentation changes * Added a note about historical presence of wheel in build-system.requires, in pyproject.toml. * Improved the documentation example regarding making a thin PEP 517 in-tree backend wrapper of setuptools.build_meta that is future-proof and supports PEP 660 hook too Misc * Add a stacklevel parameter to warnings.warn() to provide more information to the user.
py-setuptools: updated to 67.6.1 v67.6.1 Misc Fixed _WouldIgnoreField warnings for scripts and gui_scripts, when entry-points is not listed in dynamic. Update code generated by validate-pyproject to use v0.12.2. This should fix default license patterns when pyproject.toml is used. v67.6.0 Changes Added caching for supported wheel tags. Added pruning heuristics to PackageFinder based on exclude. v67.5.1 Misc Fixed interaction between setuptools' package auto-discovery and auto-generated htmlcov files. Previously, the htmlcov name was ignored when searching for single-file modules, however the correct behaviour is to ignore it when searching for packages (since it is supposed to be a directory, see coverage config) -- by :user:`yukihiko-shinoda`. Improved error messages for pyproject.toml validations. Fixed pkg_resources errors caused when parsing metadata of packages that are already installed but do not conform with PEP 440. v67.5.0 Changes Although pkg_resources has been discouraged for use, some projects still consider pkg_resources viable for usage. This change makes it clear that pkg_resources should not be used, emitting a DeprecationWarning when imported. v67.4.0 Changes Update vendored importlib-metadata (to 6.0.0) and importlib-resources (to 5.10.2)
py-setuptools: updated to 67.3.3 v67.3.3 Misc * Restore quoted #include argument to has_function. v67.3.2 Misc * Improve deprecation warning message on pkg_resources.declare_namespace to display package name. v67.3.1 Misc * Fixes egg_info code path triggered during integration with pip. v67.3.0 Deprecations * Added deprecation warning for pkg_resources.declare_namespace. Users that wish to implement namespace packages, are recommended to follow the practice described in PEP 420 and omit the __init__.py file entirely. Changes * Reduced usage of pkg_resources in setuptools via internal restructuring and refactoring. Misc * Added debugging tips for "editable mode" and update related docs. Instead of using a custom exception to display the help message to the user, setuptools will now use a warning and re-raise the original exception. * Added clarification about editable_wheel and dist_info CLI commands: they should not be called directly with python setup.py .... Instead they are reserved for internal use of setuptools (effectively as "private" commands). Users are recommended to rely on build backend APIs (PEP 517 and PEP 660) exposed by setuptools.build_meta.
py-setuptools: updated to 67.2.0 v67.2.0 Changes * Merge with distutils@8c3c3d29, including fix for sysconfig.get_python_inc(), fix for segfault on MinGW, and better has_function support. v67.1.0 Changes * Ensured that __file__ is an absolute path when executing setup.py as part of setuptools.build_meta. Misc * Updated validations for pyproject.toml using validate-pyproject==0.12.1 to allow stub packages (PEP 561) to be listed in tool.setuptools.packages and tool.setuptools.package-dir. v67.0.0 Breaking Changes * Removed patching of distutils._msvccompiler.gen_lib_options for compatibility with Numpy < 1.11.2 -- by :user:`mgorny` * Bump vendored version of :pypi:`packaging` to 23.0 (:pypi:`pyparsing` is no longer required and was removed). As a consequence, users will experience a more strict parsing of requirements. Specifications that don't comply with PEP 440 and PEP 508 will result in build errors. v66.1.1 Misc * Fixed problem with file directive in tool.setuptools.dynamic (pyproject.toml) when value is a simple string instead of list. v66.1.0 Changes * Fix improper usage of deprecated/removed pkgutil APIs in Python 3.12+. * Files referenced by file: in setup.cfg and by project.readme.file, project.license.file or tool.setuptools.dynamic.*.file in pyproject.toml are now automatically included in the generated sdists. Misc * Added note about using the --pep-517 flag with pip to workaround InvalidVersion errors for packages that are already installed in the system. v66.0.0 Breaking Changes * Support for PEP 440 non-conforming versions has been removed. Environments containing packages with non-conforming versions may fail or the packages may not be recognized. Changes * Replace 'appdirs' with 'platformdirs'.
py-setuptools: updated to 65.6.0 v65.6.0 Changes Sync with pypa/distutils@e0787fa, including pypa/distutils#183 updating distutils to use the Python logging framework.
py-setuptools: updated to 65.4.0 v65.4.0 ------- Changes * Merge with pypa/distutils@d82d926 including support for DIST_EXTRA_CONFIG in pypa/distutils-177. v65.3.0 ------- Changes * Stop ``ConfigDiscovery.analyse_name`` from splatting the ``Distribution.name`` attribute -- by :user:`jeamland` Documentation changes * Changed requires to requests in the pyproject.toml example in the :ref:`Dependency management section of the Quickstart guide <userguide/quickstart:dependency-management>` -- by :user:`mfbutner` Misc * Fixed accidental name matching in editable hooks. v65.2.0 ------- Changes * Sync with pypa/distutils@22b9bcf, including fixed cross-compiling support and removing deprecation warning per pypa/distutils-169. v65.1.1 ------- Misc * Avoided circular imports in meta path finder for editable installs when a missing module has the same name as its parent. v65.1.0 ------- Changes * Remove monkeypatching of msvc9compiler. Documentation changes * Corrected documentation on how to use the `legacy-editable` mode. v65.0.2 ------- Misc * Restored distutils msvccompiler and msvc9compiler modules and marked as deprecated (pypa/distutils@c802880). v65.0.1 ------- Documentation changes * Added clarification to :doc:`/userguide/quickstart` about support to ``setup.py``. Misc * Fixed backward compatibility of editable installs and custom ``build_ext`` commands inheriting directly from ``distutils``. * Fixed ``buid_meta.prepare_metadata_for_build_wheel`` when given ``metadata_directory`` is ``"."``. v65.0.0 ------- Breaking Changes * Removed 'msvccompiler' and 'msvc9compiler' modules from distutils. * Remove bdist_msi and bdist_wininst commands, which have been deprecated since Python 3.9. Use older Setuptools for these behaviors if needed. Documentation changes * Changed the note in ``keywords`` documentation regarding editable installations to specify which ``setuptools`` version require a minimal ``setup.py`` file or not.
py-setuptools: updated to 63.1.0 v63.1.0 Changes 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). v63.0.0 Breaking Changes Drop setuptools' support for installing an entrypoint extra requirements at load time: - the functionality has been broken since v60.8.0. - the mechanism to do so is deprecated (fetch_build_eggs). - that use case (e.g. a custom command class entrypoint) is covered by making sure the necessary build requirements are declared. Documentation changes Updated the example pyproject.toml -- by :user:`jacalata` This updates the documentation for the file_finders hook so that the logging recommendation aligns with the suggestion to not use distutils directly. Fix reference for keywords to point to the Core Metadata Specification instead of PEP 314 (the live standard is kept always up-to-date and consolidates several PEPs together in a single document). Reordered the User Guide's Table of Contents
py-setuptools: updated to 62.4.0 v62.4.0 Changes * Added setuptools.command.build command to match distutils.command.build -- by :user:`isuruf` * Merge with pypa/distutils@75ed79d including reformat using black, fix for Cygwin support, and improved support for cross compiling. Documentation changes * Changes to the User Guide's Entry Points page -- by :user:`codeandfire` * Further minor corrections to the Entry Points page -- by :user:`codeandfire` * Rework some documentation pages to de-emphasize distutils and the history of packaging in the Python ecosystem. The focus of these changes is to make the documentation easier to read for new users. * Update documentation about dependency management, removing mention to the deprecated dependency_links and adding some small improvements. * Extracted text about automatic resource extraction and the zip-safe flag from userguide/miscellaneous to deprecated/resource_extraction and deprecated/zip_safe. Extracted text about additional metadata files from userguide/miscellaneous into the existing userguide/extension document. Updated userguide/extension to better reflect the status of the setuptools project. Removed userguide/functionalities_rewrite (a virtually empty part of the docs).
py-setuptools: updated to 62.3.0 v62.3.0 Deprecations * Formally added deprecation messages for namespace_packages. The methodology that uses pkg_resources and namespace_packages for creating namespaces was already discouraged by the :doc:`setuptools docs </userguide/package_discovery>` and the :doc:`Python Packaging User Guide <PyPUG:guides/packaging-namespace-packages>`, therefore this change just make the deprecation more official. Users can consider migrating to native/implicit namespaces (as introduced in PEP 420). * Relying on include_package_data to ensure sub-packages are automatically added to the build wheel distribution (as "data") is now considered a deprecated practice. This behaviour was controversial and caused inconsistencies. Instead, projects are encouraged to properly configure packages or use discovery tools. General information can be found in :doc:`userguide/package_discovery`. Changes * Allowed recursive globs (**) in package_data. -- by :user:`nullableVoidPtr` * Fixed behaviour when both install_requires (in setup.py) and dependencies (in pyproject.toml) are specified. The configuration in pyproject.toml will take precedence over setup.py (in accordance with PEP 621). A warning was added to inform users. Documentation changes * Added introduction to references/keywords Added deprecation tags to test kwargs Moved userguide/keywords to deprecated section Clarified in deprecated doc what keywords came from distutils and which were added or changed by setuptools Misc * Updated version of vendored pyparsing to 3.0.8 to avoid problems with upcoming deprecation in Python 3.11. * Added warning about incompatibility with old versions of importlib-metadata.
py-setuptools: updated to 62.2.0 v62.2.0 Changes Optional metadata fields are now truly optional. Misc Added CI cache for setup.cfg examples used when testing setuptools.config.
py-setuptools: updated to 62.1.0 v62.1.0 Changes * Merge pypa/distutils@5229dad46b. Misc * Simplified package_dir obtained via auto-discovery.
py-setuptools: updated to 62.0.0
v62.0.0
-------
Breaking Changes
^^^^^^^^^^^^^^^^
* Made ``setup.py develop --user`` install to the user site packages directory even if it is disabled in the current interpreter.
Changes
^^^^^^^
* When resolving requirements use both canonical and normalized names -- by :user:`ldaniluk`
* Honor unix file mode in ZipFile when installing wheel via ``install_as_egg`` -- by :user:`delijati`
Misc
^^^^
* Fixed duplicated tag with the ``dist-info`` command.
* Fixed problem preventing ``readme`` specified as dynamic in ``pyproject.toml``
from being dynamically specified in ``setup.py``.
v61.3.1
-------
Misc
^^^^
* Included missing test file ``setupcfg_examples.txt`` in ``sdist``.
* 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.
v61.3.0
-------
Changes
^^^^^^^
* Disabled automatic download of ``trove-classifiers`` to facilitate reproducibility.
Misc
^^^^
* Updated ``pyproject.toml`` validation via ``validate-pyproject`` v0.7.1.
* 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``.
v61.2.0
-------
Changes
^^^^^^^
* 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/declaring-project-metadata>` is given.
* Updated ``pyproject.toml`` validation, as generated by ``validate-pyproject==0.6.1``.
* 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.
* Merge changes from pypa/distutils@e1d5c9b1f6
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* Fixed typo in ``pyproject.toml`` example in Quickstart -- by :user:`pablo-cardenas`.
Misc
^^^^
* Fixed missing requirements with environment markers when
``optional-dependencies`` is set in ``pyproject.toml``.
v61.1.1
-------
Misc
^^^^
* 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`.
v61.1.0
-------
Deprecations
^^^^^^^^^^^^
* 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
^^^^^^^
* Changed behaviour of auto-discovery to not explicitly expand ``package_dir``
for flat-layouts and to not use relative paths starting with ``./``.
* Prevented ``pyproject.toml`` parsing from overwriting
``dist.include_package_data`` explicitly set in ``setup.py`` with default
value.
* Added a warning for non existing files listed with the ``file`` directive in
``setup.cfg`` and ``pyproject.toml``.
* Added a default value for dynamic ``classifiers`` in ``pyproject.toml`` when
files are missing and errors being ignored.
* 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`.
v61.0.0
-------
Deprecations
^^^^^^^^^^^^
* Deprecated ``setuptools.config.read_configuration``,
``setuptools.config.parse_configuration`` and other functions or classes
from ``setuptools.config``.
Users that still need to parse and process configuration from ``setup.cfg`` can
import a direct replacement from ``setuptools.config.setupcfg``, however this
module is transitional and might be removed in the future
(the ``setup.cfg`` configuration format itself is likely to be deprecated in the future).
Breaking Changes
^^^^^^^^^^^^^^^^
* If you purposefully want to create an *"empty distribution"*, please be aware
that some Python files (or general folders) might be automatically detected and
included.
Projects that currently don't specify both ``packages`` and ``py_modules`` in their
configuration and contain extra folders or Python files (not meant for distribution),
might see these files being included in the wheel archive or even experience
the build to fail.
You can check details about the automatic discovery (and how to configure a
different behaviour) in :doc:`/userguide/package_discovery`.
* If the file ``pyproject.toml`` exists and it includes project
metadata/config (via ``[project]`` table or ``[tool.setuptools]``),
a series of new behaviors that are not backward compatible may take place:
- The default value of ``include_package_data`` will be considered to be ``True``.
- Setuptools will attempt to validate the ``pyproject.toml`` file according
to PEP 621 specification.
- The values specified in ``pyproject.toml`` will take precedence over those
specified in ``setup.cfg`` or ``setup.py``.
Changes
^^^^^^^
* **[EXPERIMENTAL]** Added automatic discovery for ``py_modules`` and ``packages``
-- by :user:`abravalheri`.
Setuptools will try to find these values assuming that the package uses either
the *src-layout* (a ``src`` directory containing all the packages or modules),
the *flat-layout* (package directories directly under the project root),
or the *single-module* approach (an isolated Python file, directly under
the project root).
The automatic discovery will also respect layouts that are explicitly
configured using the ``package_dir`` option.
For backward-compatibility, this behavior will be observed **only if both**
``py_modules`` **and** ``packages`` **are not set**.
(**Note**: specifying ``ext_modules`` might also prevent auto-discover from
taking place)
If setuptools detects modules or packages that are not supposed to be in the
distribution, please manually set ``py_modules`` and ``packages`` in your
``setup.cfg`` or ``setup.py`` file.
If you are using a *flat-layout*, you can also consider switching to
*src-layout*.
* **[EXPERIMENTAL]** Added automatic configuration for the ``name`` metadata
-- by :user:`abravalheri`.
Setuptools will adopt the name of the top-level package (or module in the case
of single-module distributions), **only when** ``name`` **is not explicitly
provided**.
Please note that it is not possible to automatically derive a single name when
the distribution consists of multiple top-level packages or modules.
* Added vendored dependencies for :pypi:`tomli`, :pypi:`validate-pyproject`.
These dependencies are used to read ``pyproject.toml`` files and validate them.
* **[EXPERIMENTAL]** When using ``pyproject.toml`` metadata,
the default value of ``include_package_data`` is changed to ``True``.
* **[EXPERIMENTAL]** Add support for ``pyproject.toml`` configuration
(as introduced by :pep:`621`). Configuration parameters not covered by
standards are handled in the ``[tool.setuptools]`` sub-table.
In the future, existing ``setup.cfg`` configuration
may be automatically converted into the ``pyproject.toml`` equivalent before taking effect
(as proposed in 1688). Meanwhile users can use automated tools like
:pypi:`ini2toml` to help in the transition.
Please note that the legacy backend is not guaranteed to work with
``pyproject.toml`` configuration.
-- by :user:`abravalheri`
* Implicit namespaces (as introduced in :pep:`420`) are now considered by default
during :doc:`package discovery </userguide/package_discovery>`, when
``setuptools`` configuration and project metadata are added to the
``pyproject.toml`` file.
To disable this behaviour, use ``namespaces = False`` when explicitly setting
the ``[tool.setuptools.packages.find]`` section in ``pyproject.toml``.
This change is backwards compatible and does not affect the behaviour of
configuration done in ``setup.cfg`` or ``setup.py``.
* **[EXPERIMENTAL]** Added support for ``attr:`` and ``cmdclass`` configurations
in ``setup.cfg`` and ``pyproject.toml`` when ``package_dir`` is implicitly
found via auto-discovery.
* Postponed importing ``ctypes`` when hiding files on Windows.
This helps to prevent errors in systems that might not have ``libffi`` installed.
* Merge with pypa/distutils@267dbd25ac
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* Added initial documentation about configuring ``setuptools`` via ``pyproject.toml``
(using standard project metadata).
Misc
^^^^
* Refactored ``setuptools.config`` by separating configuration parsing (specific
to the configuration file format, e.g. ``setup.cfg``) and post-processing
(which includes directives such as ``file:`` that can be used across different
configuration formats).
v60.10.0
--------
Changes
^^^^^^^
* Deprecated upload_docs command, to be removed in the future.
* Use samefile from stdlib, supported on Windows since Python 3.2.
* Adopt nspektr (vendored) to implement Distribution._install_dependencies.
Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* Added documentation on using console_scripts from setup.py, which was previously only shown in setup.cfg -- by :user:`xhlulu`
* Added clarifications about ``MANIFEST.in``, that include links to PyPUG docs
and more prominent mentions to using a revision control system plugin as an
alternative.
* Removed mention to ``pkg_resources`` as the recommended way of accessing data
files, in favour of importlib.resources.
Additionally more emphasis was put on the fact that *package data files* reside
**inside** the *package directory* (and therefore should be *read-only*).
Misc
^^^^
* Added workaround for intermittent failures of backend tests on PyPy.
These tests now are marked with `XFAIL
<https://docs.pytest.org/en/stable/how-to/skipping.html>`_, instead of erroring
out directly.
* Improved configuration for :pypi:`rst-linker` (extension used to build the
changelog).
* Enhanced isolation of tests using virtual environments - PYTHONPATH is not leaking to spawned subprocesses -- by :user:`befeleme`
* Added options to provide a pre-built ``setuptools`` wheel or sdist for being
used during tests with virtual environments.
Paths for these pre-built distribution files can now be set via the environment
variables: ``PRE_BUILT_SETUPTOOLS_SDIST`` and ``PRE_BUILT_SETUPTOOLS_WHEEL``.
py-setuptools: updated to 60.9.3 v60.9.3 Misc * Repaired automated release process. v60.9.2 Misc * When loading distutils from the vendored copy, rewrite __name__ to ensure consistent importing from inside and out. v60.9.1 Misc * Prevent vendored importlib_metadata from loading distributions from older importlib_metadata. * Fixed issue where string-based entry points would be omitted. * Bump importlib_metadata to 4.11.1 addressing issue with parsing requirements in egg-info as found in PyPy. v60.9.0 Changes * In the build backend, allow single config settings to be supplied. * Removed workaround in distutils hack for get-pip now that pypa/get-pip#137 is closed. * Setuptools no longer relies on pkg_resources for entry point handling. * Bump vendored packaging to 21.3. * Removed bootstrap script.
py-setuptools: updated to 60.8.1 v60.8.1 Misc * When vendoring jaraco packages, ensure the namespace package is converted to a simple package to support zip importer. v60.8.0 Changes * Setuptools now vendors importlib_resources and importlib_metadata and jaraco.text. Setuptools no longer relies on pkg_resources for ensure_directory nor parse_requirements.
py-setuptools: updated to 60.7.1 v60.7.1 Misc Remove lorem_ipsum from jaraco.text when vendored.
py-setuptools: updated to 60.7.0 v60.7.0 ------- Changes * Vendored jaraco.text and use line processing from that library in pkg_resources. Misc * Avoid AttributeError in easy_install.create_home_path when sysconfig.get_config_vars values are not strings.
py-setuptools: updated to 60.6.0 v60.6.0 Changes * Merge with pypa/distutils@bb018f1ac3 including consolidated behavior in sysconfig.get_platform. * Don't include optional Home-page in metadata if no url is specified. * Merge with pypa/distutils@b53a824ec3 including improved support for lib directories on non-x64 Windows builds. Misc * Used Py3 syntax super().__init__() v60.5.4 Misc * Remove filtering of distutils warnings. * Suppress distutils replacement when building or testing CPython. v60.5.3 Misc * Honor sysconfig variables in easy_install. v60.5.2 Misc * In _distutils_hack, for get-pip, simulate existence of setuptools. v60.5.1 Misc * Correct support for Python 3 native loaders.
py-setuptools: updated to 60.5.0 v60.5.0 Changes * Set the .origin attribute of the distutils module to the module's __file__. v60.4.0 Changes * Removed requires sorting when installing wheels as an egg dir. * Fixed a bug that easy install incorrectly parsed Python 3.10 version string. * Fixed startup performance issue of Python interpreter due to imports of costly modules in _distutils_hack -- by :user:`tiran` Documentation changes * Added link to additional resources on packaging in Quickstart guide * "In-tree" Sphinx extension for "favicons" replaced with sphinx-favicon. * SVG images (logo, banners, ...) optimised with the help of the scour package. Misc * Added integration tests that focus on building and installing some packages in the Python ecosystem via pip -- by :user:`abravalheri` * Modified "vendoring" logic to keep license files. * Improved isolation for some tests that where inadvertently using the project root for builds, and therefore creating directories (e.g. build, dist, *.egg-info) that could interfere with the outcome of other tests -- by :user:`abravalheri`. * Introduced new test fixtures venv, venv_without_setuptools, bare_venv that rely on the jaraco.envs package. These new test fixtures were also used to remove the (currently problematic) dependency on the pytest_virtualenv plugin. * Removed tmp_src test fixture. Previously this fixture was copying all the files and folders under the project root, including the .git directory, which is error prone and increases testing time. Since tmp_src was used to populate virtual environments (installing the version of setuptools under test via the source tree), it was replaced by the new setuptools_sdist and setuptools_wheel fixtures (that are build only once per session testing and can be shared between all the workers for read-only usage).
py-setuptools*: convert to egg.mk
py-setuptools: updated to 60.3.1 v60.3.1 Misc Suppress AttributeError when detecting get-pip. v60.3.0 Changes In _distutils_hack, bypass the distutils exception for pip when get-pip is being invoked, because it imports setuptools. Misc Merge with pypa/distutils@788cc159. Includes fix for config vars missing from sysconfig.
py-setuptools: update to 60.2.0. v60.2.0 ------- Changes ^^^^^^^ * #2974: Setuptools now relies on the Python logging infrastructure to log messages. Instead of using ``distutils.log.*``, use ``logging.getLogger(name).*``. * #2987: Sync with pypa/distutils@2def21c5d74fdd2fe7996ee4030ac145a9d751bd, including fix for missing get_versions attribute (#2969), more reliance on sysconfig from stdlib. Misc ^^^^ * #2962: Avoid attempting to use local distutils when the presiding version of Setuptools on the path doesn't have one. * #2983: Restore 'add_shim' as the way to invoke the hook. Avoids compatibility issues between different versions of Setuptools with the distutils local implementation. v60.1.1 ------- Misc ^^^^ * #2980: Bypass distutils loader when setuptools module is no longer available on sys.path. v60.1.0 ------- Changes ^^^^^^^ * #2958: In distutils_hack, only add the metadata finder once. In ensure_local_distutils, rely on a context manager for reliable manipulation. * #2963: Merge with pypa/distutils@a5af364910. Includes revisited fix for pypa/distutils#15 and improved MinGW/Cygwin support from pypa/distutils#77. v60.0.5 ------- Misc ^^^^ * #2960: Install schemes fall back to default scheme for headers. v60.0.4 ------- Misc ^^^^ * #2954: Merge with pypa/distutils@eba2bcd310. Adds platsubdir to config vars available for substitution. v60.0.3 ------- Misc ^^^^ * #2940: Avoid KeyError in distutils hack when pip is imported during ensurepip. v60.0.2 ------- Misc ^^^^ * #2938: Select 'posix_user' for the scheme unless falling back to stdlib, then use 'unix_user'. v60.0.1 ------- Misc ^^^^ * #2944: Add support for extended install schemes in easy_install. v60.0.0 ------- Breaking Changes ^^^^^^^^^^^^^^^^ * #2896: Setuptools once again makes its local copy of distutils the default. To override, set SETUPTOOLS_USE_DISTUTILS=stdlib. v59.8.0 ------- Changes ^^^^^^^ * #2935: Merge pypa/distutils@460b59f0e68dba17e2465e8dd421bbc14b994d1f. v59.7.0 ------- Changes ^^^^^^^ * #2930: Require Python 3.7
py-setuptools: update to 59.2.0. v59.2.0 ------- Changes ^^^^^^^ * #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. v59.1.1 ------- Misc ^^^^ * #2885: Fixed errors when encountering LegacyVersions. v59.1.0 ------- Changes ^^^^^^^ * #2497: Update packaging to 21.2. * #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. * #2879: Bump packaging to 21.2. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * #2867: PNG/ICO images replaced with SVG in the docs. * #2867: Added support to SVG "favicons" via "in-tree" Sphinx extension. v59.0.1 ------- Misc ^^^^ * #2880: Removed URL requirement for ``pytest-virtualenv`` in ``setup.cfg``. PyPI rejects packages with dependencies external to itself. Instead the test dependency was overwritten via ``tox.ini`` v59.0.0 ------- Deprecations ^^^^^^^^^^^^ * #2856: Support for custom commands that inherit directly from ``distutils`` is **deprecated**. Users should extend classes provided by setuptools instead. Breaking Changes ^^^^^^^^^^^^^^^^ * #2870: Started failing on invalid inline description with line breaks :class:`ValueError` -- by :user:`webknjaz` Changes ^^^^^^^ * #2698: Exposed exception classes from ``distutils.errors`` via ``setuptools.errors``. * #2866: Incorporate changes from pypa/distutils@f1b0a2b. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * #2227: Added sphinx theme customisations to display the new logo in the sidebar and use its colours as "accent" in the documentation -- by :user:`abravalheri` * #2227: Added new setuptools logo, including editable files and artwork documentation -- by :user:`abravalheri` * #2698: Added mentions to ``setuptools.errors`` as a way of handling custom command errors. * #2698: Added instructions to migrate from ``distutils.commands`` and ``distutils.errors`` in the porting guide. * #2871: Added a note to the docs that it is possible to install ``setup.py``-less projects in editable mode with :doc:`pip v21.1+ <pip:index>`, only having ``setup.cfg`` and ``pyproject.toml`` in project root -- by :user:`webknjaz` v58.5.3 ------- Misc ^^^^ * #2849: Add fallback for custom ``build_py`` commands inheriting directly from :mod:`distutils`, while still handling ``include_package_data=True`` for ``sdist``. v58.5.2 ------- Misc ^^^^ * #2847: Suppress 'setup.py install' warning under bdist_wheel. v58.5.1 ------- Misc ^^^^ * #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. v58.5.0 ------- Changes ^^^^^^^ * #1461: Fix inconsistency with ``include_package_data`` and ``packages_data`` in sdist by replacing the loop breaking mechanism between the ``sdist`` and ``egg_info`` commands -- by :user:`abravalheri` v58.4.0 ------- Changes ^^^^^^^ * #2497: Officially deprecated PEP 440 non-compliant versions. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * #2832: Removed the deprecated ``data_files`` option from the example in the declarative configuration docs -- by :user:`abravalheri` * #2832: Change type of ``data_files`` option from ``dict`` to ``section`` in declarative configuration docs (to match previous example) -- by :user:`abravalheri` v58.3.0 ------- Changes ^^^^^^^ * #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. * #1988: Deprecated the ``bdist_rpm`` command. Binary packages should be built as wheels instead. -- by :user:`hugovk` * #2785: Replace ``configparser``'s ``readfp`` with ``read_file``, deprecated since Python 3.2. -- by :user:`hugovk` * #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. Misc ^^^^ * #2762: Changed codecov.yml to configure the threshold to be lower -- by :user:`tanvimoharir` v58.2.0 ------- Changes ^^^^^^^ * #2757: Add windows arm64 launchers for scripts generated by easy_install. * #2800: Added ``--owner`` and ``--group`` options to the ``sdist`` command, for specifying file ownership within the produced tarball (similarly to the corresponding distutils ``sdist`` options). Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * #2792: Document how the legacy and non-legacy versions are compared, and reference to the `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_ scheme. v58.1.0 ------- Changes ^^^^^^^ * #2796: Merge with pypa/distutils@02e9f65ab0 v58.0.4 ------- Misc ^^^^ * #2773: Retain case in setup.cfg during sdist. v58.0.3 ------- Misc ^^^^ * #2777: Build does not fail fast when ``use_2to3`` is supplied but set to a false value. v58.0.2 ------- Misc ^^^^ * #2769: Build now fails fast when ``use_2to3`` is supplied. v58.0.1 ------- Misc ^^^^ * #2765: In Distribution.finalize_options, suppress known removed entry points to avoid issues with older Setuptools. v58.0.0 ------- Breaking Changes ^^^^^^^^^^^^^^^^ * #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. Documentation changes ^^^^^^^^^^^^^^^^^^^^^ * #2746: add python_requires example
py-setuptools: updated to 57.1.0 v57.1.0 Changes * Globs are now sorted in 'license_files' restoring reproducibility by eliminating variance from disk order. * Update to distutils at pypa/distutils@e2627b7. * Removed reliance on deprecated ssl.match_hostname by removing the ssl support. Now any index operations rely on the native SSL implementation. Documentation changes * Revamped the backward/cross tool compatibility section to remove some confusion. Add some examples and the version since when entry_points are supported in declarative configuration. Tried to make the reading flow a bit leaner, gather some informations that were a bit dispersed.
py-setuptools: updated to 57.0.0 v57.0.0 ------- Breaking Changes * License files excluded via the ``MANIFEST.in`` but matched by either the ``license_file`` (deprecated) or ``license_files`` options, will be nevertheless included in the source distribution. - by :user:`cdce8p` Changes * Write long description in message payload of PKG-INFO file. - by :user:`cdce8p` * Added ``License-File`` (multiple) to the output package metadata. The field will contain the path of a license file, matched by the ``license_file`` (deprecated) and ``license_files`` options, relative to ``.dist-info``. - by :user:`cdce8p` * Moved Setuptools' own entry points into declarative config. * Vendored `more_itertools <https://pypi.org/project/more-itertools>`_ for Setuptools. * Setuptools own setup.py no longer declares setup_requires, but instead expects wheel to be installed as declared by pyproject.toml. Misc * Updated the docs build tooling to support the latest version of Towncrier and show the previews of not-yet-released setuptools versions in the changelog -- :user:`webknjaz` v56.2.0 ------- Changes * Fixed handling of multiline license strings. - by :user:`cdce8p` * Setuptools will now always try to use the latest supported metadata version for ``PKG-INFO``. - by :user:`cdce8p` v56.1.0 ------- Changes * Incorporated assorted changes from pypa/distutils. * Adopted docs from distutils. * Added Visual Studio Express 2017 support -- by :user:`dofuuz` Misc * Fixed ``DeprecationWarning`` due to ``threading.Thread.setDaemon`` in tests -- by :user:`tirkarthi` * Made the changelog generator compatible with Towncrier >= 19.9 -- :user:`webknjaz` * Relax the deprecation message in the distutils hack.
py-setuptools: updated to 56.0.0 v56.0.0 Deprecations * The license_file option is now marked as deprecated. Use license_files instead. Breaking Changes * If neither license_file nor license_files is specified, the sdist option will now auto-include files that match the following patterns: LICEN[CS]E*, COPYING*, NOTICE*, AUTHORS*. This matches the behavior of bdist_wheel. Changes * The license_file and license_files options now support glob patterns. * Implemented VendorImporter.find_spec() method to get rid of ImportWarning that Python 3.10 emits when only the old-style importer hooks are present Documentation changes * Added documentation for the license_files option. v55.0.0 Breaking Changes * Remove the deprecated bdist_wininst command. Binary packages should be built as wheels instead.
py-setuptools: updated to 54.2.0 v54.1.2 Misc * Reduced scope of dash deprecation warning to Setuptools/distutils only -- by :user:`melissa-kun-li` v54.1.1 Documentation changes * Added sphinx-inline-tabs extension to allow for comparison of setup.py and its equivalent setup.cfg -- by :user:`amy-lei` Misc * Made option keys in the [metadata] section of setup.cfg case-sensitive. Users having uppercase option spellings will get a warning suggesting to make them to lowercase -- by :user:`melissa-kun-li` v54.1.0 Changes * Removed the conversion of dashes to underscores in the extras_require and data_files of 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` v54.0.0 Breaking Changes * 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. Changes * Handled AttributeError by raising DistutilsSetupError in dist.check_specifier() when specifier is not a string -- by :user:`melissa-kun-li` * Correctly parse cmdclass in setup.cfg. Documentation changes * Added userguide example for markers in extras_require -- by :user:`pwoolvett` v53.1.0 Changes * 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` * Fixed error in uploading a Sphinx doc with the upload_docs command. An html builder will be used. Note: upload_docs is deprecated for PyPi, but is supported for other sites -- by :user:`melissa-kun-li` v53.0.0 Breaking Changes * 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. v52.0.0 Breaking Changes * Remove fallback support for fetch_build_eggs using easy_install. Now pip is required for setup_requires to succeed. * Removed 'easy_install' top-level model (runpy entry point) and 'easy_install' console script. * Removed support for eggsecutables. Changes * 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.
py-setuptools: updated to 51.3.3 v51.3.3 Misc * Fix AttributeError in Description validation. v51.3.2 Misc * Validation of Description field now is more lenient, emitting a warning and mangling the value to be valid (replacing newlines with spaces). v51.3.1 Misc * Reverted tag deduplication handling. v51.3.0 Changes * Newlines in metadata description/Summary now trigger a ValueError. * Define create_module() and exec_module() methods in VendorImporter to get rid of ImportWarning -- by :user:`hroncok` * pkg_resources behavior for zipimport now matches the regular behavior, and finds .egg-info (previoulsy would only find .dist-info) -- by :user:`thatch` * Fixed an issue where version tags may be added multiple times v51.2.0 Changes * Use importlib.import_module() rather than the deprectated loader.load_module() in pkg_resources namespace delaration -- by :user:`encukou` Documentation changes * Fix typo in the document page about entry point. -- by :user:`jtr109` Misc * Avoid hitting network during test_easy_install. v51.1.2 Misc * Disable inclusion of package data as it causes 'tests' to be included as data. v51.1.1 Misc * Avoid hitting network during test_virtualenv.test_test_command. v51.1.0 Changes * Project adopts jaraco/skeleton for shared package maintenance. Misc * Restore inclusion of rst files in sdist. * Setuptools has replaced the master branch with the main branch. * Fixed failing test when pip 20.3+ is present. -- by :user:`yan12125` * Fix tests with pytest 6.2 -- by :user:`yan12125` v51.0.0 Breaking Changes * Require Python 3.6 or later. Documentation changes * Fixed inconsistent RST title nesting levels caused * Fixed a typo in Sphinx docs that made docs dev section disappear Misc * Removed the tests that guarantee that the vendored dependencies can be built by distutils.
py-setuptools: Update to 50.2.0
* It seems that this fixes PLIST divergence of some packages,
including py-libxml2 and py-cElementTree.
Changelog:
v50.2.0
#2355: When pip is imported as part of a build, leave distutils patched.
#2380: There are some setuptools specific changes in the setuptools.command.bdist_rpm module that are no longer needed, because they are part of the bdist_rpm module in distutils in Python 3.5.0. Therefore, code was removed from setuptools.command.bdist_rpm.
v50.1.0
#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.
v50.0.3
#2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils#9).
v50.0.2
#2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876.
py-setuptools: update to 50.0.1. Please note the change in 50.0.0: "Setuptools overrides the stdlib distutils on import" and the workaround: "If the environment variable ``SETUPTOOLS_USE_DISTUTILS`` is set to ``stdlib``, Setuptools will fall back to the legacy behavior." v50.0.1 ------- * #2357: Restored Python 3.5 support in distutils.util for missing `subprocess._optim_args_from_interpreter_flags`. * #2358: Restored AIX support on Python 3.8 and earlier. * #2361: Add Python 3.10 support to _distutils_hack. Get the 'Loader' abstract class from importlib.abc rather than importlib.util.abc (alias removed in Python 3.10). v50.0.0 ------- * #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. * #2334: In MSVC module, refine text in error message. v49.6.0 ------- * #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. v49.5.0 ------- * #2306: When running as a PEP 517 backend, setuptools does not try to install ``setup_requires`` itself. They are reported as build requirements for the frontend to install. v49.4.0 ------- * #2310: Updated vendored packaging version to 20.4. v49.3.2 ------- * #2300: Improve the ``safe_version`` function documentation * #2297: Once again, in stubs prefer exec_module to the deprecated load_module. v49.3.1 ------- * #2316: Removed warning when ``distutils`` is imported before ``setuptools`` when ``distutils`` replacement is not enabled. v49.3.0 ------- * #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. v49.2.1 ------- * #2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn. v49.2.0 ------- * #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. v49.1.3 ------- * #2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state. * #2249: Fix extension loading technique in stubs. v49.1.2 ------- * #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. v49.1.1 ------- * #2094: Removed pkg_resources.py2_warn module, which is no longer reachable. v49.0.1 ------- * #2228: Applied fix for pypa/distutils#3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file. v49.1.0 ------- * #2228: Disabled distutils adoption for now while emergent issues are addressed. v49.0.0 ------- * #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. * #2137: Removed (private) pkg_resources.RequirementParseError, now replaced by packaging.requirements.InvalidRequirement. Kept the name for compatibility, but users should catch InvalidRequirement instead. * #2180: Update vendored packaging in pkg_resources to 19.2. * #2199: Fix exception causes all over the codebase by using ``raise new_exception from old_exception``
py-setuptools: update to 47.3.2. v47.3.2 ------- * #2071: Replaced references to the deprecated imp package with references to importlib v47.3.1 ------- * #1973: Removed ``pkg_resources.py31compat.makedirs`` in favor of the stdlib. Use ``os.makedirs()`` instead. * #2198: Restore ``__requires__`` directive in easy-install wrapper scripts. v47.3.0 ------- * #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. * #2195: Fix broken entry points generated by easy-install (pip editable installs). v47.2.0 ------- * #2194: Editable-installed entry points now load significantly faster on Python versions 3.8+. v47.1.1 ------- * #2156: Update mailing list pointer in developer docs Incorporate changes from v44.1.1: * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0. v44.1.1 ------- * #2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0. v47.1.0 ------- * #2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages. v47.0.0 ------- * #2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should use ``setuptools<45``. * #1700: Document all supported keywords by migrating the ones from distutils. v46.4.0 ------- * #1753: ``attr:`` now extracts variables through rudimentary examination of the AST, thereby supporting modules with third-party imports. If examining the AST fails to find the variable, ``attr:`` falls back to the old behavior of importing the module. Works on Python 3 only. v46.3.1 ------- No significant changes. v46.3.0 ------- * #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. * #2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards. * #2105: Filter ``2to3`` deprecation warnings from ``TestDevelop.test_2to3_user_mode``. v46.2.0 ------- * #2040: Deprecated the ``bdist_wininst`` command. Binary packages should be built as wheels instead. * #2062: Change 'Mac OS X' to 'macOS' in code. * #2075: Stop recognizing files ending with ``.dist-info`` as distribution metadata. * #2086: Deprecate 'use_2to3' functionality. Packagers are encouraged to use single-source solutions or build tool chains to manage conversions outside of setuptools. * #1698: Added documentation for ``build_meta`` (a bare minimum, not completed). * #2082: Filter ``lib2to3`` ``PendingDeprecationWarning`` and ``DeprecationWarning`` in tests, because ``lib2to3`` is `deprecated in Python 3.9 <https://bugs.python.org/issue40360>`_. v46.1.3 ------- No significant changes. v46.1.2 ------- * #1458: Added template for reporting Python 2 incompatibilities. v46.1.1 ------- No significant changes. v46.1.0 ------- * #308: Allow version number normalization to be bypassed by wrapping in a 'setuptools.sic()' call. * #1424: Prevent keeping files mode for package_data build. It may break a build if user's package data has read only flag. * #1431: In ``easy_install.check_site_dir``, ensure the installation directory exists. * #1563: In ``pkg_resources`` prefer ``find_spec`` (PEP 451) to ``find_module``. Incorporate changes from v44.1.0: * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__ * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2 * #1994: Fixed a bug in the "setuptools.finalize_distribution_options" hook that lead to ignoring the order attribute of entry points managed by this hook. v44.1.0 ------- * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__ * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2 * #1994: Fixed a bug in the "setuptools.finalize_distribution_options" hook that lead to ignoring the order attribute of entry points managed by this hook. v46.0.0 ------- * #65: Once again as in 3.0, removed the Features feature. * #1890: Fix vendored dependencies so importing ``setuptools.extern.some_module`` gives the same object as ``setuptools._vendor.some_module``. This makes Metadata picklable again. * #1899: Test suite now fails on warnings. * #2011: Fix broken link to distutils docs on package_data * #1991: Include pkg_resources test data in sdist, so tests can be executed from it. v45.3.0 ------- * #1557: Deprecated eggsecutable scripts and updated docs. * #1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+ v45.2.0 ------- * #1905: Fixed defect in _imp, introduced in 41.6.0 when the 'tests' directory is not present. * #1941: Improve editable installs with PEP 518 build isolation: * The ``--user`` option is now always available. A warning is issued if the user site directory is not available. * The error shown when the install directory is not in ``PYTHONPATH`` has been turned into a warning. * #1981: Setuptools now declares its ``tests`` and ``docs`` dependencies in metadata (extras). * #1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9). * #1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info. v45.1.0 ------- * #1458: Add minimum sunset date and preamble to Python 2 warning. * #1704: Set sys.argv[0] in setup script run by build_meta.__legacy__ * #1974: Add Python 3 Only Trove Classifier and remove universal wheel declaration for more complete transition from Python 2. v45.0.0 ------- * #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. * #1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
py-setuptools: update to 42.0.1. v42.0.1 ------- * #1918: Fix regression in handling wheels compatibility tags. v42.0.0 ------- * #1830, #1909: Mark the easy_install script and setuptools command as deprecated, and use `pip <https://pip.pypa.io/en/stable/>`_ when available to fetch/build wheels for missing ``setup_requires``/``tests_require`` requirements, with the following differences in behavior: * support for ``python_requires`` * better support for wheels (proper handling of priority with respect to PEP 425 tags) * PEP 517/518 support * eggs are not supported * no support for the ``allow_hosts`` easy_install option (``index_url``/``find_links`` are still honored) * pip environment variables are honored (and take precedence over easy_install options) * #1898: Removed the "upload" and "register" commands in favor of `twine <https://pypi.org/p/twine>`_. * #1767: Add support for the ``license_files`` option in ``setup.cfg`` to automatically include multiple license files in a source distribution. * #1829: Update handling of wheels compatibility tags: * add support for manylinux2010 * fix use of removed 'm' ABI flag in Python 3.8 on Windows * #1861: Fix empty namespace package installation from wheel. * #1877: Setuptools now exposes a new entry point hook "setuptools.finalize_distribution_options", enabling plugins like `setuptools_scm <https://pypi.org/project/setuptools_scm>`_ to configure options on the distribution at finalization time.
py-setuptools: updated to 41.6.0 v41.6.0 * Replace usage of deprecated imp module with local re-implementation in setuptools._imp. v41.5.1 * Fix code for detecting Visual Studio's version on Windows under Python 2. v41.5.0 * Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019. * Fix pkg_resources.Requirement hash/equality implementation: take PEP 508 direct URL into account. * Fix tests when running under python3.10. * Formally deprecated the test command, with the recommendation that users migrate to tox. * Update documentation to mention the egg format is not supported by pip and dependency links support was dropped starting with pip 19.0. * Drop ez_setup documentation: deprecated for some time (last updated in 2016), and still relying on easy_install (deprecated too). * Drop most documentation references to (deprecated) EasyInstall. * Added a trove classifier to document support for Python 3.8. * Added Python 3.8 release to the Travis test matrix.
py-setuptools: updated to 41.4.0 v41.4.0 In declarative config, now traps errors when invalid python_requires values are supplied. v41.3.0 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+. Fixed failing integration test triggered by 'long_description_content_type' in packaging.
py-setuptools: updated to 40.7.0 v40.7.0 * File inputs for the license field in setup.cfg files now explicitly raise an error. * Add support for non-ASCII in setup.cfg. Add support for native strings on some parameters. * setuptools.package_index no longer relies on the deprecated urllib.parse.splituser per Python. * Added tests for PackageIndex.download (for git URLs). * In PEP 517 build_meta builder, ensure that sdists are built as gztar per the spec.
py-setuptools: updated to 40.6.1 v40.6.1 * Fixed regression where packages without author or author_email fields generated malformed package metadata. v40.6.0 * Officially deprecated the requires parameter in setup(). * 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. * Changed the warning class of all deprecation warnings; deprecation warning classes are no longer derived from DeprecationWarning and are thus visible by default. * build_meta.build_sdist now includes setup.py in source distributions by default. * 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. * Restricted the recursive-include setuptools/_vendor to contain only .py and .txt files. * Changed Pyrex references to Cython in the documentation. * Documented that the rpmbuild packages is required for the bdist_rpm command. * Documented how to use setup.cfg for src/ layouts * Added minimum version column in setup.cfg metadata table. * Fixed a minor typo in the python 2/3 compatibility documentation. * Updated installation instructions to point to pip install instead of ez_setup.py. * Updated setuptools distribution documentation to remove some outdated information. * Documented setup.cfg minimum version for version and project_urls. * Added the concurrent.futures backport futures to the Python 2.7 test suite requirements.
py-setuptools: updated to 39.0.1 v39.0.1 Restore Unicode handling for Maintainer fields in metadata. v39.0.0: Setuptools now vendors its own direct dependencies, no longer relying on the dependencies as vendored by pkg_resources. Removed long-deprecated support for iteration on Version objects as returned by pkg_resources.parse_version. Removed the SetuptoolsVersion and SetuptoolsLegacyVersion names as well. They should not have been used, but if they were, replace with Version and LegacyVersion from packaging.version. v38.7.0: Add support for maintainer in PKG-INFO.
py-setuptools: updated to 38.2.3 v38.2.2 fix handling of namespace packages when installing from a wheel. v38.2.1 fix encoding handling of metadata when installing from a wheel. v38.2.0 easy_install now support installing from wheels: they will be installed as standalone unzipped eggs.
py-setuptools: update to 38.1.0. v38.1.0 ------- * #1208: Improve error message when failing to locate scripts in egg-info metadata. v38.0.0 ------- * #458: In order to support deterministic builds, Setuptools no longer allows packages to declare ``install_requires`` as unordered sequences (sets or dicts). v37.0.0 ------- * #878: Drop support for Python 2.6. Python 2.6 users should rely on 'setuptools < 37dev'. v36.8.0 ------- * #1190: In SSL support for package index operations, use SNI where available. v36.7.3 ------- * #1175: Bug fixes to ``build_meta`` module.
py-setuptools: update to 36.6.0 v36.6.0: * Added setuptools.build_meta module, an implementation of PEP-517 for Setuptools-defined packages. * Added dist_info command for producing dist_info metadata.
v36.2.0 * 1081: Environment markers indicated in ``install_requires`` are now processed and treated as nameless ``extras_require`` with markers, allowing their metadata in requires.txt to be correctly generated. * 1053: Tagged commits are now released using Travis-CI build stages, meaning releases depend on passing tests on all supported Python versions (Linux) and not just the latest Python version.
Updated py-setuptools to 36.0.1. v36.0.1 ------- * #1042: Fix import in py27compat module that still referenced six directly, rather than through the externs module (vendored packages hook). v36.0.0 ------- * #980 and others: Once again, Setuptools vendors all of its dependencies. It seems to be the case that in the Python ecosystem, all build tools must run without any dependencies (build, runtime, or otherwise). At such a point that a mechanism exists that allows build tools to have dependencies, Setuptools will adopt it.
Updated py-setuptools to 34.1.1. v34.1.1 ------- * #953: More aggressively employ the compatibility issue originally added in #706. v34.1.0 ------- * #930: ``build_info`` now accepts two new parameters to optimize and customize the building of C libraries. v34.0.3 ------- * #947: Loosen restriction on the version of six required, restoring compatibility with environments relying on six 1.6.0 and later. v34.0.2 ------- * #882: Ensure extras are honored when building the working set. * #913: Fix issue in develop if package directory has a trailing slash. v34.0.1 ------- * #935: Fix glob syntax in graft. v34.0.0 ------- * #581: Instead of vendoring the growing list of dependencies that Setuptools requires to function, Setuptools now requires these dependencies just like any other project. Unlike other projects, however, Setuptools cannot rely on ``setup_requires`` to demand the dependencies it needs to install because its own machinery would be necessary to pull those dependencies if not present (a bootstrapping problem). As a result, Setuptools no longer supports self upgrade or installation in the general case. Instead, users are directed to use pip to install and upgrade using the ``wheel`` distributions of setuptools. Users are welcome to contrive other means to install or upgrade Setuptools using other means, such as pre-installing the Setuptools dependencies with pip or a bespoke bootstrap tool, but such usage is not recommended and is not supported. As discovered in #940, not all versions of pip will successfully install Setuptools from its pre-built wheel. If you encounter issues with "No module named six" or "No module named packaging", especially following a line "Running setup.py egg_info for package setuptools", then your pip is not new enough. There's an additional issue in pip where setuptools is upgraded concurrently with other source packages, described in pip #4253. The proposed workaround is to always upgrade Setuptools first prior to upgrading other packages that would upgrade Setuptools.
v33.1.1 ------- * 921: Correct issue where certifi fallback not being reached on Windows. v33.1.0 ------- Installation via pip, as indicated in the `Python Packaging User's Guide <https://packaging.python.org/installing/>`_, is the officially-supported mechanism for installing Setuptools, and this recommendation is now explicit in the much more concise README. Other edits and tweaks were made to the documentation. The codebase is unchanged. v33.0.0 ------- * 619: Removed support for the ``tag_svn_revision`` distribution option. If Subversion tagging support is still desired, consider adding the functionality to setuptools_svn in setuptools_svn 2.
Updated py-setuptools to 30.4.0. v30.4.0 ------- * #879: For declarative config: - read_configuration() now accepts ignore_option_errors argument. This allows scraping tools to read metadata without a need to download entire packages. E.g. we can gather some stats right from GitHub repos just by downloading setup.cfg. - packages find: directive now supports fine tuning from a subsection. The same arguments as for find() are accepted. v30.3.0 ------- * #394 via #862: Added support for `declarative package config in a setup.cfg file <http://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files>`_. v30.2.1 ------- * #850: In test command, invoke unittest.main with indication not to exit the process. v30.2.0 ------- * #854: Bump to vendored Packaging 16.8. v30.1.0 ------- * #846: Also trap 'socket.error' when opening URLs in package_index. * #849: Manifest processing now matches the filename pattern anywhere in the filename and not just at the start. Restores behavior found prior to 28.5.0. v30.0.0 ------- * #864: Drop support for Python 3.2. Systems requiring Python 3.2 support must use 'setuptools < 30'. * #825: Suppress warnings for single files. * #830 via #843: Once again restored inclusion of data files to sdists, but now trap TypeError caused by techniques employed rjsmin and similar.
Updated py-setuptools to 29.0.1. v29.0.1 ------- * #861: Re-release of v29.0.1 with the executable script launchers bundled. Now, launchers are included by default and users that want to disable this behavior must set the environment variable 'SETUPTOOLS_INSTALL_WINDOWS_SPECIFIC_FILES' to a false value like "false" or "0". v29.0.0 ------- * #841: Drop special exception for packages invoking win32com during the build/install process. See Distribute #118 for history.
Updated py-setuptools to 28.7.0. v28.7.0 ------- * #832: Moved much of the namespace package handling functionality into a separate module for re-use in something like #789. * #830: ``sdist`` command no longer suppresses the inclusion of data files, re-aligning with the expectation of distutils and addressing #274 and #521. v28.6.1 ------- * #816: Fix manifest file list order in tests.
Updated py-setuptools to 28.5.0. v28.5.0 ------- * #810: Tests are now invoked with tox and not setup.py test. * #249 and #450 via #764: Avoid scanning the whole tree when building the manifest. v28.4.0 ------- * #732: Now extras with a hyphen are honored per PEP 426. * #811: Update to pyparsing 2.1.10. * Updated ``setuptools.command.sdist`` to re-use most of the functionality directly from ``distutils.command.sdist`` for the ``add_defaults`` method with strategic overrides. See #750 for rationale. * #760 via #762: Look for certificate bundle where SUSE Linux typically presents it. Use ``certifi.where()`` to locate the bundle.
Updated py-setuptools to 27.1.2.
v27.1.2
-------
* #779 via #781: Fix circular import.
v27.1.1
-------
* #778: Fix MSVC monkeypatching.
v27.1.0
-------
* Introduce the (private) ``monkey`` module to encapsulate
the distutils monkeypatching behavior.
v27.0.0
-------
* Now use Warehouse by default for
``upload``, patching ``distutils.config.PyPIRCCommand`` to
affect default behavior.
Any config in .pypirc should be updated to replace
https://pypi.python.org/pypi/
with
https://upload.pypi.org/legacy/
Similarly, any passwords stored in the keyring should be
updated to use this new value for "system".
The ``upload_docs`` command will continue to use the python.org
site, but the command is now deprecated. Users are urged to use
Read The Docs instead.
* #776: Use EXT_SUFFIX for py_limited_api renaming.
* #774 and #775: Use LegacyVersion from packaging when
detecting numpy versions.
Updated py-setuptools to 26.1.1. v26.1.1 ------- * Re-release of 26.1.0 with pytest pinned to allow for automated deployement and thus proper packaging environment variables, fixing issues with missing executable launchers. v26.1.0 ------- * #763: ``pkg_resources.get_default_cache`` now defers to the `appdirs project <https://pypi.org/project/appdirs>`_ to resolve the cache directory. Adds a vendored dependency on appdirs to pkg_resources.
Updated py-setuptools to 24.0.0. v24.0.0 ------- * Pull Request #174: Add more aggressive support for Windows SDK in msvc9compiler patch. * Renamed ``setuptools.msvc9_support`` to ``setuptools.msvc``. v23.2.1 ------- Re-release of v23.2.0, which was missing the intended commits. * #623: Remove used of deprecated 'U' flag when reading manifests.
Update py-setuptools to 20.2.2.
20.2.2
------
* Issue #502: Correct regression in parsing of multiple
version specifiers separated by commas and spaces.
20.2.1
------
* Issue #499: Restore compatiblity for legacy versions
by bumping to packaging 16.4.
20.2
----
* Changelog now includes release dates and links to PEPs.
* Pull Request #173: Replace dual PEP 345 _markerlib implementation
and PEP 426 implementation of environment marker support from
packaging 16.1 and PEP 508. Fixes Issue #122.
See also Pull Request #175, Pull Request #168, and
Pull Request #164. Additionally:
- ``Requirement.parse`` no longer retains the order of extras.
- ``parse_requirements`` now requires that all versions be
PEP-440 compliant, as revealed in #499. Packages released
with invalid local versions should be re-released using
the proper local version syntax, e.g. ``mypkg-1.0+myorg.1``.
Update py-setuptools to 20.1.1. 20.1.1 ------ * Update ``upload_docs`` command to also honor keyring for password resolution. 20.1 ---- * Added support for using passwords from keyring in the upload command. See `the upload docs <http://pythonhosted.org/setuptools/setuptools.html#upload-upload-source-and-or-egg-distributions-to-pypi>`_ for details. 20.0 ---- * Issue #118: Once again omit the package metadata (egg-info) from the list of outputs in ``--record``. This version of setuptools can no longer be used to upgrade pip earlier than 6.0.
Update py-setuptools to 19.6.1. All self-tests pass.
19.6.1
------
* Restore compatibility for PyPy 3 compatibility lost in
19.4.1 addressing Issue #487.
* ``setuptools.launch`` shim now loads scripts in a new
namespace, avoiding getting relative imports from
the setuptools package on Python 2.
19.6
----
* Added a new entry script ``setuptools.launch``,
implementing the shim found in
``pip.util.setuptools_build``. Use this command to launch
distutils-only packages under setuptools in the same way that
pip does, causing the setuptools monkeypatching of distutils
to be invoked prior to invoking a script. Useful for debugging
or otherwise installing a distutils-only package under
setuptools when pip isn't available or otherwise does not
expose the desired functionality. For example::
$ python -m setuptools.launch setup.py develop
* Issue #488: Fix dual manifestation of Extension class in
extension packages installed as dependencies when Cython
is present.
19.5
----
* Issue #486: Correct TypeError when getfilesystemencoding
returns None.
* Issue #139: Clarified the license as MIT.
* Pull Request #169: Removed special handling of command
spec in scripts for Jython.
19.4.1
------
* Issue #487: Use direct invocation of ``importlib.machinery``
in ``pkg_resources`` to avoid missing detection on relevant
platforms.
Update py-setuptools to 19.4: 19.4 ---- * Issue #341: Correct error in path handling of package data files in ``build_py`` command when package is empty. * Distribute #323, Issue #141, Issue #207, and Pull Request #167: Another implementation of ``pkg_resources.WorkingSet`` and ``pkg_resources.Distribution`` that supports replacing an extant package with a new one, allowing for setup_requires dependencies to supersede installed packages for the session. ---- 19.3 ---- * Issue #229: Implement new technique for readily incorporating dependencies conditionally from vendored copies or primary locations. Adds a new dependency on six.
Update to 16.0: ---- 16.0 ---- * Pull Request #130: Better error messages for errors in parsed requirements. * Pull Request #133: Removed ``setuptools.tests`` from the installed packages.
Update to 11.3.1:
------
11.3.1
------
* Issue #327: Formalize and restore support for any printable character in an
entry point name.
----
11.3
----
* Expose ``EntryPoint.resolve`` in place of EntryPoint._load, implementing the
simple, non-requiring load. Deprecated all uses of ``EntryPoint._load``
except for calling with no parameters, which is just a shortcut for
``ep.require(); ep.resolve();``.
Apps currently invoking ``ep.load(require=False)`` should instead do the
following if wanting to avoid the deprecating warning::
getattr(ep, "resolve", lambda: ep.load(require=False))()
----
11.2
----
* Pip #2326: Report deprecation warning at stacklevel 2 for easier diagnosis.
----
11.1
----
* Issue #281: Since Setuptools 6.1 (Issue #268), a ValueError would be raised
in certain cases where VersionConflict was raised with two arguments, which
occurred in ``pkg_resources.WorkingSet.find``. This release adds support
for indicating the dependent packages while maintaining support for
a VersionConflict when no dependent package context is known. New unit tests
now capture the expected interface.
Update to 11.0: ---- 11.0 ---- * Interop #3: Upgrade to Packaging 15.0; updates to PEP 440 so that >1.7 does not exclude 1.7.1 but does exclude 1.7.0 and 1.7.0.post1. ------ 10.2.1 ------ * Issue #323: Fix regression in entry point name parsing. ---- 10.2 ---- * Deprecated use of EntryPoint.load(require=False). * Substantial refactoring of all unit tests. Tests are now much leaner and re-use a lot of fixtures and contexts for better clarity of purpose. ---- 10.1 ---- * Issue #320: Added a compatibility implementation of ``sdist._default_revctrl`` so that systems relying on that interface do not fail (namely, Ubuntu 12.04 and similar Debian releases). ------ 10.0.1 ------ * Issue #319: Fixed issue installing pure distutils packages. ---- 10.0 ---- * Issue #313: Removed built-in support for subversion. Projects wishing to retain support for subversion will need to use a third party library. The extant implementation is being ported to `setuptools_svn <https://pypi.python.org/pypi/setuptools_svn>`_. * Issue #315: Updated setuptools to hide its own loaded modules during installation of another package. This change will enable setuptools to upgrade (or downgrade) itself even when its own metadata and implementation change. --- 9.1 --- * Prefer vendored packaging library `as recommended <https://github.com/jaraco/setuptools/commit/170657b68f4b92e7e1bf82f5e19a831f5744af67#commitcomment-9109448>`_. ----- 9.0.1 ----- * Issue #312: Restored presence of pkg_resources API tests (doctest) to sdist. --- 9.0 --- * Issue #314: Disabled support for ``setup_requires`` metadata to avoid issue where Setuptools was unable to upgrade over earlier versions. --- 8.4 --- * Pull Request #106: Now write ``setup_requires`` metadata.
Update to 8.3: --- 8.3 --- * Issue #311: Decoupled pkg_resources from setuptools once again. ``pkg_resources`` is now a package instead of a module. ----- 8.2.1 ----- * Issue #306: Suppress warnings about Version format except in select scenarios (such as installation). --- 8.2 --- * Pull Request #85: Search egg-base when adding egg-info to manifest. --- 8.1 --- * Upgrade ``packaging`` to 14.5, giving preference to "rc" as designator for release candidates over "c". * PEP-440 warnings are now raised as their own class, ``pkg_resources.PEP440Warning``, instead of RuntimeWarning. * Disabled warnings on empty versions. ----- 8.0.4 ----- * Upgrade ``packaging`` to 14.4, fixing an error where there is a different result for if 2.0.5 is contained within >2.0dev and >2.0.dev even though normalization rules should have made them equal. * Issue #296: Add warning when a version is parsed as legacy. This warning will make it easier for developers to recognize deprecated version numbers. ----- 8.0.3 ----- * Issue #296: Restored support for ``__hash__`` on parse_version results. ----- 8.0.2 ----- * Issue #296: Restored support for ``__getitem__`` and sort operations on parse_version result.
Update to 8.0.1: ----- 8.0.1 ----- * Issue #296: Restore support for iteration over parse_version result, but deprecated that usage with a warning. Fixes failure with buildout. --- 8.0 --- * Implement `PEP 440 <http://legacy.python.org/dev/peps/pep-0440/>`_ within pkg_resources and setuptools. This change deprecates some version numbers such that they will no longer be installable without using the ``===`` escape hatch. See `the changes to test_resources <https://bitbucket.org/pypa/setuptools/commits/dcd552da643c4448056de84c73d56da6d70769d5#chg-setuptools/tests/test_resources.py>`_ for specific examples of version numbers and specifiers that are no longer supported. Setuptools now "vendors" the `packaging <https://github.com/pypa/packaging>`_ library.
Update to 7.0: 7.0 --- * Issue #80, Issue #209: Eggs that are downloaded for ``setup_requires``, ``test_requires``, etc. are now placed in a ``./.eggs`` directory instead of directly in the current directory. This choice of location means the files can be readily managed (removed, ignored). Additionally, later phases or invocations of setuptools will not detect the package as already installed and ignore it for permanent install (See #209). This change is indicated as backward-incompatible as installations that depend on the installation in the current directory will need to account for the new location. Systems that ignore ``*.egg`` will probably need to be adapted to ignore ``.eggs``. The files will need to be manually moved or will be retrieved again. Most use cases will require no attention.
Update to 6.0.2:
-----
6.0.2
-----
* Issue #262: Fixed regression in pip install due to egg-info directories
being omitted. Re-opens Issue #118.
-----
6.0.1
-----
* Issue #259: Fixed regression with namespace package handling on ``single
version, externally managed`` installs.
---
6.0
---
* Issue #100: When building a distribution, Setuptools will no longer match
default files using platform-dependent case sensitivity, but rather will
only match the files if their case matches exactly. As a result, on Windows
and other case-insensitive file systems, files with names such as
'readme.txt' or 'README.TXT' will be omitted from the distribution and a
warning will be issued indicating that 'README.txt' was not found. Other
filenames affected are:
- README.rst
- README
- setup.cfg
- setup.py (or the script name)
- test/test*.py
Any users producing distributions with filenames that match those above
case-insensitively, but not case-sensitively, should rename those files in
their repository for better portability.
* Pull Request #72: When using ``single_version_externally_managed``, the
exclusion list now includes Python 3.2 ``__pycache__`` entries.
* Pull Request #76 and Pull Request #78: lines in top_level.txt are now
ordered deterministically.
* Issue #118: The egg-info directory is now no longer included in the list
of outputs.
* Issue #258: Setuptools now patches distutils msvc9compiler to
recognize the specially-packaged compiler package for easy extension module
support on Python 2.6, 2.7, and 3.2.
---
5.8
---
* Issue #237: ``pkg_resources`` now uses explicit detection of Python 2 vs.
Python 3, supporting environments where builtins have been patched to make
Python 3 look more like Python 2.
Update to 5.4.1: ----- 5.4.1 ----- * Python #7776: (ssl_support) Correct usage of host for validation when tunneling for HTTPS. --- 5.4 --- * Issue #154: ``pkg_resources`` will now cache the zip manifests rather than re-processing the same file from disk multiple times, but only if the environment variable ``PKG_RESOURCES_CACHE_ZIP_MANIFESTS`` is set. Clients that package many modules in the same zip file will see some improvement in startup time by enabling this feature. This feature is not enabled by default because it causes a substantial increase in memory usage. --- 5.3 --- * Issue #185: Make svn tagging work on the new style SVN metadata. Thanks cazabon! * Prune revision control directories (e.g .svn) from base path as well as sub-directories. --- 5.2 --- * Added a `Developer Guide <https://pythonhosted.org/setuptools/developer-guide.html>`_ to the official documentation. * Some code refactoring and cleanup was done with no intended behavioral changes. * During install_egg_info, the generated lines for namespace package .pth files are now processed even during a dry run. --- 5.1 --- * Issue #202: Implemented more robust cache invalidation for the ZipImporter, building on the work in Issue #168. Special thanks to Jurko Gospodnetic and PJE. ----- 5.0.2 ----- * Issue #220: Restored script templates.
Update to 5.0.1: ----- 5.0.1 ----- * Renamed script templates to end with .tmpl now that they no longer need to be processed by 2to3. Fixes spurious syntax errors during build/install. --- 5.0 --- * Issue #218: Re-release of 3.8.1 to signal that it supersedes 4.x.
Update to 4.0.1: --------------- 3.7.1 and 4.0.1 --------------- * Issue #213: Use legacy StringIO behavior for compatibility under pbr. --- 4.0 --- * Issue #210: ``setup.py develop`` now copies scripts in binary mode rather than text mode, matching the behavior of the ``install`` command. --- 3.8 --- * Extend Issue #197 workaround to include all Python 3 versions prior to 3.2.2. --- 3.7 --- * Issue #193: Improved handling of Unicode filenames when building manifests.
Update to 3.3: --- 3.3 --- * Add ``include`` parameter to ``setuptools.find_packages()``. --- 3.2 --- * Pull Request #39: Add support for C++ targets from Cython ``.pyx`` files. * Issue #162: Update dependency on certifi to 1.0.1. * Issue #164: Update dependency on wincertstore to 0.2.
Update to 2.0.2:
-----
2.0.2
-----
* Fix NameError during installation with Python implementations (e.g. Jython)
not containing parser module.
* Fix NameError in ``sdist:re_finder``.
-----
2.0.1
-----
* Issue #124: Fixed error in list detection in upload_docs.
---
2.0
---
* Issue #121: Exempt lib2to3 pickled grammars from DirectorySandbox.
* Issue #41: Dropped support for Python 2.4 and Python 2.5. Clients requiring
setuptools for those versions of Python should use setuptools 1.x.
* Removed ``setuptools.command.easy_install.HAS_USER_SITE``. Clients
expecting this boolean variable should use ``site.ENABLE_USER_SITE``
instead.
* Removed ``pkg_resources.ImpWrapper``. Clients that expected this class
should use ``pkgutil.ImpImporter`` instead.
-----
1.4.2
-----
* Issue #116: Correct TypeError when reading a local package index on Python
3.
-----
1.4.1
-----
* Issue #114: Use ``sys.getfilesystemencoding`` for decoding config in
``bdist_wininst`` distributions.
* Issue #105 and Issue #113: Establish a more robust technique for
determining the terminal encoding::
1. Try ``getpreferredencoding``
2. If that returns US_ASCII or None, try the encoding from
``getdefaultlocale``. If that encoding was a "fallback" because Python
could not figure it out from the environment or OS, encoding remains
unresolved.
3. If the encoding is resolved, then make sure Python actually implements
the encoding.
4. On the event of an error or unknown codec, revert to fallbacks
(UTF-8 on Darwin, ASCII on everything else).
5. On the encoding is 'mac-roman' on Darwin, use UTF-8 as 'mac-roman' was
a bug on older Python releases.
On a side note, it would seem that the encoding only matters for when SVN
does not yet support ``--xml`` and when getting repository and svn version
numbers. The ``--xml`` technique should yield UTF-8 according to some
messages on the SVN mailing lists. So if the version numbers are always
7-bit ASCII clean, it may be best to only support the file parsing methods
for legacy SVN releases and support for SVN without the subprocess command
would simple go away as support for the older SVNs does.
---
1.4
---
* Issue #27: ``easy_install`` will now use credentials from .pypirc if
present for connecting to the package index.
* Pull Request #21: Omit unwanted newlines in ``package_index._encode_auth``
when the username/password pair length indicates wrapping.
-----
1.3.2
-----
* Issue #99: Fix filename encoding issues in SVN support.
-----
1.3.1
-----
* Remove exuberant warning in SVN support when SVN is not used.
Update to 1.2: --- 1.2 --- * Issue #26: Add support for SVN 1.7. Special thanks to Philip Thiem for the contribution. * Issue #94: Wheels are now distributed with every release. * Setuptools "natural" launcher support, introduced in 1.0, is now officially supported. ----- 1.1.7 ----- * Fixed behavior of NameError handling in 'script template (dev).py' (script launcher for 'develop' installs). * ``ez_setup.py`` now ensures partial downloads are cleaned up following a failed download. * Distribute #363 and Issue #55: Skip an sdist test that fails on locales other than UTF-8.
Update to 1.1.6: ----- 1.1.6 ----- * Distribute #349: ``sandbox.execfile`` now opens the target file in binary mode, thus honoring a BOM in the file when compiled.
Update to 1.1.4: ----- 1.1.4 ----- * Issue #77: Fix error in upload command (Python 2.4). ----- 1.1.3 ----- * Fix NameError in previous patch. ----- 1.1.2 ----- * Issue #69: Correct issue where 404 errors are returned for URLs with fragments in them (such as #egg=). ----- 1.1.1 ----- * Issue #75: Add ``--insecure`` option to ez_setup.py to accommodate environments where a trusted SSL connection cannot be validated. * Issue #76: Fix AttributeError in upload command with Python 2.4.
Add "${PYSITELIB}/setuptools/version.py*" to package list. Also change
an "${RM}" command to "${RM} -f" in the "post-install" target which is
required to fix the build on my system.
Update to 0.9: --- 0.9 --- * `package_index` now validates hashes other than MD5 in download links.
Update to setuptools-0.8 and apply misc PLIST related fixes. * Code base now runs on Python 2.4 - Python 3.3 without Python 2to3 conversion.
Update to 0.7.7. Simplify. Set LICENSE. Allow python-3.x. ----- 0.7.7 ----- * Distribute #375: Repair AttributeError created in last release (redo). * Issue #30: Added test for get_cache_path. ----- 0.7.6 ----- * Distribute #375: Repair AttributeError created in last release. ----- 0.7.5 ----- * Issue #21: Restore Python 2.4 compatibility in ``test_easy_install``. * Distribute #375: Merged additional warning from Distribute 0.6.46. * Now honor the environment variable ``SETUPTOOLS_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT`` in addition to the now deprecated ``DISTRIBUTE_DISABLE_VERSIONED_EASY_INSTALL_SCRIPT``. ----- 0.7.4 ----- * Issue #20: Fix comparison of parsed SVN version on Python 3. ----- 0.7.3 ----- * Issue #1: Disable installation of Windows-specific files on non-Windows systems. * Use new sysconfig module with Python 2.7 or >=3.2. ----- 0.7.2 ----- * Issue #14: Use markerlib when the `parser` module is not available. * Issue #10: ``ez_setup.py`` now uses HTTPS to download setuptools from PyPI. ----- 0.7.1 ----- * Fix NameError (Issue #3) again - broken in bad merge. --- 0.7 --- * Merged Setuptools and Distribute. See docs/merge.txt for details. Added several features that were slated for setuptools 0.6c12: * Index URL now defaults to HTTPS. * Added experimental environment marker support. Now clients may designate a PEP-426 environment marker for "extra" dependencies. Setuptools uses this feature in ``setup.py`` for optional SSL and certificate validation support on older platforms. Based on Distutils-SIG discussions, the syntax is somewhat tentative. There should probably be a PEP with a firmer spec before the feature should be considered suitable for use. * Added support for SSL certificate validation when installing packages from an HTTPS service. ----- 0.7b4 ----- * Issue #3: Fixed NameError in SSL support.
Remove python24 and all traces of it from pkgsrc. Remove devel/py-ctypes (only needed by and supporting python24). Remove PYTHON_VERSIONS_ACCEPTED and PYTHON_VERSIONS_INCOMPATIBLE lines that just mirror defaults now. Miscellaneous cleanup while editing all these files.
Handle difference between Python 2.4 and 2.5+
Switch to the tgz sources and install as single version primitive. Bump revision.
Remove @dirrm entries from PLISTs
Update to py-setuptools-0.6c6: - Add support for "eggsecutable" headers: a #!/bin/sh script that is prepended to an .egg file to allow it to be run as a script on Unix-ish platforms. - Various bug fixes.
Reimport devel/py24-setuptools as devel/py-setuptools. This is in principle usable on Python 2.3 as well, but not tested yet.
Initial revision