https://github.com/ungdev/etuutt-discord-bot
https://github.com/ungdev/etuutt-discord-bot
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ungdev/etuutt-discord-bot
- Owner: ungdev
- License: mit
- Created: 2024-02-22T09:13:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T14:47:57.000Z (about 2 years ago)
- Last Synced: 2024-04-12T23:33:42.100Z (about 2 years ago)
- Language: Python
- Homepage:
- Size: 376 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EtuUTT-Discord-Bot
A project of redoing the Discord bot made in JavaScript used at my school.
Be sure to have Python 3.10 or higher installed.
Clone the projet and install the requirements (in a
[venv](https://docs.python.org/library/venv.html) preferably):
```bash
git clone https://github.com/ungdev/EtuUTT-Discord-Bot.git
cd EtuUTT-Discord-Bot
pip install -r requirements.txt
```
Note: replace `requirements.txt` by `requirements-dev.txt` if you wish to install the dev
requirements to contribute to the bot.
---
Before launching the bot, you need to fill in a **`.env`** file (using
the [example](https://github.com/ungdev/EtuUTT-Discord-Bot/blob/main/.env.example)
I provide in the repo).
You need a Discord bot token, to have one go to
the [Discord Developer Portal](https://discord.com/developers) and create a new
application.
Go to the Bot section and click the Reset Token button, you can now claim the token.
You also have to enable all the Privileged Gateway Intents as I assume they're enabled in the code.
---
After having done all this you can launch the bot:
```bash
python -m etuutt_bot
```
## Contributing
Use [ruff](https://github.com/astral-sh/ruff) to lint and format the code before making a pull
request.
I also use [pre-commit](https://github.com/pre-commit/pre-commit) to run ruff before each commit.
Pytest is also used to test the project :
```bash
pytest
```
## Acknowledgments
Thanks to Ivann who did the original Discord bot.
It can be found [here](https://github.com/ungdev/discord_bot_firewall).