timeline scrolle, rate limits, image options

Author: bison--

conf.py

@@ -8,7 +8,14 @@
 LANGUAGE = 'en'
 SHOW_TOOTS_AT_ONCE = 10
 
+# 300 requests per 5 minutes is the limit for mastodon.social
+# seconds to wait before the timeline scroller requests the next toot if there was no new toot
+SCROLLER_DELAY_HAS_NO_TOOTS = 10
+# time you have to read a new toot before the scroller requests the next toot
+SCROLLER_DELAY_HAS_TOOTS = 5
+
 TERMINAL_IMAGES = True  # if requirements-full.txt is not installed, this will be set to False automatically
 TERMINAL_IMAGE_OPTIMIZER = 'space'
-TERMINAL_IMAGE_MAX_WIDTH = 80
+
+TERMINAL_IMAGE_MAX_WIDTH = 60  # -1 means auto-detected width
 TERMINAL_IMAGE_MAX_HEIGHT = 40

inc/RateLimit.py

@@ -0,0 +1,57 @@
+from datetime import datetime, timezone
+from dateutil.tz import tz
+
+
+class RateLimit:
+    def __init__(self):
+        self.has_been_set = False
+        self.limit = 0
+        self.remaining = 0
+        self.reset_date_time: datetime = datetime.now()
+
+    def exceeded(self):
+        # we do not know the current rate limit, so we can't check
+        if not self.has_been_set:
+            return False
+
+        if self.remaining == 0:
+            if self.time_until_reset() > 0:
+                return True
+
+        return False
+
+    def cleared(self):
+        self.has_been_set = False
+        self.limit = 0
+        self.remaining = 0
+        self.reset_date_time = 0
+
+    def set_rate_limit(self, limit, remaining, reset):
+        self.has_been_set = True
+        self.limit = limit
+        self.remaining = remaining
+        self.reset_date_time = reset
+
+    def time_until_reset(self):
+        if not self.has_been_set:
+            return 0
+
+        return (self.reset_date_time - datetime.now()).total_seconds()
+
+    def update(self, headers):
+        reset_date_time = datetime.strptime(
+            headers["X-RateLimit-Reset"], '%Y-%m-%dT%H:%M:%S.%f%z'
+        ).astimezone(tz=tz.tzlocal())
+        reset_date_time = reset_date_time.replace(tzinfo=None)
+
+        self.set_rate_limit(
+            int(headers["X-RateLimit-Limit"]),
+            int(headers["X-RateLimit-Remaining"]),
+            reset_date_time
+        )
+
+    def __str__(self):
+        return f'Limit: {self.limit}, Remaining: {self.remaining}, Reset: {self.reset_date_time}, Time until reset: {self.time_until_reset()}'
+
+
+rate_limit = RateLimit()

inc/TerminalImage.py

@@ -66,9 +66,19 @@ def render_image(self, image_path):
         if not conf.TERMINAL_IMAGES:
             return
 
+        image_max_width = conf.TERMINAL_IMAGE_MAX_WIDTH
+        if image_max_width == -1:
+            try:
+                image_max_width = helper.get_terminal_width()
+                # image width debug
+                #helper.print_color('image_max_width: {}'.format(image_max_width), helper.Color.YELLOW)
+            except Exception as ex:
+                helper.print_color(ex, helper.Color.RED)
+                image_max_width = 80
+
         renderer = img2unicode.Renderer(
             default_optimizer=self.optimizer,
-            max_w=conf.TERMINAL_IMAGE_MAX_WIDTH,
+            max_w=image_max_width,
             max_h=conf.TERMINAL_IMAGE_MAX_HEIGHT
         )
 

inc/helper.py

@@ -1,12 +1,20 @@
-# Define the colors using ANSI escape codes
+import shutil
 
+# Define the colors using ANSI escape codes
 class Color:
     GREEN = '\033[92m'
     YELLOW = '\033[93m'
     RED = '\033[91m'
 
+    BLUE = '\033[94m'
+
     RESET = '\033[0m'  # Reset color
 
 
 def print_color(text, color):
     print(f'{color}{text}{Color.RESET}')
+
+
+def get_terminal_width():
+    terminal_width = shutil.get_terminal_size().columns
+    return terminal_width

main.py

@@ -7,9 +7,10 @@ def main_menu():
     print('*************')
     print('1. do Toot')
     print('2. read toots')
