changelog.rst 5.4 KB
Newer Older
1 2 3 4
=========================
 importlib_metadata NEWS
=========================

Jason R. Coombs's avatar
Jason R. Coombs committed
5 6
0.21
====
7 8 9
* ``importlib.metadata`` now exposes the ``DistributionFinder``
  metaclass and references it in the docs for extending the
  search algorithm.
Jason R. Coombs's avatar
Jason R. Coombs committed
10 11
* Add ``Distribution.at`` for constructing a Distribution object
  from a known metadata directory on the file system. Closes #80.
Jason R. Coombs's avatar
Jason R. Coombs committed
12 13 14 15 16 17 18 19 20 21
* Distribution finders now receive a context object that
  supplies ``.path`` and ``.name`` properties. This change
  introduces a fundamental backward incompatibility for
  any projects implementing a ``find_distributions`` method
  on a ``MetaPathFinder``. This new layer of abstraction
  allows this context to be supplied directly or constructed
  on demand and opens the opportunity for a
  ``find_distributions`` method to solicit additional
  context from the caller. Closes #85.

Jason R. Coombs's avatar
Jason R. Coombs committed
22 23 24 25
0.20
====
* Clarify in the docs that calls to ``.files`` could return
  ``None`` when the metadata is not present. Closes #69.
Jason R. Coombs's avatar
Jason R. Coombs committed
26 27
* Return all requirements and not just the first for dist-info
  packages. Closes #67.
Jason R. Coombs's avatar
Jason R. Coombs committed
28

Jason R. Coombs's avatar
Jason R. Coombs committed
29 30 31
0.19
====
* Restrain over-eager egg metadata resolution.
32
* Add support for entry points with colons in the name. Closes #75.
Jason R. Coombs's avatar
Jason R. Coombs committed
33

34 35 36 37 38
0.18
====
* Parse entry points case sensitively.  Closes #68
* Add a version constraint on the backport configparser package.  Closes #66

Barry Warsaw's avatar
Barry Warsaw committed
39 40 41 42
0.17
====
* Fix a permission problem in the tests on Windows.

Barry Warsaw's avatar
Barry Warsaw committed
43 44 45 46
0.16
====
* Don't crash if there exists an EGG-INFO directory on sys.path.

47 48 49 50
0.15
====
* Fix documentation.

51 52 53 54 55 56 57 58 59
0.14
====
* Removed ``local_distribution`` function from the API.
  **This backward-incompatible change removes this
  behavior summarily**. Projects should remove their
  reliance on this behavior. A replacement behavior is
  under review in the `pep517 project
  <https://github.com/pypa/pep517>`_. Closes #42.

60 61 62 63 64
0.13
====
* Update docstrings to match PEP 8. Closes #63.
* Merged modules into one module. Closes #62.

Jason R. Coombs's avatar
Jason R. Coombs committed
65 66 67 68
0.12
====
* Add support for eggs.  !65; Closes #19.

Barry Warsaw's avatar
Barry Warsaw committed
69 70 71 72 73
0.11
====
* Support generic zip files (not just wheels).  Closes #59
* Support zip files with multiple distributions in them.  Closes #60
* Fully expose the public API in ``importlib_metadata.__all__``.
Barry Warsaw's avatar
Barry Warsaw committed
74 75 76 77 78 79 80 81 82

0.10
====
* The ``Distribution`` ABC is now officially part of the public API.
  Closes #37.
* Fixed support for older single file egg-info formats.  Closes #43.
* Fixed a testing bug when ``$CWD`` has spaces in the path.  Closes #50.
* Add Python 3.8 to the ``tox`` testing matrix.

Jason R. Coombs's avatar
Jason R. Coombs committed
83 84
0.9
===
Barry Warsaw's avatar
Barry Warsaw committed
85 86
* Fixed issue where entry points without an attribute would raise an
  Exception.  Closes #40.
