mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00

Tux is an all in one bot for the All Things Linux discord server.

asyncio discord discord-py docker dotenv httpx just linux loguru mkdocs-material mypy poetry pre-commit prisma pyright python renovate ruff supabase

Find a file

kzndotsh 7ee1fd1155 chore(.pre-commit-config.yaml): update ruff-pre-commit and gitleaks versions for better linting and security checks		2024-07-15 10:48:54 +00:00
.archive	style(neofetch.py, cog_loader.py, avatar.py, tldr.py): correct comment block formatting for consistency	2024-07-15 10:46:57 +00:00
.github	Delete .github/dependabot.yml	2024-06-21 12:15:50 -04:00
assets	Merge pull request #313 from allthingslinux/new-role-icons	2024-07-13 23:44:00 -04:00
config	refactor(settings.json, constants.py): simplify and rename EMBED_STATE_COLORS and EMBED_STATE_ICONS to EMBED_COLORS and EMBED_ICONS respectively for better readability	2024-07-13 19:25:16 +00:00
docs	style(README.md): replace CRLF line endings with LF for better cross-platform compatibility	2024-04-11 19:24:07 +00:00
prisma	feat(schema.prisma): add DEV_DATABASE_URL and DEV_DIRECT_URL as commented lines for easy switch between prod and dev databases	2024-07-13 19:37:14 +00:00
tux	style(neofetch.py, cog_loader.py, avatar.py, tldr.py): correct comment block formatting for consistency	2024-07-15 10:46:57 +00:00
.editorconfig	feat: add .editorconfig for consistent coding style across different editors	2024-04-11 20:22:47 +00:00
.env.example	chore(.env.example): restructure and clean up environment variables for better organization and clarity	2024-07-13 19:21:16 +00:00
.gitignore	Added new commands	2024-05-06 18:41:31 -05:00
.mise.toml	feat: add .editorconfig for consistent coding style across different editors	2024-04-11 20:22:47 +00:00
.pre-commit-config.yaml	chore(.pre-commit-config.yaml): update ruff-pre-commit and gitleaks versions for better linting and security checks	2024-07-15 10:48:54 +00:00
docker-compose.yml	feat: add Dockerfile and docker-compose.yml for containerization	2024-06-11 05:18:25 +00:00
Dockerfile	style(Dockerfile): add line breaks for better readability and maintainability	2024-07-02 21:09:07 +00:00
justfile	chore(.env.example): restructure and clean up environment variables for better organization and clarity	2024-07-13 19:21:16 +00:00
LICENSE.md	Update LICENSE.md	2024-06-21 23:54:58 -04:00
poetry.lock	chore(.pre-commit-config.yaml): update ruff-pre-commit and gitleaks versions for better linting and security checks	2024-07-15 10:48:54 +00:00
poetry.toml	feat(poetry.toml): add poetry.toml file to create virtual environments within the project directory	2024-07-02 19:19:07 +00:00
pyproject.toml	fix(deps): update dependency ruff to ^0.5.0	2024-07-15 10:15:52 +00:00
README.md	Update README.md	2024-06-22 00:07:05 -04:00
renovate.json	Add renovate.json	2024-04-11 20:02:04 +00:00

README.md

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.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 values
```
cp .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.