README.md

reddit_utils

A collection of reddit utility scripts organized as a self-hosted web app. Currently the following features are available:

• Search through your saved posts (submissions/comments)
• Ability to fetch your subreddits

GIF of Search Interface Looking at Saved Posts Trying the List Subreddits feature

Install Process

1. Clone the repository to your local machine
2. Make sure Python 3.5+ is installed
3. Build a .whl (wheel) file
4. Set up a virtual environment
5. Install the .whl file
6. Run the flask app
7. Open http://localhost:5000 in browser

Full instructions can be found here

Note: This web app is meant to be self-hosted on something like a Raspberry Pi

Development Process

This web app is built on Flask + Bootstrap 4 + PRAW

Here are the general instructions:

1. Create a virtual environment
2. Make changes to code
3. Run the flask app

The specific instructions for power shell on Windows:

1. virtualenv env
2. ./env/Scripts/activate
3. python -m pip install -e .
4. $env:FLASK_ENV = "development"
5. $env:FLASK_APP = "reddit_utils"
6. flask run

Here are some helpful links that provide more detail:

• https://virtualenv.pypa.io/en/stable/userguide/
• http://flask.pocoo.org/docs/1.0/tutorial/factory/#run-the-application
• http://flask.pocoo.org/docs/1.0/tutorial/install/#install-the-project

Contributions

Contributions to this project are welcome. If you contribute to the project, your name will appear on the about page.

Helped wanted with the following:

• Change login procedure to use web app procedure instead of the script procedure
• Add HTTPS support
• Loading indicator
• Persist saved posts for faster searching
• Ability to have multiple search terms (underlying code is there but needs GUI)
• Ability to restrict search by subreddit (underlying code is there but needs GUI)
• Ability to search your own submissions
• Ability to search past the 1000 item limit
• Ability to unhide all your posts
• Ability to export your saved posts in various formats
• For really long comments (only show the first few paragraphs or so, collapse the rest)
• Highlight search terms in results (something like this)

I will slowly add features as I need them and I encourage people to do the same

To Add Your Own Feature

1. Add it to the nav bar (file: templates/nav.htm.j2)
2. Create a usage/help modal (file: templates\modals.htm.j2)
3. Create a template file for the feature (create file in: templates\features)
4. Write the backend Python code (put code in: features)
5. Add your entry point function to the init file (file: __init__.py)

Please use the Search Saved Posts and List Subreddits features as examples

License

GNU General Public License v3.0

Disclaimer

The developer (Roman Kuleshov) of this application (reddit_utils) has no affiliation with reddit inc.