87
* Removed unused ``name`` parameter from ``entry_points()``. Closes #44.
Jason R. Coombs's avatar
Jason R. Coombs committed
88 89
* ``DistributionFinder`` classes must now be instantiated before
  being placed on ``sys.meta_path``.
Jason R. Coombs's avatar
Jason R. Coombs committed
90

91 92
0.8
===
93
* This library can now discover/enumerate all installed packages. **This
94
  backward-incompatible change alters the protocol finders must
95 96 97
  implement to support distribution package discovery.** Closes #24.
* The signature of ``find_distributions()`` on custom installer finders
  should now accept two parameters, ``name`` and ``path`` and
98
  these parameters must supply defaults.
Jason R. Coombs's avatar
Jason R. Coombs committed
99 100 101 102
* The ``entry_points()`` method no longer accepts a package name
  but instead returns all entry points in a dictionary keyed by the
  ``EntryPoint.group``. The ``resolve`` method has been removed. Instead,
  call ``EntryPoint.load()``, which has the same semantics as
103 104 105 106 107 108 109
  ``pkg_resources`` and ``entrypoints``.  **This is a backward incompatible
  change.**
* Metadata is now always returned as Unicode text regardless of
  Python version. Closes #29.
* This library can now discover metadata for a 'local' package (found
  in the current-working directory). Closes #27.
* Added ``files()`` function for resolving files from a distribution.
110 111 112
* Added a new ``requires()`` function, which returns the requirements
  for a package suitable for parsing by
  ``packaging.requirements.Requirement``. Closes #18.
113 114 115 116 117
* The top-level ``read_text()`` function has been removed.  Use
  ``PackagePath.read_text()`` on instances returned by the ``files()``
  function.  **This is a backward incompatible change.**
* Release dates are now automatically injected into the changelog
  based on SCM tags.
Jason R. Coombs's avatar
Jason R. Coombs committed
118

119 120
0.7
===
Jason R. Coombs's avatar
Jason R. Coombs committed
121 122
* Fixed issue where packages with dashes in their names would
  not be discovered. Closes #21.
Jason R. Coombs's avatar
Jason R. Coombs committed
123 124 125 126
* Distribution lookup is now case-insensitive. Closes #20.
* Wheel distributions can no longer be discovered by their module
  name. Like Path distributions, they must be indicated by their
  distribution package name.
127

128 129
0.6
===
130 131 132 133 134
* Removed ``importlib_metadata.distribution`` function. Now
  the public interface is primarily the utility functions exposed
  in ``importlib_metadata.__all__``. Closes #14.
* Added two new utility functions ``read_text`` and
  ``metadata``.
Jason R. Coombs's avatar
Jason R. Coombs committed
135

136 137
0.5
===
Jason R. Coombs's avatar
Jason R. Coombs committed
138 139 140 141 142
* Updated README and removed details about Distribution
  class, now considered private. Closes #15.
* Added test suite support for Python 3.4+.
* Fixed SyntaxErrors on Python 3.4 and 3.5. !12
* Fixed errors on Windows joining Path elements. !15
143

144 145
0.4
===
Barry Warsaw's avatar
Barry Warsaw committed
146 147
* Housekeeping.

148 149
0.3
===
150
* Added usage documentation.  Closes #8
Barry Warsaw's avatar
Barry Warsaw committed
151
* Add support for getting metadata from wheels on ``sys.path``.  Closes #9
152

153 154
0.2
===
155
* Added ``importlib_metadata.entry_points()``.  Closes #1
Jason R. Coombs's avatar
Jason R. Coombs committed
156
* Added ``importlib_metadata.resolve()``.  Closes #12
157
* Add support for Python 2.7.  Closes #4
158

159 160
0.1
===
161 162 163 164 165 166 167 168 169 170 171
* Initial release.


..
   Local Variables:
   mode: change-log-mode
   indent-tabs-mode: nil
   sentence-end-double-space: t
   fill-column: 78
   coding: utf-8
   End: