Skip to content

Platform: Setup & Run from Source

Jump to bottom
toddrob edited this page Nov 10, 2019 · 1 revision

The recommended method of running redball is using Docker. If you wish to run from source, follow the below steps.

Before you begin, ensure you have Python 3 installed, preferably Python 3.7+ for database backup support. Python 2.7 support is ending soon, and redball is only tested and expected to work with Python 3.

Download redball from GitHub and go to the root directory of the code (folder containing redball.py).

Install required modules by running the command pip install -r requirements.txt.

  • cherrypy - web server
  • requests - connections to APIs, including Reddit and MLB StatsAPI
  • apscheduler - used for database backup and other scheduled tasks
  • pytz - timezone support
  • tzlocal - timezone support
  • praw - Reddit API
  • mlb-statsapi - MLB API
  • pyOpenSSL - HTTPS support for web interface
  • mako - used for web and bot templates

After required modules are installed, run redball.py from the root directory of the code.

Application startup will be logged to logs\redball.log with debug log level by default. To enable debug logging in the console during startup, use the -v or --verbose command line argument (redball.py -v).

To disable console logging during startup, use the -q or --quiet command line argument (redball.py -q). To manage logging settings outside the startup process, go to the System Config page of the web interface.

Clone this wiki locally