UCR Hackathon Discord Bot

Python

UCR Hackathon Discord Bot runs on Python Version 3.10 and higher. Please ensure you have Python installed.

Poetry

This project is built using Poetry, a Python package and dependency manager. Please ensure you have Poetry installed using the official installation guide. You can also install Poetry via the following command:

# Linux, MacOS, Windows (WSL)
curl -sSL https://install.python-poetry.org | python3 -

Environment Variables

The following environment variables are required and must be stored in an .env file:

DISCORD_BOT_TOKEN=
DISCORD_SERVER_ID=

DISCORD_VERIFICATION_CHANNEL_ID=
DISCORD_EVENTS_CHANNEL_ID=
DISCORD_ROLE_CHANNEL_ID=
DISCORD_MENTOR_CHANNEL_ID=
DISCORD_MENTEE_CHANNEL_ID=
DISCORD_WELCOME_CHANNEL_ID=
DISCORD_INFO_DESK_CHANNEL_ID=
DISCORD_INTRODUCTION_CHANNEL_ID=

GOOGLE_CALENDAR_EMAIL=
GOOGLE_CALENDAR_API_KEY=

HACKATHON_NAME=

Commands

Dependencies

# Install dependencies
poetry install

# Add dependency
poetry add <dependency>

# Remove dependency
poetry remove <dependency>

Running the Bot Locally

poetry run bot

Formatting Code via YAPF

# Rewrite code recursively with proper formatting
poetry run yapf -ir bot

# Show formatting differences recursively
poetry run yapf -dr bot

Linting Code via Pylint

poetry run pylint bot

Build the Bot

poetry build