Skip to content

My CLI RSS reader written for my CMSC 16200 Final Presentation. And because Google Reader's shutting down.

Notifications You must be signed in to change notification settings

johnphp/RSS_Reader

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

Terminal-Based RSS Reader 
author: Kevin Freese
date: 3/19/13

__________________________________Description__________________________________
This program is a rudimentary RSS feed reader, to be run in a terminal command
line. Can read Atom and RSS feeds. In addition, this reader can import your
subscription list from Google Reader.

__________________________Importing Google Reader Data_________________________
Run the script with the keyword "import" and the subscriptions.xml file from 
Google Reader. 

Example: 
./rss.py import ./[google-username]@gmail.com-takeout/Reader/subscriptions.xml
                ____________________________________________
                | Don't have your data from Google Reader? |
                | Go to https://www.google.com/takeout/    |
                | to download your Google Reader data.     |
                --------------------------------------------

Now, the program will transfer your Google Reader subscription file into a new
file and format for this program to run. After that, it'll begin building a 
read history file, and once that is complete, will display all new items, 
followed by a prompt for regular runtime commands (listed in Usage section).

_____________________________________Usage_____________________________________
Run the script without any arguments (./rss.py) to start a normal run.

After the script is started, some initialization will occur, followed by a
check of all the feeds that you are subscribed to.

After that, a prompt will display. The following commands are accepted:

'check [name]':      This command checks for new updates. With a name field, 
                     it checks the feed named. Without a name field, it checks
                     all feeds.

'read {name}':       Typing this command requires a {name} field. This will
                     result in opening a page with the contents of the oldest
                     item in the feed named.
 
'mark {name}':       This command marks an item as read without opening it.

'markall [name]:     This command marks all items in the feed [name] as read.
                     If no name is supplied, this marks all items from all 
                     feeds read.

'subscribe {url}':   Typing this command will add a new feed to your
                     subscription list, and this feed will be included in
                     every future check.

'unsubscribe {name}: This command removes a feed from your subscription list. 

'list':              Displays a list of all feeds you're subscribed to.

'help':              Displays a brief description of some commands' usage.

'quit':              Exits the reader and returns to the shell.


*For all feeds which require a feed name, any substring of the feed title will
 work. Note, though, if your input is too vague, this may perform the action on
 more than one feed. (i.e. Typing 'read e' will open all new items for every 
 feed with an 'e' in the title)

____________________________________Options____________________________________
User-defined options can be found in the script itself (rss.py) under the 
heading "User-defined Options:" These options include:

data_folder:         This is the folder in which all the data for the reader is 
                     stored. Absolute paths will obviously go to that path on 
                     the drive. Relative paths or folder names without a path
                     will be created from the directory the script is run from.

subscription_file:   This is the filename for your subscription list.

history_file:        This is the filename for your read history.

updatelen:           How far back you want subscribe and newly built read
                     histories to show items, in days.

About

My CLI RSS reader written for my CMSC 16200 Final Presentation. And because Google Reader's shutting down.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published