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
95e7f665b2
style(git.py): shorten long lines to improve readability feat(xkcd.py): add XkcdLinkButtons class to provide link buttons for xkcd comics style(neofetch.py, xkcd.py): shorten long lines to improve readability refactor(xkcd.py): move XkcdLinkButtons class to the top for better organization refactor(roles.py): rename group to role for better semantics style(roles.py, run.py, temp_vc.py, tty_roles.py, purge.py, avatar.py, guide.py, info.py, membercount.py): simplify function calls and conditions for better readability fix(report.py): simplify report submission process, remove webhook creation and deletion feat(avatar.py): add prefix command for getting member avatar chore(roles.py, run.py, temp_vc.py, purge.py, avatar.py, membercount.py): remove logger calls to reduce verbosity style: refactor multiline function calls and conditions to single line for better readability fix(snippets.py): correct database controller attribute from 'snippets' to 'snippet' to match the correct database table name |
||
---|---|---|
.archive | ||
.github | ||
assets | ||
config | ||
docs | ||
prisma | ||
tux | ||
.editorconfig | ||
.env.example | ||
.gitignore | ||
.mise.toml | ||
.pre-commit-config.yaml | ||
docker-compose.yml | ||
Dockerfile | ||
justfile | ||
LICENSE.md | ||
mypy.ini | ||
poetry.lock | ||
pyproject.toml | ||
README.md | ||
renovate.json |
Tux
A Discord bot for the All Things Linux Discord server
NOTE: This bot (without plenty of tweaking) is not ready for multi-server use, we recommend against using it until it is more complete
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.12
- 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 the sync command in the server to sync the slash command tree.
{prefix}sync <server id>
-
Review all useful CLI commands by visiting the useful CLI commands file.
License
This project is licensed under the terms of the The GNU General Public License v3.0. See the LICENSE file for details.