diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2020-07-18 13:46:01 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2020-07-18 13:46:12 -0400 |
| commit | bec11f03ab81da8af69909697925166793893e07 (patch) | |
| tree | 3ec4148fc9e0c4a600a951790f972126da26440f | |
| parent | 37d81f4ce8f08c4baf44b6ff0f3f1bd3f6b2a127 (diff) | |
| download | python-setuptools-git-docs/distutils-porting.tar.gz | |
Add docs on porting from distutils.docs/distutils-porting
| -rw-r--r-- | docs/distutils-legacy.txt | 25 | ||||
| -rw-r--r-- | docs/index.txt | 1 |
2 files changed, 26 insertions, 0 deletions
diff --git a/docs/distutils-legacy.txt b/docs/distutils-legacy.txt new file mode 100644 index 00000000..a5d96260 --- /dev/null +++ b/docs/distutils-legacy.txt @@ -0,0 +1,25 @@ +Porting from Distutils +====================== + +Setuptools and the PyPA have a `stated goal <https://github.com/pypa/packaging-problems/issues/127>`_ to make Setuptools the reference API for distutils. + +Since the 49.1.2 release, Setuptools includes a local, vendored copy of distutils (from late copies of CPython) that is disabled by default. To enable the use of this copy of distutils when invoking setuptools, set the enviroment variable: + + SETUPTOOLS_USE_DISTUTILS=local + +This behavior is planned to become the default. + +Prefer Setuptools +----------------- + +As Distutils is deprecated, any usage of functions or objects from distutils is similarly discouraged, and Setuptools aims to replace or deprecate all such uses. This section describes the recommended replacements. + +``distutils.core.setup`` → ``setuptools.setup`` + +``distutils.cmd.Command`` → ``setuptools.Command`` + +``distutils.log`` → (no replacement yet) + +``distutils.version.*`` → ``packaging.version.*`` + +If a project relies on uses of ``distutils`` that do not have a suitable replacement above, please search the `Setuptools issue tracker <https://github.com/pypa/setuptools/issues/>`_ and file a request, describing the use-case so that Setuptools' maintainers can investigate. Please provide enough detail to help the maintainers understand how distutils is used, what value it provides, and why that behavior should be supported. diff --git a/docs/index.txt b/docs/index.txt index 228f97c8..0dd5fd94 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -18,4 +18,5 @@ Documentation content: development roadmap Deprecated: Easy Install <easy_install> + distutils-legacy history |