Remove the Twitter plugin (lemon24#310).

CHANGES.rst

@@ -18,6 +18,9 @@ Unreleased
 
 * Support PyPy 3.10. (:issue:`302`)
 
+* Remove the :ref:`twitter` plugin (deprecated in `3.6 <Version 3.6_>`_).
+  (:issue:`310`)
+
 
 Version 3.6
 -----------
@@ -32,13 +35,13 @@ Released 2023-06-16
   (:issue:`301`, :issue:`96`)
 * Update vendored ``reader._http_utils`` to werkzeug 2.3.5.
 
-* Deprecate the (experimental) :mod:`~reader._plugins.twitter` plugin,
+* Deprecate the experimental :ref:`twitter` plugin,
   since the Twitter API does not have a (useful) free tier anymore.
   (:issue:`310`)
 
   .. attention::
 
-    The :mod:`~reader._plugins.twitter` plugin will be removed in version 3.7.
+    The :ref:`twitter` plugin will be removed in version 3.7.
 
 
 Version 3.5
@@ -135,7 +138,7 @@ This release marks *reader*'s `5th anniversary`_ and its 2000th commit.
         reader._parser.session_factory.request_hooks.append(...)
         reader._parser.session_factory.response_hooks.append(...)
 
-* :mod:`~reader._plugins.twitter` plugin:
+* :ref:`twitter` plugin:
   don't fail when deserializing tweets with missing ``edit_history_tweet_ids``
   (fails in tweepy 4.11, warns in tweepy >4.12).
 
@@ -352,7 +355,7 @@ Version 2.13
 
 Released 2022-06-28
 
-* Add the :mod:`~reader._plugins.twitter` experimental plugin,
+* Add the :ref:`twitter` experimental plugin,
   which allows using a Twitter account as a feed.
   (:issue:`271`)
 * Skip with a warning entries that have no <guid> or <link> in an RSS feed;

README.rst

@@ -42,9 +42,6 @@ and without depending on a particular framework.
 *reader* allows you to:
 
 * retrieve, store, and manage **Atom**, **RSS**, and **JSON** feeds
-
-  * and even follow **Twitter** accounts
-
 * mark articles as read or important
 * add arbitrary tags/metadata to feeds and articles
 * filter feeds and articles

docs/internal.rst

@@ -14,6 +14,8 @@ without using :class:`~reader.Reader` itself.
     it is not stable yet and might change without any notice.
 
 
+.. _parser:
+
 Parser
 ------
 

docs/plugins.rst

@@ -38,15 +38,31 @@ use the entry point as a :ref:`custom plugin <custom plugins>`::
     >>> reader = make_reader("db.sqlite", plugins=[sqlite_releases.init])
 
 
-.. _twitter:
-.. automodule:: reader._plugins.twitter
 .. automodule:: reader._plugins.cli_status
 .. automodule:: reader._plugins.preview_feed_list
 .. automodule:: reader._plugins.enclosure_tags
 .. automodule:: reader._plugins.sqlite_releases
 .. automodule:: reader._plugins.tumblr_gdpr
 
 
+.. _twitter:
+
+twitter
+~~~~~~~
+
+Prior to version 3.7, *reader* had a Twitter plugin;
+it was removed because
+it's not possible to get tweets using the free API tier anymore.
+
+However, the plugin used the internal :ref:`parser` API in new and interesting ways
+– it mapped the multiple tweets in a thread to a single entry,
+and stored old tweets alongside the rendered HTML content
+to avoid retrieving them again when updating the thread/entry.
+
+You can still find the code
+`on GitHub <https://github.com/lemon24/reader/blob/3.6/src/reader/_plugins/twitter.py>`_.
+
+
 
 Loading plugins from the CLI and the web application
 ----------------------------------------------------

docs/why.rst

@@ -20,7 +20,6 @@ Are you already working with `feedparser`_, but:
 * want to restrict or deny file-system access?
 * want to change the way feeds are retrieved by using the more familiar `requests`_ library?
 * want to also support `JSON Feed`_?
-* want to follow :ref:`Twitter <twitter>` accounts?
 * want to support custom information sources?
 
 ... while still supporting all the feed types feedparser does?