Merge branch 'usertimeline'

Author: mpentler

README.md

@@ -1,5 +1,5 @@
 # teletext-twitter
-Reads your Twitter timeline or searches for tweets and turns them into teletext pages for your Raspberry Pi
+Display Twitter timelines or searches for tweets and turns them into teletext pages for your Raspberry Pi
 
 ![Screenshot](https://i.imgur.com/xwnfUw3.jpg "Screenshot of output 1")
 ![Screenshot](https://i.imgur.com/XuiyOsE.jpg "Screenshot of output 2")
@@ -24,11 +24,13 @@ After getting these up and running there are some setup tasks to do. Rename conf
 
 1) Your Twitter access tokens: You can find a good guide for doing this here - https://iag.me/socialmedia/how-to-create-a-twitter-app-in-8-easy-steps/ You will need to pick a unique name for the app. Which is annoying. Pick anything you want that isn't taken. Maybe add your name at the end.
 2) Check where your pages will be saved to: Change the tti_path line too if you've changed your Teefax location. You can also customise the page number.
-3) Change the colours if you want: Theme support is detailed below
+3) Change the theme if you want: Theme support is detailed below
+
+## Usage
 
 When you've setup your config.py you can run the script like this example that grabs your home timeline:
 
-`python3 teletext-twitter -t` (add -h to show options - also listed below)
+`python3 teletext-twitter -m home` (add -h to show options - also listed below)
 
 The script will constantly update your chosen page number (default is 153 - chosen because it used to be used for this purpose on Teefax in the past) in the main teletext folder (which defaults in VBIT2 to /home/pi/teletext/).
 
@@ -48,7 +50,7 @@ You can change the colours of the main header bar and the thin separator.
 
 You can also change the colours of a tweet poster's username, timestamp, and the text of the tweet itself.
 
-Finally, the title text at the top can be changed, although there is a character limit.
+Finally, the title text at the top can be changed, although there is a 30 character limit or things look wonky.
 
 ## Notes
 * At this moment in time the script reads 5 tweets. Further versions will improve on this by writing multiple tweets, possibly in subpages :-O
@@ -61,17 +63,16 @@ Apart from those notes, things should work ok. Have fun, turn back the clock, an
 ### -h/--help output
 
 <pre>
-usage: teletext-twitter.py [-h] [-t] [-s] [-q QUERY] [-d DELAY] [-v] [-Q]
+usage: teletext-twitter.py [-h] [-m MODE] [-q QUERY] [-d DELAY] [-v] [-Q]
 
 Reads your Twitter timeline and turns it into teletext pages for your Raspberry Pi.
 
 optional arguments:
   -h, --help            show this help message and exit
-  -t, --timeline        download your latest home timeline
-  -s, --search          specify a term to search for
+  -m, --mode            
   -q QUERY, --query QUERY
-                        a search query, hashtags supported if you put quotes
-                        around the string
+                        a search query - username or search term. hashtags 
+                        supported if you put quotes around the string
   -d DELAY, --delay DELAY
                         seconds between timeline scrapes (minimum is 60
                         seconds - lower values have no effect)

changelog.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### v0.6
+- New mode added: show latest tweets from a certain user
+- cmd line switches changed to accommodate user mode
+- logo looks less like a dog
+- bug fix: tweet cleaning now works in search mode
+- bug fix: added curly quote->normal quote replacement
+- default config file wasn't formatted right
+
 ### v0.5.3
 - Page number now user-customisable
 

config.py-default

@@ -2,10 +2,8 @@
 
 # twitter keys
 consumer_key = "XxXxXxxXXXxxxxXXXxXX" 
-consumer_secret = 
-"xXXXXXXXXxxxxXxXXxxXxxXXxXxXxxxxXxXXxxxXXx" 
-access_key = 
-"XXXXXXXX-xxXXxXXxxXxxxXxXXxXxXxXxxxXxxxxXxXXxXxxXX"
+consumer_secret = "xXXXXXXXXxxxxXxXXxxXxxXXxXxXxxxxXxXXxxxXXx" 
+access_key = "XXXXXXXX-xxXXxXXxxXxxxXxXXxXxXxXxxxXxxxxXxXXxXxxXX"
 access_secret = "XxXXXXXXXXxxxXXXxXXxXxXxxXXXXXxXxxXXXXx"
 
 # theme section

