owmains-subreddit-stats

Collect data on the Overwatch Mains subreddits

Requirements

• Python
• Docker
• Docker Compose

Setup

1. Follow Reddit's First Steps Guide to obtain a Client ID & Client Secret

2. Create a .env file in the root directory and paste the following inside it:

   CLIENT_ID=your-client-id
   CLIENT_SECRET=your-client-secret
   USER=your-reddit-username
   PASSWORD=your-reddit-password
   USER_AGENT=subcounts by u/your-reddit-username

3. Replace each field in the .env with your credentials.

4. Add the following to the .env for the docker-compose.yml

   MYSQL_HOST=localhost
   MYSQL_PORT=3306
   MYSQL_USERNAME=root
   MYSQL_PASSWORD=password
   MYSQL_ROOT_PASSWORD=password
   MYSQL_DB=owmains

   If the application is running on another machine, change localhost to it's address. Change password to a suitable password.

5. Run docker-compose up -d

6. Create and activate a virtual environment.

   python3 -m venv .venv
   source .venv/bin/activate

7. Install dependencies.

   pip install -r requirements.txt