Merge pull request #10 from Linusp/dev

add new command `fetch-starred`

Author: Linusp

inoreader/client.py

@@ -163,7 +163,7 @@ def __get_stream_contents(self, stream_id, continuation=''):
         else:
             return response['items'], None
 
-    def fetch_unread(self, folder=None, tags=None):
+    def fetch_articles(self, folder=None, tags=None, unread=True, starred=False):
         self.check_token()
 
         url = urljoin(BASE_URL, self.STREAM_CONTENTS_PATH)
@@ -172,7 +172,13 @@ def fetch_unread(self, folder=None, tags=None):
                 url,
                 quote_plus(self.GENERAL_TAG_TEMPLATE.format(folder))
             )
-        params = {'xt': self.READ_TAG, 'c': str(uuid4())}
+
+        params = {'c': str(uuid4())}
+        if unread:
+            params['xt'] = self.READ_TAG
+
+        if starred:
+            params['it'] = self.STARRED_TAG
 
         response = self.parse_response(self.session.post(url, params=params, proxies=self.proxies))
         for data in response['items']:
@@ -182,6 +188,7 @@ def fetch_unread(self, folder=None, tags=None):
             ])
             if tags and not categories.issuperset(set(tags)):
                 continue
+
             yield Article.from_json(data)
 
         continuation = response.get('continuation')
@@ -198,8 +205,17 @@ def fetch_unread(self, folder=None, tags=None):
                 if tags and not categories.issuperset(set(tags)):
                     continue
                 yield Article.from_json(data)
+
             continuation = response.get('continuation')
 
+    def fetch_unread(self, folder=None, tags=None):
+        for article in self.fetch_articles(folder=folder, tags=tags, unread=True):
+            yield article
+
+    def fetch_starred(self, folder=None, tags=None):
+        for article in self.fetch_articles(folder=folder, tags=tags, unread=False, starred=True):
+            yield article
+
     def add_general_label(self, articles, label):
         self.check_token()
 

inoreader/main.py

@@ -459,5 +459,60 @@ def dedupe(folder, thresh):
     apply_action(matched_articles, client, 'mark_as_read', None)
 
 
+@main.command()
+@click.option("-f", "--folder", help='Folder which articles belong to')
+@click.option("-t", "--tags", help="Tag(s) for filtering, seprate with comma")
+@click.option("-o", "--outfile", required=True, help="Filename to save articles")
+@click.option("--out-format",
+              type=click.Choice(['json', 'csv', 'plain', 'markdown', 'org-mode']),
+              default='json',
+              help='Format of output file, default: json')
+@catch_error
+def fetch_starred(folder, tags, outfile, out_format):
+    """Fetch starred articles"""
+    client = get_client()
+
+    tag_list = [] if not tags else tags.split(',')
+    fout = codecs.open(outfile, mode='w', encoding='utf-8')
+    writer = csv.writer(fout, delimiter=',') if out_format == 'csv' else None
+    for idx, article in enumerate(client.fetch_starred(folder=folder, tags=tag_list)):
+        if idx > 0 and (idx % 10) == 0:
+            LOGGER.info("fetched %d articles", idx)
+
+        title = article.title
+        text = article.text
+        link = article.link
+        if out_format == 'json':
+            print(json.dumps({'title': title, 'content': text, 'url': link}, ensure_ascii=False),
+                  file=fout)
+        elif out_format == 'csv':
+            writer.writerow([link, title, text])
+        elif out_format == 'plain':
+            print('TITLE: {}'.format(title), file=fout)
+            print("LINK: {}".format(link), file=fout)
+            print("CONTENT: {}".format(text), file=fout)
+            print(file=fout)
+        elif out_format == 'markdown':
+            if link:
+                print('# [{}]({})\n'.format(title, link), file=fout)
+            else:
+                print('# {}\n'.format(title), file=fout)
+
+            print(text + '\n', file=fout)
+        elif out_format == 'org-mode':
+            if link:
+                title = title.replace('[', '_').replace(']', '_')
+                print('* [[{}][{}]]\n'.format(link, title),
+                      file=fout)
+            else:
+                print('* {}\n'.format(title), file=fout)
+
+            print(text + '\n', file=fout)
+
+    LOGGER.info("fetched %d articles and saved them in %s", idx + 1, outfile)
+
+    fout.close()
+
+
 if __name__ == '__main__':
     main()