mirror of
https://github.com/allthingslinux/tux.git
synced 2024-10-03 00:53:12 +00:00
Tux is an all in one bot for the All Things Linux discord server.
asynciodiscorddiscord-pydockerdotenvhttpxjustlinuxlogurumkdocs-materialmypypoetrypre-commitprismapyrightpythonrenovateruffsupabase
1a8c4a4801
refactor(purge.py): remove unused imports and methods, use EmbedCreator for creating embeds refactor(report.py): rename ConfirmModal to ReportModal for better semantics feat(purge.py): add error handling for non-text channels and invalid number of messages feat(report.py): add docstring to report method, improve report submission process docs(slowmode.py, timeout.py, unban.py): add docstrings to methods for better code readability and understanding refactor(slowmode.py): change default slowmode delay from 5 to 4 seconds for better user experience style(slowmode.py, timeout.py, unban.py): add line breaks for better code readability fix(unban.py): remove redundant logging of unban command usage, logging is now handled after successful unbanning docs(warn.py): add docstrings to methods for better code readability and understanding refactor(warn.py): remove error handling from create_infraction method to improve separation of concerns |
||
---|---|---|
.archive | ||
.github | ||
config | ||
docs | ||
infra | ||
prisma | ||
tux | ||
.editorconfig | ||
.env.example | ||
.gitignore | ||
.mise.toml | ||
.pre-commit-config.yaml | ||
LICENSE.md | ||
mypy.ini | ||
poetry.lock | ||
pyproject.toml | ||
README.md | ||
renovate.json |
Tux
A Discord bot for the All Things Linux Discord server
About
Tux is a Discord bot for the All Things Linux Discord server. It is designed to provide a variety of features to the server, including moderation, support, utility, and various fun commands. The bot is written in Python using the discord.py library.
Installation
Prerequisites
- Python 3.11
- Poetry
Steps
-
Clone the repository
git clone https://github.com/allthingslinux/tux && cd tux
-
Install the dependencies
poetry install
-
Activate the virtual environment
poetry shell
-
Install the pre-commit hooks
pre-commit install
-
Generate the prisma client
prisma generate
-
Copy the
.env.example
file to.env
and fill in the required valuescp .env.example .env
-
Run
{prefix}sync <server id>
in the server to sync the slash command tree. -
Review all useful CLI commands by visiting the useful CLI commands file.
License
This project is licensed under the terms of the The Unlicense license. See the LICENSE file for details.