Prevents spurious updates for feeds whose
updatedchanges excessively (either because the entries’ content changes excessively, or because an RSS feed does not have a
dc:dateelement, and feedparser falls back to
regex_mark_as_readexperimental plugin is now built-in. To use it with the CLI / web application, use the plugin name instead of the entry point (
The config metadata key and format changed; the config will be migrated automatically on the next feed update, during reader version 1.17 only. If you used
regex_mark_as_readand are upgrading to a version >1.17, install 1.17 (
pip install reader==1.17) and run a full feed update (
python -m reader update) before installing the newer version.
sqlite-releasesunstable extras are not available anymore. Use the
unstable-pluginsextra to install dependencies of the unstable plugins instead.
In the web application, allow updating a feed manually. (#195)
ua_fallbackplugin by default.
To use them with the CLI / web application, use the plugin name instead of the entry point:
reader._plugins.enclosure_dedupe:enclosure_dedupe -> reader.enclosure_dedupe reader._plugins.feed_entry_dedupe:feed_entry_dedupe -> reader.entry_dedupe reader._plugins.ua_fallback:init -> reader.ua_fallback
pluginsextra; plugin loading machinery does not have additional dependencies anymore.
Mention in the User guide that all reader functions/methods can raise
TypeErrorif passed invalid arguments. There is no behavior change, this is just documenting existing, previously undocumented behavior.
Limit content-only updates (not due to an
updatedchange) to 24 consecutive updates, to prevent spurious updates for entries whose content changes excessively (for example, because it includes the current time). (#225)
Previously, entries would be updated only if the entry
updatedwas newer than the stored one.
Fix bug causing entries that don’t have
updatedset in the feed to not be updated if the feed is marked as stale. Feed staleness is an internal feature used during storage migrations; this bug could only manifest when migrating from 0.22 to 1.x. (found during #179)
Minor web application improvements.
Minor CLI improvements.
- Add the
update_feeds_iter()method, which yields the update status of each feed as it gets updated. (#204)
- Change the return type of
- Add the
make_reader()to set a timeout for retrieving HTTP(S) feeds. The default (connect timeout, read timeout) is (3.05, 60) seconds; the previous behavior was to never time out.
PRAGMA user_versioninstead of a version table. (#210)
PRAGMA application_idto identify reader databases; the id is
readin ASCII / UTF-8. (#211)
- Change the
reader updatecommand to show a progress bar and update summary (with colors), instead of plain log output. (#204)
- Fix broken Mypy config following 0.800 release. (#213)
- JSON Feed support. (#206)
- Split feed retrieval from parsing; should make it easier to add new/custom parsers. (#206)
- Prevent any logging output from the
readerlogger by default. (#207)
- In the
<link rel=alternative ...>tags as a feed detection heuristic.
- In the
<a>tags as a fallback feed detection heuristic.
- In the web application, fix bug causing the entries page to crash when counts are enabled.
- Add the
search_entries(), allowing them to be used in a paginated fashion. (#196)
- Add the
object_idproperty that allows getting the unique identifier of a data object in a uniform way. (#196)
- In the web application, add links to toggle feed/entry counts. (#185)
- 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=yesis used. (#185)
- In the web application, use YAML instead of JSON for the tags and metadata fields.
- Use indexes for
get_entries()(recent order); should make calls 10-30% faster. (#134)
- Allow sorting
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
- Add the
sqlite_releasescustom 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)
- 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
ua_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)
- Drop feedparser 5.x support (deprecated in 1.7); use feedparser 6.x instead. (#190)
- Make the string representation of
ReaderErrorand its subclasses more consistent; add error messages and improve the existing ones. (#173)
- Add method
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_dedupeplugin, copy the important flag from the old entry to the new one. (#140)
- Add new methods to support feed tags:
get_feed_tags(). Allow filtering feeds and entries by their feed tags. (#184)
- Add the
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
<meta>tags as a feed detection heuristic.
- Add a few property-based tests. (#188)
- Add the
make_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. (#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
ParseErroris now an instance of
cloudflare_ua_fixplugin (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
- In the /preview page and the
preview_feed_listplugin, use the same plugins the main
Readerdoes. (enabled by #155)
Use rowid when deleting from the search index, instead of the entry id. Previously, each
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)
close(). This should increase the performance of all methods. As an example, in #178 it was found that
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)
PRAGMA optimizeis 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).
- Work to reduce the likelihood of “database is locked” errors during updates
- Prepare entries to be added to the search index
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
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
- 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)
ParseErrorduring update for feeds feedparser can’t detect the type of, instead of silently returning an empty feed. (#171)
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.
- If a feed failed to update, provide details about the error
- Show details about feed update errors in the web application. (#68)
- Expose the
- Expose the
ParseError/ log during update if an entry has no id, instead of unconditionally raising
- 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)
- 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).
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
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)
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)
Make all private submodules explicitly private. (#156)
All direct imports from
readercontinue to work.
reader.core.*modules moved to
reader.*(most of them prefixed by
- The web application WSGI entry point moved from
- The entry points for plugins that ship with reader moved from
Require at least beautifulsoup4 4.5 for the
searchextra (before, the version was unspecified). (#161)
Rename the web application dependencies extra from
- Add the
- Rename the
feedwill raise a deprecation warning in version 0.22, and will be removed in the following version. (#159)
execute()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)
- 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.21when retrieving feeds instead of the default requests one. (#154)
- Fix bug in
enable_search()that caused it to fail if search was already enabled and the reader had any entries.
- Add an
get_entries(), for symmetry with
- Add a
- Add a
- Require at least requests 2.18 (before, the version was unspecified).
- Allow updating feeds concurrently; add a
- Remove the
Readerobjects should now be created using
make_reader(). Instantiating Reader directly will raise a deprecation warning.
- The resources associated with a reader can now be released explicitly
by calling its
- Make the database schema more strict regarding nulls. (#138)
- Tests are now run in a random order. (#142)
- 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)
- Unify plugin loading and error handling code. (#112)
- Minor improvements to CLI error reporting.
- Increase timeout of the button actions from 2 to 10 seconds.
get_entries()now sorts entries by the import date first, and then by
enclosure_dedupeplugin (deduplicate enclosures of an entry). (#78)
servecommand now supports loading plugins. (#78)
reader.app.wsginow supports loading plugins. (#78)
- 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 coveragenow fails if the coverage for core modules is less than 100%). (#101)
- Support Python 3.8 development branch.
docsextras (to install development requirements).
- Build HTML documentation when running tox.
docsmake targets (to run tox / build HTML docs).
- Support Python 3.7.
enclosuresnow default to an empty tuple instead of
get_feeds()now sorts feeds by
titleinstead of just
get_feeds()now sorts feeds in a case insensitive way. (#103)
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
get_entries()now prefers sorting by
published(if present) to sorting by
regex_mark_as_readplugin (mark new entries as read based on a regex). (#79)
feed_entry_dedupeplugin (deduplicate new entries for a feed). (#79)
- Plugin loading machinery dependencies are now installed via the
- Add a plugins section to the documentation.
Released on 2018-11-25
Released on 2018-10-21
- Fix broken
reader servecommand (broken in 0.1).
StorageErrorfor unsupported SQLite configurations at
Readerinstantiation instead of failing at run-time with a generic
StorageError("sqlite3 error"). (#92)
- Fix wrong submit button being used when pressing enter in non-button fields. (#69)
StorageErrorfor failed migrations instead of an undocumented exception. (#92)
requests-mockin parser tests instead of a web server (test suite run time down by ~35%). (#90)