tinytg

Minimal telegram botapi wrapper with ZERO dependencies

Why

Telegram bot api is one of the popular and simple solutions as an interface for automating various tasks.

This project is not intended to solve all use cases that can be achieved with aiogram, telegrinder, pyTelegramBotAPI and other telegram bot api wrappers and frameworks.

The intent is to provide a lightweight tool that simplifies some of the most common use cases for developers. Use this project for simple, minimal automation :)

Features

• ZERO dependencies
• python 3.8+ support
• simple, primitive: module have one file with less than 1000 lines of code (docstrings and comments include)
• http requests work on standard urllib (ty thttp project for wrapper <3). Reuse for t-party apis, http requests available
• minimal build-in API shortcuts:
  • Sending/Reply messages
  • Sending a document, photo, audio, video, voice files
  • binding commands
• rules (filters) for handling message events
  • F_IS_BOT - activate if is bot send message
  • F_IS_USER - activate if is user send message
  • F_ALLOW_USERS - activate, if is allowed user ids send message (for create admin/whitelist feature)
  • F_COMMAND - check text message by startswith pattern
  • F_RE - check text message by regex
  • F_IS_ATTACHMENT - check sending attachment
  • F_RPS_LIMITER - simple request-per-second limiter
  • or create custom rules by simple API function
• simple background tasks runner
• thread-mode run callbacks (experimental)
• parse arguments from message event
• handle message events by decorator
• primitive .env file reader

install

that is the pip? just copy or download single file, dude

wget https://raw.githubusercontent.com/vypivshiy/tinytg/main/tinytg.py -O tinytg.py

via curl:

curl https://raw.githubusercontent.com/vypivshiy/tinytg/main/tinytg.py > tinytg.py

Usage

• create .env file in project directory (see env file example):

TOKEN=YOUR_BOT_TOKEN
# any secrets
ADMIN_IDS=1000,2000
# ...

from tinytg import Bot, Message, load_dotenv, F_IS_USER
import os

load_dotenv()
bot = Bot(os.getenv('TOKEN'))
# or pass via argument (not recommended)
# bot = Bot(token="MY-BOT-TOKEN")


@bot.on_message(F_IS_USER)
def hello(m: Message):
    bot.api.send_message("HELLO, WORLD!", m)


bot.run()

projects examples

• demo - module features usage examples
• weather-bot - dummy weather bot (example inspired by BORING tutorials and show how to use http requests)
• wg-quick-bot - tgbot interface for angristan/wireguard-install script. For cheap VPS servers with 1CPU, 256mb ram and 5gb HDD/SDD :D