challenge-bot

A bot for Discord, that connects to the Strava API and retrieves and evaluates activity data for a Strava challenge between friends.

Requirements

• Python 3.8 or higher
• A Discord bot account and token
• A Strava application with a client ID and secret

Installation

Clone or Download the Repository

git clone https://github.com/yourusername/challenge-bot.git
cd challenge-bot

Set Up a Python Virtual Environment

It's recommended to use a virtual environment for Python projects to manage dependencies separately for each project.

Usage

1. Create a Virtual Environment

To create a new virtual environment, run the following command in your project directory:

python3 -m venv venv

2. Activate the Virtual Environment

Activate the virtual environment before installing dependencies or running the application:

• On Linux or macOS:

  source venv/bin/activate

• On Windows:

  venv\Scripts\activate.bat

Install Required Libraries

With the virtual environment activated, install the project's required libraries:

pip install -r requirements.txt

Configure Environment Variables

Set up your environment variables by creating a .env file in the project's root directory. Populate it with the necessary values:

DISCORD_TOKEN=YOUR_DISCORD_BOT_TOKEN
DISCORD_ADMIN_ID= YOUR_DISCORD_USER_ID
STRAVA_CLIENT_ID=YOUR_STRAVA_CLIENT_ID
STRAVA_CLIENT_SECRET=YOUR_STRAVA_CLIENT_SECRET
REDIRECT_URI=http://YOUR_ADDRESS/strava_auth
PORT=YOUR_PORT
YEAR=The Year of the Challenge

Running the Application

To start the Discord bot and the Flask web server, navigate to the project root and run the application using the -m flag:

python3 -m src.bot.bot_app

Ensure you're in the root directory of your project (challenge-bot) when executing the above command to correctly resolve module paths.

Invite the Bot to Your Discord Server

Use the following URL, replacing YOUR_CLIENT_ID with your Discord bot client ID, to invite the bot to your Discord server:

https://discord.com/api/oauth2/authorize?client_id=YOUR_CLIENT_ID&permissions=2048&scope=bot

Link Your Strava Account

• Send a /strava_auth command to the bot in a direct message. The bot will send you a link to the Strava authorization page.
• Grant permission for the bot to access your data.
• You'll be redirected back to the Flask web server, which will extract the authorization code and pass it back to the bot.
• The bot will exchange the authorization code for an access token and use it to make requests to the Strava API.

Now, your setup should be complete, and you can use the bot to evaluate the performance of registered users in the challenge.