Shahraaz / remind

A discord bot that sends reminders for future contests.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Remind

A discord bot that sends reminders for future contests using clist API.

Installation

Use Python 3.7 or later.

Clone the repository:

git clone https://github.com/aryanc403/remind

Dependencies

Now all dependencies need to be installed.

Dependencies are listed in requirements.txt.

pip install -r requirements.txt

Final steps

To start remind, fill up the variables in env_file_variables.txt and rename it to .env.

You will need to setup a bot on your server before continuing. Follow the directions here. Following this, you should have your bot appearing in your server and you should have the Discord bot token.

You will need clist.by api key for updation of contest list. You can find it here after creating an account.

You can also setup a logger channel that logs warnings by assigning the enviornment variable LOGGING_COG_CHANNEL_ID. But this is optional.

./run.sh

Deployment

If you want to just host bot then you can skip installing dependencies and just follow Final steps and just install Docker Dockerfile will take care of rest.

Contributing

Linting and Formatting

We are using autopep8 for formatting the code.

pycodestyle . must generate no errors before accepting the PR. Use autopep8 --in-place --aggressive --aggressive <file name> for formatting before sending a PR.

Credits

Shoutout to TLE developers for the idea and initial contributions to this bot. Their bot used to remind about Codeforces contests and we enhanced it for all other judges.

License

MIT License

About

A discord bot that sends reminders for future contests.

License:MIT License


Languages

Language:Python 98.5%Language:Shell 1.2%Language:Dockerfile 0.3%