reader
Unreleased
- Allow disabling feed updates for specific feeds. (
187
) - Add methods to get aggregated feed and entry counts. (
185
) - In the web application: allow disabling feed updates for a feed; allow filtering feeds by whether they have updates enabled; do not show feed update errors for feeds that have updates disabled. (
187
) - In the web application, show feed and entry counts when
?counts=yes
is used. (185
)
Released 2020-11-20
- Use indexes for
~Reader.get_entries()
(recent order); should make calls 10-30% faster. (134
) - Allow sorting
~Reader.search_entries
results randomly. Allow sorting search results randomly in the web application. (200
) - Reraise unexpected errors caused by parser bugs instead of replacing them with an
AssertionError
. - Add the
sqlite_releases
custom parser plugin. - Refactor the HTTP feed sub-parser to allow reuse by custom parsers.
- Add a user guide, and improve other parts of the documentation. (
194
)
Released 2020-10-28
- Support Python 3.9. (
199
) - Support Windows (requires Python >= 3.9). (
163
) - Use GitHub Actions to do macOS and Windows CI builds. (
199
) - Rename the
cloudflare_ua_fix
plugin toua_fallback
. Retry any feed that gets a 403, not just those served by Cloudflare. (181
) - Fix type annotation to avoid mypy 0.790 errors. (
198
)
Released 2020-10-02
- Drop feedparser 5.x support (deprecated in 1.7); use feedparser 6.x instead. (
190
) - Make the string representation of
ReaderError
and its subclasses more consistent; add error messages and improve the existing ones. (173
) - Add method
~Reader.change_feed_url
to change the URL of a feed. (149
) - Allow changing the URL of a feed in the web application. (
149
) - Add more tag navigation links to the web application. (
184
) - In the
feed_entry_dedupe
plugin, copy the important flag from the old entry to the new one. (140
)
Released 2020-09-19
- Add new methods to support feed tags:
~Reader.add_feed_tag
,~Reader.remove_feed_tag
, and~Reader.get_feed_tags
. Allow filtering feeds and entries by their feed tags. (184
) - Add the
broken
argument to~Reader.get_feeds
, which allows getting only feeds that failed / did not fail during the last update. (189
) - feedparser 5.x support is deprecated in favor of feedparser 6.x. Using feedparser 5.x will raise a deprecation warning in version 1.7, and support will be removed the following version. (
190
) - Tag-related web application features: show tags in the feed list; allow adding/removing tags; allow filtering feeds and entries by their feed tag; add a page that lists all tags. (
184
) - In the web application, allow showing only feeds that failed / did not fail. (
189
) - In the
preview_feed_list
plugin, add<meta>
tags as a feed detection heuristic. - Add a few property-based tests. (
188
)
Released 2020-09-04
- Add the
feed_root
argument tomake_reader
, which allows limiting local feed parsing to a specific directory or disabling it altogether. Using it is recommended, since by default reader will access any local feed path (in 2.0, local file parsing will be disabled by default). (155
) - Support loading CLI and web application settings from a
configuration file <config>
. (177
) - Fail fast for feeds that return HTTP 4xx or 5xx status codes, instead of (likely) failing later with an ambiguous XML parsing error. The cause of the raised
ParseError
is now an instance ofrequests.HTTPError
. (182
) - Add
cloudflare_ua_fix
plugin (work around Cloudflare sometimes blocking requests). (181
) - feedparser 6.0 (beta) compatibility fixes.
- Internal parser API changes to support alternative parsers, pre-request hooks, and making arbitrary HTTP requests using the same logic
Reader
uses. (155
) - In the /preview page and the
preview_feed_list
plugin, use the same plugins the mainReader
does. (enabled by155
)
Released 2020-07-30
- Use rowid when deleting from the search index, instead of the entry id. Previously, each
~Reader.update_search
call would result in a full scan, even if there was nothing to update/delete. This should reduce the amount of reads significantly (deleting 4 entries from a database with 10k entries resulted in an 1000x decrease in bytes read). (178
) - Require at least SQLite 3.18 (released 2017-03-30) for the current
~Reader.update_search
implementation; all other reader features continue to work with SQLite >= 3.15. (178
) Run
PRAGMA optimize
on~Reader.close()
. This should increase the performance of all methods. As an example, in178
it was found that~Reader.update_search
resulted in a full scan of the entries table, even if there was nothing to update; this change should prevent this from happening. (143
)Note
PRAGMA optimize
is a no-op in SQLite versions earlier than 3.18. In order to avoid the case described above, you should run ANALYZE regularly (e.g. every few days).
Released 2020-07-13
- Work to reduce the likelihood of "database is locked" errors during updates (
175
):- Prepare entries to be added to the search index (
~Reader.update_search
) outside transactions. - Fix bug causing duplicate rows in the search index when an entry changes while updating the search index.
- Update the search index only when the indexed values change (details below).
- Use SQLite WAL (details below).
- Prepare entries to be added to the search index (
- Update the search index only when the indexed values change. Previously, any change on a feed would result in all its entries being re-indexed, even if the feed title or the entry content didn't change. This should reduce the
~Reader.update_search
run time significantly. - Use SQLite's write-ahead logging to increase concurrency. At the moment there is no way to disable WAL. This change may be reverted in the future. (
169
) - Require at least click 7.0 for the
cli
extra. - Do not fail for feeds with incorrectly-declared media types, if feedparser can parse the feed; this is similar to the current behavior for incorrectly-declared encodings. (
171
) - Raise
ParseError
during update for feeds feedparser can't detect the type of, instead of silently returning an empty feed. (171
) - Add
sort
argument to~Reader.search_entries
. Allow sorting search results by recency in addition to relevance (the default). (176
) - In the web application, display a nice error message for invalid search queries instead of returning an HTTP 500 Internal Server Error.
- Other minor web application improvements.
- Minor CLI logging improvements.
Released 2020-06-23
- If a feed failed to update, provide details about the error in
Feed.last_exception
. (68
) - Show details about feed update errors in the web application. (
68
) - Expose the
~Feed.added
and~Feed.last_updated
Feed attributes. - Expose the
~Entry.last_updated
Entry attribute. - Raise
ParseError
/ log during update if an entry has no id, instead of unconditionally raisingAttributeError
. (170
) - Fall back to <link> as entry id if an entry in an RSS feed has no <guid>; previously, feeds like this would fail on update. (
170
) - Minor web application improvements (show feed added/updated date).
- In the web application, handle previewing an invalid feed nicely instead of returning an HTTP 500 Internal Server Error. (
172
) - Internal API changes to support multiple storage implementations in the future. (
168
)
Released 2020-05-18
- Minor web application improvements.
- Remove unneeded additional query in methods that use pagination (for n = len(result) / page size, always do n queries instead n+1).
~Reader.get_entries
and~Reader.search_entries
are now 33–7% and 46–36% faster, respectively, for results of size 32–256. (166
) - All queries are now chunked/paginated to avoid locking the SQLite storage for too long, decreasing the chance of concurrent queries timing out; the problem was most visible during
~Reader.update_search
. This should cap memory usage for methods returning an iterable that were not paginated before; previously the whole result set would be read before returning it. (167
)
Released 2020-05-08
- Add
sort
argument to~Reader.get_entries
. Allow sorting entries randomly in addition to the default most-recent-first order. (105
) - Allow changing the entry sort order in the web application. (
105
) - Use a query builder instead of appending strings manually for the more complicated queries in search and storage. (
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
123
)
Released 2020-04-30
- Fix bug introduced in 0.20 causing
~Reader.update_feeds()
to silently stop updating the remaining feeds after a feed failed. (164
)
Released 2020-04-28
Make all private submodules explicitly private. (
156
)Note
All direct imports from
reader
continue to work.- The
reader.core.*
modules moved toreader.*
(most of them prefixed by_
). - The web application WSGI entry point moved from
reader.app.wsgi:app
toreader._app.wsgi:app
. - The entry points for plugins that ship with reader moved from
reader.plugins.*
toreader._plugins.*
.
- The
- Require at least beautifulsoup4 4.5 for the
search
extra (before, the version was unspecified). (161
) - Rename the web application dependencies extra from
web-app
toapp
. - Fix relative link resolution and content sanitization; sgmllib3k is now a required dependency for this reason. (
125
,157
)
Released 2020-04-14
- Add the
Entry.feed_url
attribute. (159
) - Rename the
EntrySearchResult
feed
attribute to~EntrySearchResult.feed_url
. Usingfeed
will raise a deprecation warning in version 0.22, and will be removed in the following version. (159
) - Use
executemany()
instead ofexecute()
in the SQLite storage. Makes updating feeds (excluding network calls) 5-10% faster. (144
) - In the web app, redirect to the feed's page after adding a feed. (
119
) - In the web app, show highlighted search result snippets. (
122
)
Released 2020-04-04
- Minor consistency improvements to the web app search button. (
122
) - Add support for web application plugins. (
80
) - The enclosure tag proxy is now a plugin, and is disabled by default. See its documentation for details. (
52
) - In the web app, the "add feed" button shows a preview before adding the feed. (
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. (
150
) - reader now uses a User-Agent header like
python-reader/0.21
when retrieving feeds instead of the default requests one. (154
)
Released 2020-03-31
- Fix bug in
~Reader.enable_search()
that caused it to fail if search was already enabled and the reader had any entries. - Add an
entry
argument to~Reader.get_entries
, for symmetry with~Reader.search_entries
. - Add a
feed
argument to~Reader.get_feeds
. - Add a
key
argument to~Reader.get_feed_metadata
. - Require at least requests 2.18 (before, the version was unspecified).
- Allow updating feeds concurrently; add a
workers
argument to~Reader.update_feeds
. (152
)
Released 2020-03-25
- Support PyPy 3.6.
- Allow
searching for entries <fts>
. (122
) - Stricter type checking for the core modules.
- Various changes to the storage internal API.
Released 2020-01-26
- Support Python 3.8.
- Increase the
~Reader.get_entries
recent threshold from 3 to 7 days. (141
) - Enforce type checking for the core modules. (
132
) - Use dataclasses for the data objects instead of attrs. (
137
)
Released 2019-10-12
- Remove the
which
argument of~Reader.get_entries
. (136
) Reader
objects should now be created usingmake_reader
. Instantiating Reader directly will raise a deprecation warning.- The resources associated with a reader can now be released explicitly by calling its
~Reader.close()
method. (139
) - Make the database schema more strict regarding nulls. (
138
) - Tests are now run in a random order. (
142
)
Released 2019-09-02
- Allow marking entries as important. (
127
) ~Reader.get_entries
and~Reader.get_feeds
now take only keyword arguments.~Reader.get_entries
argumentwhich
is now deprecated in favor ofread
. (136
)
Released 2019-08-24
- Improve entry page rendering for text/plain content. (
117
) - Improve entry page rendering for images and code blocks. (
126
) - Show enclosures on the entry page. (
128
) - Show the entry author. (
129
) - Fix bug causing the enclosure tag proxy to use too much memory. (
133
) - Start using mypy on the core modules. (
132
)
Released 2019-08-12
- Drop Python 3.5 support. (
124
) - Improve entry ordering implementation. (
110
)
Released 2019-07-12
- Add entry page. (
117
) ~Reader.get_feed
now raisesFeedNotFoundError
if the feed does not exist; useget_feed(..., default=None)
for the old behavior.- Add
~Reader.get_entry
. (120
)
Released 2019-06-22
- Fix flashed messages never disappearing. (
81
) - Minor metadata page UI improvements.
- Allow limiting the number of entries on the entries page via the
limit
URL parameter. - Add link to the feed on the entries and feeds pages. (
118
) - Use Black and pre-commit to enforce style.
Released 2019-05-26
- Support storing per-feed metadata. (
114
) - Add feed metadata page to the web app. (
114
) - The
regex_mark_as_read
plugin is now configurable via feed metadata; drop support for theREADER_PLUGIN_REGEX_MARK_AS_READ_CONFIG
file. (114
)
Released 2019-05-18
- Unify plugin loading and error handling code. (
112
) - Minor improvements to CLI error reporting.
Released 2019-05-12
- Improve the
~Reader.get_entries
sorting algorithm. Fixes a bug introduced by106
(entries of new feeds would always show up at the top). (113
)
Released 2019-04-21
- Make the internal APIs use explicit types instead of tuples. (
111
) - Finish updater internal API. (
107
) - Automate part of the release process (
scripts/release.py
).
Released 2019-04-14
- Increase timeout of the button actions from 2 to 10 seconds.
~Reader.get_entries
now sorts entries by the import date first, and then by~Entry.published
/~Entry.updated
. (106
)- Add
enclosure_dedupe
plugin (deduplicate enclosures of an entry). (78
) - The
serve
command now supports loading plugins. (78
) reader.app.wsgi
now supports loading plugins. (78
)
Released 2019-04-13
- Minor web application style changes to make the layout more condensed.
- Factor out update logic into a separate interface. (
107
) - Fix update failing if the feed does not have a content type header. (
108
)
Released 2019-02-09
- Make updating new feeds up to 2 orders of magnitude faster; fixes a problem introduced by
94
. (104
) - Move the core modules to a separate subpackage and enforce test coverage (
make coverage
now fails if the coverage for core modules is less than 100%). (101
) - Support Python 3.8 development branch.
- Add
dev
anddocs
extras (to install development requirements). - Build HTML documentation when running tox.
- Add
test-all
anddocs
make targets (to run tox / build HTML docs).
Released 2019-01-02
- Support Python 3.7.
- Entry
~Entry.content
and~Entry.enclosures
now default to an empty tuple instead ofNone
. (99
) ~Reader.get_feeds
now sorts feeds by~Feed.user_title
or~Feed.title
instead of just~Feed.title
. (102
)~Reader.get_feeds
now sorts feeds in a case insensitive way. (103
)- Add
sort
argument to~Reader.get_feeds
; allows sorting feeds by title or by when they were added. (98
) - Allow changing the feed sort order in the web application. (
98
)
Released on 2018-12-22
~Reader.get_entries
now prefers sorting by~Entry.published
(if present) to sorting by~Entry.updated
. (97
)- Add
regex_mark_as_read
plugin (mark new entries as read based on a regex). (79
) - Add
feed_entry_dedupe
plugin (deduplicate new entries for a feed). (79
) - Plugin loading machinery dependencies are now installed via the
plugins
extra. - Add a plugins section to the documentation.
Released on 2018-11-25
- Factor out storage-related functionality into a separate interface. (
94
) - Fix
update --new-only
updating the same feed repeatedly on databases that predate--new-only
. (95
) - Add web application screenshots to the documentation.
Released on 2018-10-21
- Fix broken
reader serve
command (broken in 0.1). - Raise
StorageError
for unsupported SQLite configurations atReader
instantiation instead of failing at run-time with a genericStorageError("sqlite3 error")
. (92
) - Fix wrong submit button being used when pressing enter in non-button fields. (
69
) - Raise
StorageError
for failed migrations instead of an undocumented exception. (92
) - Use
requests-mock
in parser tests instead of a web server (test suite run time down by ~35%). (90
)
Released on 2018-09-15
- Initial release; public API stable.
- Support broken Tumblr feeds via the the
tumblr_gdpr
plugin. (67
)