wlinator/tux
1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
Code Issues Releases Wiki Activity
Tux is an all in one bot for the All Things Linux discord server.
713 commits 28 branches 0 tags 14 MiB
Python 99.7%
Dockerfile 0.2%
Just 0.1%
Find a file
kzndotsh 53a7493345 feat(poetry.toml): add poetry.toml file to create virtual environments within the project directory 
refactor(dev.py): rearrange error handling methods for better readability and maintainability
refactor(avatar.py): extract common logic into send_avatar method to reduce code duplication
refactor(remindme.py): simplify database access by directly using the reminder table
feat(case.py, note.py, reminder.py): add ensure_guild_exists method to check and create guild if not exists
refactor(case.py, note.py, reminder.py): call ensure_guild_exists before creating a new entry to ensure guild exists

feat(snippet.py): add ensure_guild_exists method to check and create guild if not exists
refactor(snippet.py): modify create_snippet method to call ensure_guild_exists before creating a snippet, ensuring guild existence
2024-07-02 19:19:07 +00:00
.archive feat(neofetch.py): add new neofetch command to display system and server stats 2024-07-02 03:41:57 +00:00
.github Delete .github/dependabot.yml 2024-06-21 12:15:50 -04:00
assets add assets to assets folder 2024-06-02 14:29:39 -05:00
config refactor(.env.example, settings.json, cog_loader.py, main.py): rename STAGING to DEV for better clarity 2024-06-16 16:15:05 +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 GuildConfig model to store guild-specific configurations 2024-07-02 02:28:00 +00:00
tux feat(poetry.toml): add poetry.toml file to create virtual environments within the project directory 2024-07-02 19:19:07 +00:00
.editorconfig feat: add .editorconfig for consistent coding style across different editors 2024-04-11 20:22:47 +00:00
.env.example feat: add Mailcow integration for user mail registration 2024-06-26 19:00:13 +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 feat(neofetch.py): add new neofetch command to display system and server stats 2024-07-02 03:41:57 +00:00
docker-compose.yml feat: add Dockerfile and docker-compose.yml for containerization 2024-06-11 05:18:25 +00:00
Dockerfile chore: remove unused pyright and vulture configurations from .pre-commit-config.yaml and pyproject.toml 2024-07-02 02:23:17 +00:00
justfile feat: add justfile for task automation 2024-06-16 19:03:39 +00:00
LICENSE.md Update LICENSE.md 2024-06-21 23:54:58 -04:00
mypy.ini chore(mypy.ini): update Python version from 3.11 to 3.12 2024-04-11 21:56:29 +00:00
poetry.lock chore(poetry.lock): update dependencies in lock file to ensure project uses the latest secure versions 2024-07-02 02:45:24 +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 chore: remove unused pyright and vulture configurations from .pre-commit-config.yaml and pyproject.toml 2024-07-02 02:23:17 +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

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

Steps

  1. Clone the repository

    git clone https://github.com/allthingslinux/tux && cd tux

  2. Install the dependencies

    poetry install

  3. Activate the virtual environment

    poetry shell

  4. Install the pre-commit hooks

    pre-commit install

  5. Generate the prisma client

    prisma generate

  6. Copy the .env.example file to .env and fill in the required values

    cp .env.example .env

  7. Run the sync command in the server to sync the slash command tree.

    {prefix}sync <server id>

  8. 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.