Back to projects
Jun 01, 2024
2 min read

WZML-X

A feature-rich Telegram automation framework with async task queuing, plugin-based download source architecture, multi-user access control, and Docker-first deployment. 1000+ GitHub stars.

Overview

WZML-X is a Telegram bot framework for automating file operations — downloading from URLs, torrents, cloud storage, and streaming services, then uploading to Google Drive, Telegram, or other destinations. It started as a fork and has been extensively rearchitected into a general-purpose automation platform.

Key Features

Async task queue: All operations are queued and processed by a worker pool. No blocking, no lost tasks on restart (Redis-backed), full progress reporting back to users.

Plugin architecture: Each download source (HTTP, torrents, YouTube, Google Drive, Mega, etc.) is an independent plugin implementing a standard interface. New sources can be added without modifying core code.

Multi-user access control: Owner, sudo, authorized, and trial user tiers. Per-user limits on concurrent tasks and bandwidth.

Docker deployment: Single docker-compose up from a configured .env file. No manual dependency management.

Extensive configuration: 100+ configuration options via environment variables, all validated with Pydantic at startup.

Community

WZML-X has over 1,000 GitHub stars and an active community of self-hosters. It is actively maintained, with regular releases and a responsive issue tracker.

Tech Stack

Python · asyncio · Redis · Docker · python-telegram-bot · Pydantic · aria2