Community Chess Bot

A moderator bot for Community Chess, a collaborative chess game on Reddit.

Contributing

1. Create a virtual environment to work in

pyenv exec python -m venv .venv

2. Activate the virtual environment each time you open the project

source .venv/bin/activate

3. Install dependencies

pyenv exec pip install -r requirements/dev.txt`

4. Set up Reddit API authentication

5. To perform type checking, use

pyenv exec mypy src/__init__.py

5. To run the tests, use

pyenv exec python -m unittest discover -s src

5. Run the bot

• --help shows options
• --timeout sets how frequently the bot should look for moves to play
• --log sets the log level

# Enable verbose logging and 
# check for moves on the current post every five seconds
pyenv exec python src/main.py --log INFO --timeout 5

Authentication

This bot uses Praw's Code Flow for authentication.

1. Create an application in your Reddit application preferences. Note your client_secret, shown when your press edit, and your client_id, listed below personal use script.

2. Set up your praw.ini in the project root as follows:

[DEFAULT]
redirect_uri=http://localhost:8080
client_id=MY_CLIENT_ID
client_secret=MY_CLIENT_SECRET
user_agent=script:com.MY_NAME.communitychess:v0.1.0 (by /u/MY_USERNAME)

3. Use python src/get_refresh_token.py to generate a refresh token.

4. Add this line to your praw.ini:

refresh_token=MY_REFRESH_TOKEN