COTO (Contributor of The Organization) Bot

Why?

As a part of HackSquad 2022, a competition took place where you'd have to create an autonomous "being of the Internet" (or "bot" to be precise) which takes the top contributor of a GitHub Organization within a given period and congratulates them for their contributions in both Discord and Twitter.

Speaking of that, this project has been made by one of the teams which joined forces in that competition. Feel free to have a look around!

Setup

Environment Variables

Before running the steps mentioned below, make sure you set the required secrets using the following command:

# use the example file to create local environment file
$ cp .env.example .env

# fill up the values using your favorite editor
$ nano .env

Initialize

You can setup the project with ease in two different methods:

• Docker: (easier, requires Docker Engine and Docker Compose)

# building the image
$ docker-compose build

# running it
$ docker-compose up

• Manual: (requires Python 3.10 or later)

# setting up virtual environment using venv
$ python -m venv venv
$ source venv/bin/activate

# install dependencies using pip
$ pip install -r requirements.txt

# run the bot
$ python main.py

Licensed under MIT

View the original license document: click here!