https://github.com/allthingslinux/tux
https://github.com/allthingslinux/tux
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/allthingslinux/tux
- Owner: allthingslinux
- License: unlicense
- Created: 2023-11-28T18:19:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T21:31:07.000Z (almost 2 years ago)
- Last Synced: 2024-04-13T21:54:52.501Z (almost 2 years ago)
- Language: Python
- Homepage: https://discord.gg/linux
- Size: 3.95 MB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-discord - tux - commit/allthingslinux/tux?style=flat-square) |  |  | Tux is an all in one bot for the All Things Linux discord server. | (Bots)
- awesome-discordpy - alllthingslinux/tux - Tux is an all in one bot for the All Things Linux discord server. (Example Bots / Miscellaneous)
README
> [!WARNING]
> **This codebase is under heavy development and subject to breaking changes.** APIs, configurations, and features may change without notice. Documentation is not guaranteed to be accurate or up to date. Use at your own risk in production environments.
---
## Quick Start
Choose your path to get started with Tux:
| Role | Get Started |
|---------------|----------------------------------------------------------------------------------------------|
| 👤 Users | [Get Started](https://tux.atl.dev/user/) |
| ⚙️ Admins | [Get Started](https://tux.atl.dev/admin/) |
| 🐳 Self-Hosters | [Get Started](https://tux.atl.dev/selfhost/) |
| 💻 Developers | [Get Started](https://tux.atl.dev/developer/) |
## About
Tux is a feature-rich Discord bot originally built for the [All Things Linux](https://allthingslinux.org) community. It provides moderation tools, leveling systems, snippets, utilities, and fun commands - all in one package.
**Key Features:**
- **Moderation** - Comprehensive moderation tools with case management
- **Leveling** - XP and ranking system to reward active members
- **Snippets** - Quick text responses and custom commands
- **Utilities** - Server management and utility commands
- **Fun** - Entertainment commands and interactive features
- **Plugin System** - Extensible architecture for custom functionality
- **Caching** - Optional Valkey (Redis-compatible) cache for guild config, jail status, and permissions; falls back to in-memory TTL when Valkey is not configured
## Why Tux?
- **Modern tech stack** - Type-safe, async-first, powered by Python 3.13+ and discord.py
- **Production-ready** - Battle-tested in large communities with comprehensive error handling
- **Developer-friendly** - Clean architecture, extensive docs, and active development
- **Free and open source** - Free to use, modify, and contribute under GPL-3.0
## Tech Stack
| Component | Technology |
|-----------|------------|
| **Runtime** | Python 3.13+ with `discord.py` |
| **Package Manager** | `uv` for fast dependency management |
| **Database** | PostgreSQL with `SQLModel` (`SQLAlchemy` + `Pydantic`) |
| **Type Safety** | `basedpyright` with strict type hints |
| **Code Quality** | `ruff` for linting and formatting |
| **Testing** | `pytest` with async support |
| **CLI** | `typer` with custom command scripts |
| **Logging** | `loguru` for structured logging |
| **Monitoring** | `sentry-sdk` for error tracking |
| **HTTP Client** | `httpx` for async requests |
| **Configuration** | `pydantic-settings` with json/env support |
| **Containers** | Docker & Docker Compose |
| **Cache** | `valkey` with in-memory fallback |
## Documentation
Visit **[tux.atl.dev](https://tux.atl.dev)** for complete documentation including:
- **[User Guide](https://tux.atl.dev/user/)** - Commands, features, and usage
- **[Admin Guide](https://tux.atl.dev/admin/)** - Configuration and server setup
- **[Self-Hosting](https://tux.atl.dev/selfhost/)** - Installation and deployment
- **[Developer Guide](https://tux.atl.dev/developer/)** - Architecture and contributing
- **[API Reference](https://tux.atl.dev/reference/)** - CLI tools and codebase reference
- **[FAQ](https://tux.atl.dev/faq/)** - Common questions and answers
## Support & Community
- **[Discord Server](https://discord.gg/gpmSjcjQxg)** - Get help, report issues, and discuss features
- **[GitHub Issues](https://github.com/allthingslinux/tux/issues)** - Bug reports and feature requests
**Developer Resources:**
| Getting Started | Development Workflow | Quality & Standards |
|-------------------|------------------------|----------------------|
| [Developer Setup](https://tux.atl.dev/developer/tutorials/development-setup/) | [Git Best Practices](https://tux.atl.dev/developer/best-practices/git/) | [Testing Guide](https://tux.atl.dev/developer/best-practices/testing/) |
| [First Contribution](https://tux.atl.dev/developer/tutorials/first-contribution/) | [Branch Naming](https://tux.atl.dev/developer/best-practices/branch-naming/) | [Code Review](https://tux.atl.dev/developer/best-practices/code-review/) |
| [Project Structure](https://tux.atl.dev/developer/tutorials/project-structure/) | [Creating Commands](https://tux.atl.dev/developer/tutorials/creating-first-command/) | [Error Handling](https://tux.atl.dev/developer/best-practices/error-handling/) |
## Project Stats
## Contributors
## License
Tux is free and open source software licensed under the [GNU General Public License v3.0](LICENSE).
Created by [@kzndotsh](https://github.com/kzndotsh) • Maintained by the [All Things Linux](https://allthingslinux.org) community