teletext-twitter/__main__.py

@@ -21,26 +21,21 @@
 def parse_args():
     parser = argparse.ArgumentParser(description="Reads your Twitter timeline and turns it into teletext pages for your Raspberry Pi.")
 
-    parser.add_argument("-t", "--timeline", action="store_true", dest="home_timeline", help="download your latest home timeline", default=False)
-    parser.add_argument("-s", "--search", action="store_true", dest="search", help="specify a term to search for")
-    parser.add_argument("-q", "--query", type=str, help="a search query, hashtags supported if you put quoted around the string")
+    parser.add_argument("-m", "--mode", type=str, help="choose between different modes - home, user or search")
+    parser.add_argument("-q", "--query", type=str, help="a search query, either a search term or a username. hashtags supported if you put quotes around the string")
     parser.add_argument("-d", "--delay", type=int, default=60, help="seconds between timeline scrapes (minimum is 60 seconds - lower values have no effect)")
-    parser.add_argument("-v", "--version", action="version", version="0.5.3")
+    parser.add_argument("-v", "--version", action="version", version="0.6")
     parser.add_argument("-Q", "--quiet", action="store_true", default=False, help="suppresses all output to the terminal except warnings and errors")
 
     args = parser.parse_args()
     args.delay = max(60, args.delay)
 
-    if not args.home_timeline and not args.search:
-        print("[!] No mode specified. Use -t or -s arguments. Exiting...", file=sys.stderr)
+    if args.mode == "search" and not args.query:
+        print("[!] Search mode selected but no query specfied with -q. Exiting...", file=sys.stderr)
         sys.exit(1)
 
-    if args.home_timeline and args.search:
-        print("[!] Home timeline and search options cannot be selected together. Exiting...", file=sys.stderr)
-        sys.exit(1)
-
-    if args.search and not args.query:
-        print("[!] Search option selected but no query specfied with -q. Exiting...", file=sys.stderr)
+    if args.mode == "user" and not args.query:
+        print("[!] User timeline mode selected but no username specified. Exiting...", file=sys.stderr)
         sys.exit(1)
 
     return args
@@ -54,14 +49,18 @@ def main():
     while True:
         try:
             write_header(config)
-            if args.home_timeline:
+            if args.mode == "home":
                 if not args.quiet:
                     print("[*] Beginning home timeline scraping", file=sys.stdout)
-                write_timeline(twitter_object, config)
-            elif args.search:
+                write_home_timeline(twitter_object, config)
+            elif args.mode == "search":
                 if not args.quiet:
                     print("[*] Getting recent tweets containing: " + args.query, file=sys.stdout)
                 write_search_term(twitter_object, args.query, config)
+            elif args.mode == "user":
+                if not args.quiet:
+                    print("[*] Getting all tweets from user: @{}".format(args.query), file=sys.stdout)
+                write_user_timeline(twitter_object, args.query, config)
             if not args.quiet:
                 print("[*] Page updated. Waiting {} seconds until next scrape".format(args.delay), file=sys.stdout)
         except OSError as e:

teletext-twitter/output.py

@@ -10,7 +10,7 @@
 ESCAPE = chr(27)
 DOUBLE_HEIGHT = ESCAPE + chr(77)
 SET_BACKGROUND = ESCAPE + chr(93)
-TWITTER_BIRD = chr(105) + chr(108) + chr(39)
+TWITTER_BIRD = chr(41) + chr(108) + chr(39)
 text_colours = {"red" : 65, "green" : 66, "yellow" : 67 , "blue" : 68, "magenta" : 69, "cyan" : 70, "white" : 71}
 mosaic_colours = {"red" : 81, "green" : 82, "yellow" : 83, "blue" : 84, "magenta" : 85, "cyan" : 86, "white" : 87}
 
@@ -42,7 +42,7 @@ def write_header(config): # write a header for the page and pop a nice banner at
                    page_title + logo_spacer + ESCAPE + chr(mosaic_colours["cyan"]) + TWITTER_BIRD + "\r\n")
         file.write("OL,3," + ESCAPE + chr(mosaic_colours[config["header_separator"]]) + (chr(35) * 39) + "\r\n")
 