-    print('3. download user toots')
-    print('4. search user toots')
-    print('5. EXIT')
+    print('3. timeline scroller')
+    print('4. download user toots')
+    print('5. search user toots')
+    print('6. EXIT')
     print('*************')
     user_choice = input('> choice: ')
 
@@ -18,8 +19,10 @@ def main_menu():
     elif user_choice == '2':
         readToots.read_toots()
     elif user_choice == '3':
-        searchUserToots.do_download()
+        readToots.scroller_choice()
     elif user_choice == '4':
+        searchUserToots.do_download()
+    elif user_choice == '5':
         searchUserToots.do_search()
     else:
         return False

readToots.py

@@ -1,6 +1,8 @@
 import requests
 import html2text
-from datetime import datetime
+import time
+import inc.helper as helper
+import inc.RateLimit as RateLimit
 from inc.TerminalImage import TerminalImage
 from inc.TootRendererBase import TootRendererBase
 from inc.TootRendererSimple import TootRendererSimple
@@ -20,20 +22,32 @@
 
 
 # Get the latest toots from the home timeline
-def get_toots(max_id=None, limit=conf.SHOW_TOOTS_AT_ONCE):
+def get_toots(max_id=None, limit=conf.SHOW_TOOTS_AT_ONCE, timelines='home', min_id=None):
+    if RateLimit.rate_limit.exceeded():
+        helper.print_color("Rate limit exceeded. Please wait {} seconds.".format(RateLimit.rate_limit.time_until_reset()), helper.Color.RED)
+        return []
+
     params = {}
 
     if max_id:
         params["max_id"] = max_id
 
+    if min_id:
+        params["min_id"] = min_id
+
     if limit:
         params["limit"] = limit
 
-    response = requests.get(base_url + "timelines/home", headers=headers, params=params)
+    response = requests.get(base_url + "timelines/" + timelines, headers=headers, params=params)
+    RateLimit.rate_limit.update(response.headers)
+
+    # rate limit debug
+    #helper.print_color(RateLimit.rate_limit, helper.Color.BLUE)
+
     if response.status_code == 200:
         return response.json()
     else:
-        print("Error retrieving toots.")
+        helper.print_color("Error retrieving toots. {} Code: {}".format(response.reason, response.status_code), helper.Color.RED)
         return []
 
 
@@ -92,11 +106,72 @@ def read_toots():
 
         more = input("> Do you want to see more toots? (Y/n) ")
         if more.lower() != "n":
-            toots = get_toots(toots[-1]["id"])
-            display_toots(toots)
+            toot_id = None
+            if toots:
+                toot_id = toots[-1]["id"]
+
+            new_toots = get_toots(toot_id)
+
+            if new_toots:
+                toots = new_toots
+                display_toots(toots)
         else:
             break
 
 
+def scroller_choice():
+    print('1. Home / My Timeline')
+    print('2. Server / Local')
+    print('3. Tag / Hashtag')
+    print('4. Cancel')
+    print()
+
+    choice = input("> Choose a timeline (empty for own): ").strip()
+    if choice == '1' or choice == '':
+        scroller('home')
+    elif choice == '2':
+        scroller('public')
+    elif choice == '3':
+        tag = input("> Enter a # tag: ")
+        tag = tag.replace('#', '')
+        scroller('tag/' + tag)
+    #elif choice == '5':
+    #    user = input("> Enter a user name: ")
+    #    scroller('accounts/' + user + '/statuses')
+    #elif choice == '6':
+    #    search_term = input("> Enter a search term: ")
+    #    scroller('search?limit=40&q=' + search_term)
+    elif choice == '4':
+        return
+    else:
+        print('Invalid choice')
+
+
+def scroller(timelines='home'):
+    # Get the first set of toots
+    toots = get_toots(limit=1, timelines=timelines)
+    toots.reverse()
+    display_toots(toots)
+
+    try:
+        while True:
+            toot_id = None
+            if toots:
+                toot_id = toots[0]["id"]
+
+            new_toots = get_toots(limit=1, min_id=toot_id, timelines=timelines)
+
+            if new_toots:
+                toots = new_toots
+                display_toots(toots)
+                time.sleep(conf.SCROLLER_DELAY_HAS_TOOTS)
+            else:
+                time.sleep(conf.SCROLLER_DELAY_HAS_NO_TOOTS)
+
+    except KeyboardInterrupt:
+        # allow canceling the scroller
+        return
+
+
 if __name__ == '__main__':
     read_toots()