Reader

-----------

Released 2020-05-08

* Add ``sort`` argument to :meth:`~Reader.get_entries`.
Allow sorting entries randomly in addition to the default
most-recent-first order. (:issue:`105`)
* Allow changing the entry sort order in the web application. (:issue:`105`)
* Use a query builder instead of appending strings manually
for the more complicated queries in search and storage. (:issue:`123`)
* Make searching entries faster by filtering them *before* searching;
e.g. if 1/5 of the entries are read, searching only read entries
is now ~5x faster. (enabled by :issue:`123`)

-------------

Released 2020-04-30

* Fix bug introduced in `0.20 <Version 0.20_>`_ causing
:meth:`~Reader.update_feeds()` to silently stop updating
the remaining feeds after a feed failed. (:issue:`164`)

-----------

Released 2020-04-28

* Make all private submodules explicitly private. (:issue:`156`)

.. note::
All direct imports from :mod:`reader` continue to work.

* The ``reader.core.*`` modules moved to ``reader.*``
(most of them prefixed by ``_``).
* The web application WSGI entry point moved from
``reader.app.wsgi:app`` to ``reader._app.wsgi:app``.
* The entry points for plugins that ship with reader moved from
``reader.plugins.*`` to ``reader._plugins.*``.

* Require at least beautifulsoup4 4.5 for the ``search`` extra
(before, the version was unspecified). (:issue:`161`)
* Rename the web application dependencies extra from ``web-app`` to ``app``.
* Fix relative link resolution and content sanitization;
sgmllib3k is now a required dependency for this reason.
(:issue:`125`, :issue:`157`)

------------

Released 2020-04-14

* Add the :attr:`Entry.feed_url` attribute. (:issue:`159`)
* Rename the :class:`EntrySearchResult` ``feed`` attribute to
:attr:`~EntrySearchResult.feed_url`.
Using ``feed`` will raise a deprecation warning in version 0.22,
and will be removed in the following version. (:issue:`159`)
* Use ``executemany()`` instead of ``execute()`` in the SQLite storage.
Makes updating feeds (excluding network calls) 5-10% faster. (:issue:`144`)
* In the web app, redirect to the feed's page after adding a feed. (:issue:`119`)
* In the web app, show highlighted search result snippets. (:issue:`122`)

------------

Released 2020-04-04

* Minor consistency improvements to the web app search button. (:issue:`122`)
* Add support for web application plugins. (:issue:`80`)
* The enclosure tag proxy is now a plugin, and is disabled by default.
See its documentation for details. (:issue:`52`)
* In the web app, the "add feed" button shows a preview before adding the feed.
(:issue:`145`)
* In the web app, if the feed to be previewed is not actually a feed,
show a list of feeds linked from that URL. This is a plugin,
and is disabled by default. (:issue:`150`)
* reader now uses a User-Agent header like ``python-reader/0.21``
when retrieving feeds instead of the default `requests`_ one. (:issue:`154`)

------------

Released 2020-03-31

* Fix bug in :meth:`~Reader.enable_search()` that caused it to fail
if search was already enabled and the reader had any entries.
* Add an ``entry`` argument to :meth:`~Reader.get_entries`,
for symmetry with :meth:`~Reader.search_entries`.
* Add a ``feed`` argument to :meth:`~Reader.get_feeds`.
* Add a ``key`` argument to :meth:`~Reader.get_feed_metadata`.
* Require at least `requests`_ 2.18 (before, the version was unspecified).
* Allow updating feeds concurrently; add a ``workers`` argument to
:meth:`~Reader.update_feeds`. (:issue:`152`)

.. _requests: https://requests.readthedocs.io