Remove twitter :( (#83)

* fix: Remove Twitter because it no longer works :( * v0.7.0 * fix: Add mastodon to utils
j6k4m8 · Aug 7, 2023 · ceb39f9 · ceb39f9
1 parent 0785f32
commit ceb39f9
Show file tree

Hide file tree

Showing 12 changed files with 49 additions and 172 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,16 +1,18 @@
 # CHANGELOG
 
-### **0.?.?** (Unreleased)
+### **0.7.0** (August 7 2023)
 
-- Fixes
-      - Fixed a bug where the weather provider would not correctly render celsius unit marker
+-   Fixes
+    -   Fixed a bug where the weather provider would not correctly render celsius unit marker
+    -   Fixed the RSS story provider,
+-   Improvements
+    -   added a Mastodon story provider (#82)
+    -   Removed the Twitter story provider, which no longer works due to Twitter's API changes
 
 ### **0.6.0** (June 5 2022)
 
 -   Improvements
-
     -   Enable writing a BytesIO object instead of creating a file. Good for cases where you're running goosepaper on unprivileged systems.
-
 -   Fixes
     -   Fixed the old broken weather provider by switching to Open-Meteo.
     -   No longer builds images on pull-request branches.
@@ -25,37 +27,29 @@
 ### **0.5.0** (January 14 2022)
 
 -   Improvements
-
     -   RSS stories now "fall back" gracefully on just rendering the title, if the full body cannot be rendered. This is in contrast with the old behavior, in which the story would not be rendered at all.
     -   RSS, Reddit, and Twitter story providers now support a `since_days_ago` argument in their `config` dictionaries that enables you to specify how many days ago to start the search for stories. Older stories will not be included.
     -   Add support for multiple styles, using the `"styles" config option. Options are `"Academy"`, `"FifthAvenue"`, and `"Autumn"`. Previous style (before v0.4.0) was `Autumn`.
-
 -   Housekeeping
-
     -   Moved the story providers into their own submodule: Note that this may break backward compatibility if you import these directly.
 
 ### **0.4.0** (January 13 2022)
 
 > Multiple fixes and improvements
 
 -   Fixes
-
     -   Changed some document name comparisons to case insensitive (prevent document overwrites, esp. for Windows users)
     -   Switched upload to require named arguments rather than positional
     -   Fixes the `limit` arg in the RSS provider, which was being ignored
-
 -   Improvements
-
     -   Improve typing support
     -   Added more error handling for file and syntax handling
     -   Change to using the `VissibleName` attribute in all cases rather than filename
     -   Added code for upcoming additional sanity checks
     -   Added more information on how to customize your goospaper in the docs, @kwillno (#54)
     -   Adds the option to provide a global config (thanks @sedennial! #48)
     -   Lots of new options to customize the upload and generation process (thanks @sedennial! #48)
-
 -   Housekeeping
-
     -   Fixes a bunch of flake8 errors and warnings to keep things tidy
 
 ### **0.3.1** (April 29 2021)

diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@
 
 goosepaper is a utility that delivers a daily newspaper to your remarkable tablet. that's cute!
 
-you can include RSS feeds, Twitter feeds, news articles, wikipedia articles-of-the-day, weather, and more. I read it when I wake up so that I can feel anxious without having to get my phone.
+you can include RSS feeds, Mastodon feeds, news articles, wikipedia articles-of-the-day, weather, and more. I read it when I wake up so that I can feel anxious without having to get my phone.
 
 ## survey
 
@@ -112,7 +112,7 @@ Check out [this example PDF](https://github.com/j6k4m8/goosepaper/blob/master/do
 ## existing story providers ([want to write your own?](https://github.com/j6k4m8/goosepaper/blob/master/CONTRIBUTING.md))
 
 -   [Wikipedia Top News / Current Events](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/wikipedia.py)
--   [Tweets](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/twitter.py)
+-   [Mastodon Toots](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/mastodon.py)
 -   [Weather](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/weather.py). These stories appear in the "ear" of the front page, just like a regular ol' newspaper
 -   [RSS Feeds](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/rss.py)
 -   [Reddit Subreddits](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/reddit.py)
@@ -135,7 +135,9 @@ I do not think so, but it is a good question!
 
 ### may i use this to browse twitter?
 
-yes you may! you can add a list of usernames to the feed generator and it will make a print-ready version of twitter. this is helpful for when you are on twitter on your laptop but wish you had Other Twitter as well, in print form.
+~~yes you may! you can add a list of usernames to the feed generator and it will make a print-ready version of twitter. this is helpful for when you are on twitter on your laptop but wish you had Other Twitter as well, in print form.~~
+
+no! twitter has changed and now no one can play nicely with them. sorry! it is sad!
 
 # You May Also Like...
 

diff --git a/docs/Customizing.md b/docs/Customizing.md
@@ -17,13 +17,6 @@ As an example we give the config delivered as an example `example-config.json`:
                 "F": true
             }
         },
-        {
-            "provider": "twitter",
-            "config": {
-                "usernames": ["axios", "NPR"],
-                "limit_per": 8
-            }
-        },
         {
             "provider": "wikipedia_current_events",
             "config": {}
@@ -91,7 +84,7 @@ For more information on the styles and to see a gallery of the different stylesh
 
 ## Stories and StoryProviders
 
-Stories in a Goosepaper are created by a StoryProvider. You can think of a StoryProvider as a "source." So you might have Twitter stories (`TwitterStoryProvider`), some blog posts (`RSSFeedStoryProvider`), etc.
+Stories in a Goosepaper are created by a StoryProvider. You can think of a StoryProvider as a "source." So you might have wikipedia stories (`WikipediaCurrentEventsStoryProvider`), some blog posts (`RSSFeedStoryProvider`), etc.
 
 This section aims to be a comprehensive list of all storyproviders and how to configure them.
 (This was the case at time of writing.)
@@ -125,7 +118,6 @@ Right now, these are the storyproviders built into this repository:
 -   [CustomText](#CustomText)
 -   [Reddit](#Reddit)
 -   [RSS](#RSS)
--   [Twitter](#Twitter)
 -   [Weather](#Weather)
 -   [Wikipedia Current Events](#Wikipedia)
 
@@ -192,21 +184,22 @@ Default limiting value is `5`.
 | `limit`          | int  | 5       | The number of stories to get.           |
 | `since_days_ago` | int  | None    | If provided, filter stories by recency. |
 
-### <a name="Twitter">Twitter</a>
+### <a name="Mastodon">Mastodon</a>
 
 ```json
-"provider"	: "twitter"
+"provider"	: "mastodon"
 ```
 
-Returns tweets from given users.
+Returns toots from given users.
 
 #### Parameters:
 
-| Parameter        | Type             | Default | Description                                                 |
-| ---------------- | ---------------- | ------- | ----------------------------------------------------------- |
-| `usernames`      | str or list[str] | None    | Twitter usernames to use. Can be a single username or list. |
-| `limit`          | int              | 8       | The number of stories to get.                               |
-| `since_days_ago` | int              | None    | If provided, filter stories by recency.                     |
+| Parameter        | Type | Default | Description                                           |
+| ---------------- | ---- | ------- | ----------------------------------------------------- |
+| `username`       | str  | None    | Mastodon username to use.                             |
+| `limit`          | int  | 8       | The number of stories to get.                         |
+| `since_days_ago` | int  | None    | If provided, filter stories by recency.               |
+| `server`         | str  | None    | The server to use (e.g., "https://neuromatch.social") |
 
 ### <a name="Weather">Weather</a>
 

diff --git a/docs/example_library_usage.py b/docs/example_library_usage.py
@@ -4,7 +4,6 @@
 from goosepaper.goosepaper import Goosepaper
 from goosepaper.storyprovider.reddit import RedditHeadlineStoryProvider
 from goosepaper.storyprovider.rss import RSSFeedStoryProvider
-from goosepaper.storyprovider.twitter import MultiTwitterStoryProvider
 from goosepaper.storyprovider.weather import OpenMeteoWeatherStoryProvider
 from goosepaper.storyprovider.wikipedia import WikipediaCurrentEventsStoryProvider
 from goosepaper.upload import upload
@@ -21,7 +20,6 @@
         OpenMeteoWeatherStoryProvider(lat=42.3601, lon=-71.0589, F=True),
         RSSFeedStoryProvider("https://www.npr.org/feed/", limit=5),
         RSSFeedStoryProvider("https://www.statnews.com/feed/", limit=2),
-        MultiTwitterStoryProvider(["reuters", "bbcWorld", "axios", "NPR"], limit_per=5),
         RedditHeadlineStoryProvider("news"),
         RedditHeadlineStoryProvider("todayilearned"),
     ]

diff --git a/example-config.json b/example-config.json
@@ -10,13 +10,11 @@
             }
         },
         {
-            "provider": "twitter",
+            "provider": "mastodon",
             "config": {
                 "since_days_ago": 0.5,
-                "usernames": [
-                    "axios",
-                    "NPR"
-                ],
+                "username": "jordan",
+                "server": "https://neuromatch.social",
                 "limit_per": 8
             }
         },

diff --git a/goosepaper/__init__.py b/goosepaper/__init__.py
@@ -1,3 +1,3 @@
 from .goosepaper import Goosepaper  # noqa
 
-__version__ = "0.6.0"
+__version__ = "0.7.0"
diff --git a/goosepaper/storyprovider/test_mastodon.py b/goosepaper/storyprovider/test_mastodon.py
@@ -1,5 +1,3 @@
-# neuromatch.social/@jordan.rss
-
 from .mastodon import MastodonStoryProvider
 
 

diff --git a/goosepaper/storyprovider/twitter.py b/goosepaper/storyprovider/twitter.py
diff --git a/goosepaper/test_utils.py b/goosepaper/test_utils.py
@@ -21,14 +21,32 @@ def test_clean_text():
 def test_construct_story_providers_from_config_dict():
     assert construct_story_providers_from_config_dict({}) == []
     stories = construct_story_providers_from_config_dict(
-        {"stories": [{"provider": "twitter", "config": {"usernames": "j6m8"}}]}
+        {
+            "stories": [
+                {
+                    "provider": "mastodon",
+                    "config": {
+                        "server": "https://neuromatch.social",
+                        "username": "j6m8",
+                        "limit": 1,
+                    },
+                }
+            ]
+        }
     )
     assert len(stories) == 1
 
     stories = construct_story_providers_from_config_dict(
         {
             "stories": [
-                {"provider": "twitter", "config": {"usernames": ["j6m8"]}},
+                {
+                    "provider": "mastodon",
+                    "config": {
+                        "server": "https://neuromatch.social",
+                        "username": "j6m8",
+                        "limit": 1,
+                    },
+                },
                 {"provider": "reddit", "config": {"subreddit": "worldnews"}},
             ]
         }

diff --git a/goosepaper/util.py b/goosepaper/util.py
@@ -57,20 +57,19 @@ def load_config_file(filepath: str) -> dict:
 
 
 def construct_story_providers_from_config_dict(config: dict):
-
     from goosepaper.storyprovider.rss import RSSFeedStoryProvider
-    from goosepaper.storyprovider.twitter import MultiTwitterStoryProvider
     from goosepaper.storyprovider.reddit import RedditHeadlineStoryProvider
+    from goosepaper.storyprovider.mastodon import MastodonStoryProvider
     from goosepaper.storyprovider.storyprovider import CustomTextStoryProvider
     from goosepaper.storyprovider.weather import OpenMeteoWeatherStoryProvider
     from goosepaper.storyprovider.wikipedia import WikipediaCurrentEventsStoryProvider
 
     StoryProviderConfigNames = {
         "lorem": CustomTextStoryProvider,
         "text": CustomTextStoryProvider,
-        "twitter": MultiTwitterStoryProvider,
         "reddit": RedditHeadlineStoryProvider,
         "weather": OpenMeteoWeatherStoryProvider,
+        "mastodon": MastodonStoryProvider,
         "openmeteo_weather": OpenMeteoWeatherStoryProvider,
         "wikipedia_current_events": WikipediaCurrentEventsStoryProvider,
         "rss": RSSFeedStoryProvider,

diff --git a/requirements.txt b/requirements.txt
@@ -4,10 +4,6 @@ requests
 # for rss feeds and reddit:
 feedparser
 
-# for twitter stories:
-git+https://github.com/twintproject/twint.git@origin/master#egg=twint
-pandas
-
 # for wikipedia stories:
 bs4
 lxml

diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 from codecs import open as copen
 from setuptools import setup, find_packages
 
-__version__ = "0.6.0"
+__version__ = "0.7.0"
 
 
 here = path.abspath(path.dirname(__file__))