summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2021-04-03 13:13:28 -0400
committerJason R. Coombs <jaraco@jaraco.com>2021-04-03 13:13:28 -0400
commit8fe85c22cee7fde5e6af571b30f864bad156a010 (patch)
treec135f6a2da78cee10826702c8dbdf600afa78314 /docs
parent30cf7823c7acd8ba5503ed3fdc7dc9cb28800880 (diff)
downloadpython-setuptools-git-8fe85c22cee7fde5e6af571b30f864bad156a010.tar.gz
Officially declare pkg_resources as deprecated. Closes #2531.
Diffstat (limited to 'docs')
-rw-r--r--docs/pkg_resources.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/pkg_resources.rst b/docs/pkg_resources.rst
index 19d43244..994bea6f 100644
--- a/docs/pkg_resources.rst
+++ b/docs/pkg_resources.rst
@@ -10,6 +10,13 @@ eggs, support for merging packages that have separately-distributed modules or
subpackages, and APIs for managing Python's current "working set" of active
packages.
+Use of ``pkg_resources`` is discouraged in favor of
+`importlib.resources <https://docs.python.org/3/library/importlib.html#module-importlib.resources>`_,
+`importlib.metadata <https://docs.python.org/3/library/importlib.metadata.html>`_,
+and their backports (`resources <https://pypi.org/project/importlib_resources>`_,
+`metadata <https://pypi.org/project/importlib_metadata>`_).
+Please consider using those libraries instead of pkg_resources.
+
.. contents:: **Table of Contents**