Subber

Subber is a web-based application that allows active reddit users to discover subreddits based on post history and subscription data.

Prerequisites

To deploy Subber, you must obtain an API key and application ID.

1. Go to your Reddit authorized apps page.
2. Click the "are you a developer? create an app..." button at the bottom of the page.
3. Fill out the form with the appropriate details, ensuring that script is selected.

After submitting the form, add your Reddit API credentials to subber.cfg.

# Move and edit example config
cp subber.cfg.example subber.cfg
vi subber.cfg

Run Subber in a container (recommended)

This section assumes you have Docker and GNU Make installed.

NOTE: Your user must be authorized to run Docker commands.

# Build Subber
make

# Run Subber
make run

To stop the container, execute:

make stop

See the "Using Subber" section for usage details.

Run Subber as a Python package (for developers)

NOTE: Running Subber as a Python package on Windows is not supported, due to Gunicorn's dependence on the fnctl module. However, running Subber in a container on Windows is still supported.

# Install Subber and project dependencies
make install

Start REST API with timeout value:

gunicorn subber.subber:app -t 900

Using Subber

Request subreddit recommendations for a user by opening your browser and visiting 127.0.0.1:8000.

NOTE: This may take a few moments.

Troubleshooting

If a runtime error occurs while Subber is running, Subber will terminate and log detailed error messages in subber.log. If more details are not available, please file an issue on the Subber issues page along with a copy of your subber.log file.