comparison planemo/lib/python3.7/site-packages/importlib_metadata/docs/index.rst @ 1:56ad4e20f292 draft

"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"
author guerler
date Fri, 31 Jul 2020 00:32:28 -0400
parents
children
comparison
equal deleted inserted replaced
0:d30785e31577 1:56ad4e20f292
1 ===============================
2 Welcome to importlib_metadata
3 ===============================
4
5 ``importlib_metadata`` is a library which provides an API for accessing an
6 installed package's metadata (see :pep:`566`), such as its entry points or its top-level
7 name. This functionality intends to replace most uses of ``pkg_resources``
8 `entry point API`_ and `metadata API`_. Along with :mod:`importlib.resources` in
9 Python 3.7 and newer (backported as :doc:`importlib_resources <importlib_resources:index>` for older
10 versions of Python), this can eliminate the need to use the older and less
11 efficient ``pkg_resources`` package.
12
13 ``importlib_metadata`` is a backport of Python 3.8's standard library
14 :doc:`importlib.metadata <library/importlib.metadata>` module for Python 2.7, and 3.4 through 3.7. Users of
15 Python 3.8 and beyond are encouraged to use the standard library module.
16 When imported on Python 3.8 and later, ``importlib_metadata`` replaces the
17 DistributionFinder behavior from the stdlib, but leaves the API in tact.
18 Developers looking for detailed API descriptions should refer to the Python
19 3.8 standard library documentation.
20
21 The documentation here includes a general :ref:`usage <using>` guide.
22
23
24 .. toctree::
25 :maxdepth: 2
26 :caption: Contents:
27
28 using.rst
29 changelog (links).rst
30
31
32 Project details
33 ===============
34
35 * Project home: https://gitlab.com/python-devs/importlib_metadata
36 * Report bugs at: https://gitlab.com/python-devs/importlib_metadata/issues
37 * Code hosting: https://gitlab.com/python-devs/importlib_metadata.git
38 * Documentation: http://importlib_metadata.readthedocs.io/
39
40
41 Indices and tables
42 ==================
43
44 * :ref:`genindex`
45 * :ref:`modindex`
46 * :ref:`search`
47
48
49 .. _`entry point API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points
50 .. _`metadata API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api