README

README.md

@@ -0,0 +1,46 @@
+# reddit-save
+
+A Python utility for backing up your reddit upvoted/saved stuff.
+
+Browsing through the stuff you've liked or saved on reddit is really enjoyable and, depending on the reason you saved something, can be a great way to recap stuff you once thought important. It is a personalised feed of posts and comments by the one person guaranteed to know what you like - past you.
+
+However over time more and more of the older posts will be deleted or missing, and the historical record atrophies. Use this tool to back up those posts and comments to your computer where you can browse them offline, and where they are safe forever.
+
+reddit-save will backup saved posts, saved comments, and upvoted posts. It can't do upvoted comments because the reddit API doesn't expose them.
+
+## Installation
+
+```bash
+$ git clone https://github.com/samirelanduk/reddit-save .
+$ cd reddit-save
+$ pip install -r requirements.txt
+$ touch secrets.py
+```
+
+If you get permission errors, try using `sudo` or using a virtual environment.
+
+You will need [ffmpeg](https://ffmpeg.org/) installed somewhere too.
+
+The last command created an empty file called secrets.py. You will need to add four things to this file, your reddit username and password, and a reddit client ID and secret. The latter two are obtained using [the instructions here](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example#first-steps). The file should look something like this:
+
+```python
+REDDIT_USERNAME = "spez"
+REDDIT_PASSWORD = "myredditpassword123"
+REDDIT_CLIENT_ID = "sadsU7-zfX"
+REDDIT_SECRET = "687DDJSS&999d-hdkjK8h"
+```
+
+## Use
+
+Create a folder that will contain your archive. Then run:
+
+```bash
+$ ./save.py saved folder_name
+$ ./save.py upvoted folder_name
+```
+
+The first command will backup your saved posts/comments to a file called folder_name/saved.html. The second will backup your upvoted posts to a file called folder_name/upvoted.html.
+
+Each post will have its top-level comments saved, as well as each of their immediate child comments (but no further).
+
+Linked media files (images, videos etc.) will be saved locally where possible, though imgur is currently not well supported in all cases.

utilities.py

@@ -5,8 +5,8 @@ from redvid import Downloader
 import youtube_dl
 import re
 from datetime import datetime
-from secrets2 import REDDIT_USERNAME, REDDIT_PASSWORD
-from secrets2 import REDDIT_CLIENT_ID, REDDIT_SECRET
+from secrets import REDDIT_USERNAME, REDDIT_PASSWORD
+from secrets import REDDIT_CLIENT_ID, REDDIT_SECRET
 
 IMAGE_EXTENSIONS = ["gif", "gifv", "jpg", "jpeg", "png"]
 VIDEO_EXTENSIONS = ["mp4"]
@@ -28,7 +28,7 @@ def get_saved_posts(client):
     """Gets a list of posts that the user has saved."""
 
     return [
-        saved for saved in client.user.me().saved(limit=5)
+        saved for saved in client.user.me().saved(limit=None)
         if saved.__class__.__name__ == "Submission"
     ]
 
@@ -193,7 +193,9 @@ def create_post_page_html(post, post_html):
     comments_html = []
     post.comments.replace_more(limit=0)
     for comment in post.comments:
-        comments_html.append(get_comment_html(comment, op=post.author.name))
+        comments_html.append(get_comment_html(
+            comment, op=post.author.name if post.author else None
+        ))
     html = html.replace("<!--comments-->", "\n".join(comments_html))
     return html