-def write_timeline(twitter_object, config): # grab the latest timeline - only 5 tweets for now
+def write_home_timeline(twitter_object, config): # grab the latest timeline - only 5 tweets for now
     statuses = twitter_object.GetHomeTimeline(count = 5)
     line_position = 4
 
@@ -51,7 +51,7 @@ def write_timeline(twitter_object, config): # grab the latest timeline - only 5
         tweet_time = time.strptime(status.created_at,"%a %b %d %H:%M:%S +0000 %Y")
         tweet_human_time = time.strftime("%d-%b-%Y %H:%M", tweet_time) # reformat time/date output
         tweet_username = status.user.screen_name
-        tweet_text = textwrap.wrap(tweet_text, 39) # make sure our lines fit on the screen
+        tweet_text = textwrap.wrap(tweet_text, 38) # make sure our lines fit on the screen
 
         if (line_position + len(tweet_text) + 1) > 24: # are we going to fill the page?
             break # yep! dump the last tweet!
@@ -61,7 +61,7 @@ def write_timeline(twitter_object, config): # grab the latest timeline - only 5
             line_position += 1
             for line in tweet_text:
                 write_tweet_line(file, line_position, line, config)
-                line_position += 1
+                line_position += 11
 
 def write_search_term(twitter_object, search_term, config): # search recent tweets with a particular search term
     statuses = twitter_object.GetSearch(term=search_term, result_type="recent", count=5)
@@ -72,7 +72,30 @@ def write_search_term(twitter_object, search_term, config): # search recent twee
         tweet_time = time.strptime(status.created_at,"%a %b %d %H:%M:%S +0000 %Y")
         tweet_human_time = time.strftime("%d-%b-%Y %H:%M", tweet_time) # reformat time/date output
         tweet_username = status.user.screen_name
-        tweet_text = textwrap.wrap(status.text, 39) # make sure our lines fit on the screen
+        tweet_text = textwrap.wrap(tweet_text, 38) # make sure our lines fit on the screen
+
+        if (line_position + len(tweet_text) + 1) > 24: # are we going to fill the page?
+            break # yep! dump the last tweet!
+
+        with open(config["tti_path"] + "P" + str(config["page_number"]) + ".tti", "a") as file:
+            write_tweet_info(file, line_position, tweet_username, tweet_human_time, config)
+            line_position += 1
+            for line in tweet_text:
+                write_tweet_line(file, line_position, line, config)
+                line_position += 1
+
+def write_user_timeline(twitter_object, username, config):
+    print("user mode, username: @{}".format(username))
+
+    statuses = twitter_object.GetUserTimeline(screen_name=username, count=5)
+    line_position = 4
+
+    for status in statuses: # iterate through our responses
+        tweet_text = clean_tweet(status.text)
+        tweet_time = time.strptime(status.created_at,"%a %b %d %H:%M:%S +0000 %Y")
+        tweet_human_time = time.strftime("%d-%b-%Y %H:%M", tweet_time) # reformat time/date output
+        tweet_username = status.user.screen_name
+        tweet_text = textwrap.wrap(tweet_text, 38) # make sure our lines fit on the screen
 
         if (line_position + len(tweet_text) + 1) > 24: # are we going to fill the page?
             break # yep! dump the last tweet!

teletext-twitter/processor.py

@@ -8,6 +8,7 @@
 
 # character replacement and stripping function
 def clean_tweet(tweet):
+    # first, get rid of as many emojis as possible
     emoji_pattern = re.compile("[" # our unicode ranges go here. this will need frequent tweaking
                               u"\U00002300-\U000023FF" # misc technical
                               u"\U000024C2-\U0001F251" # enclosed characters including flags
@@ -17,8 +18,10 @@ def clean_tweet(tweet):
                                "]+", flags=re.UNICODE)
     tweet = emoji_pattern.sub(r'', tweet)
 
-    tweet = tweet.replace("’", "'") # replacing some problematic characters here
-    tweet = tweet.replace("_", "-") # the teletext English character set doesn't
-    tweet = tweet.replace("#", "_") # support a lot of things!
+    # Now our character substitutions. The teletext English character set doesn't support a lot of characters!
+    tweet = tweet.replace("’", "'")
+    tweet = tweet.replace("_", "-")
+    tweet = tweet.replace("#", "_")
+    tweet = tweet.replace('“', '"')
 
     return tweet