Skip to main content

Read metadata from Python packages

Project description

=========================
``importlib_metadata``
=========================

``importlib_metadata`` is a library to access the metadata for a Python
package. It is intended to be ported to Python 3.8.


Usage
=====

``importlib_metadata``, unlike its sister packages importlib and
importlib.resources, operates on Python Distribution packages (the
package as installed by pip or similar).

This module exposes a few functions:

:func:`metadata` takes a distribution package name and returns
the metadata for that package (as :class:`email.Message`).

:func:`version` takes a distribution package name and returns the
version for that package.

:func:`entry_points` takes a distribution package name and returns
a structure of entry points declared by that package.

:func:`resolve` accepts an entry point as returned by
:func:`entry_points` and resolves it to the module or callable that
it references.

:func:`read_text` takes the distribution package name and a filename
in that package's info directory and return the text of that file.

Support for Custom Package Installers
=====================================

``importlib_metadata`` provides hooks for third-party package installers
through their declared finders. A custom installer, if it provides its
own finder for installed packages, should also provide on that finder
a ``find_distribution`` callable that when called with
the name of a package will return a ``Distribution`` instance capable
of loading the metadata for that named package (or None if that finder
has no knowledge of that package or its metadata).


Caveats
=======

This project primarily supports third-party packages installed by PyPA
tools (or other conforming packages). It does not support:

- Packages in the stdlib.
- Packages installed without metadata.


Project details
===============

* Project home: https://gitlab.com/python-devs/importlib_metadata
* Report bugs at: https://gitlab.com/python-devs/importlib_metadata/issues
* Code hosting: https://gitlab.com/python-devs/importlib_metadata.git
* Documentation: http://importlib_metadata.readthedocs.io/


Project details


Release history Release notifications | RSS feed

This version

0.6

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

importlib_metadata-0.6.tar.gz (15.2 kB view hashes)

Uploaded source

Built Distribution

importlib_metadata-0.6-py2.py3-none-any.whl (16.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page