telekit 1.0.0b3

Declarative, developer-friendly library for building Telegram bots

TeleKit Library

Telekit is a declarative, developer-friendly library for building Telegram bots. It streamlines common bot operations, automates routine tasks, and provides a clear, structured way to implement complex logic without boilerplate.

Telekit comes with a built-in DSL for defining scenes, menus, FAQ pages, and multi-step flows, allowing developers to create fully interactive bots with minimal code. The library also handles message formatting, user input, and callback routing automatically, letting you focus on the bot’s behavior instead of repetitive tasks.

self.chain.sender.set_text(Bold("Hello world!"))
self.chain.sender.set_photo("robot.png")
self.chain.set_inline_keyboard({"👋 Hello, Bot": self.handle_greeting})
self.chain.send()

Example taken out of context

Even in its beta stage, Telekit accelerates bot development, offering ready-to-use building blocks for commands, user interactions, and navigation. Its declarative design makes bots easier to read, maintain, and extend.

Key features:

• Declarative bot logic with chains for multi-step interactions
• Built-in DSL for menus, buttons, and FAQ pages
• Automatic handling of message formatting and callback routing
• Ready-to-use FAQ system and navigation flows
• Minimal boilerplate, clean, and maintainable code

GitHub PyPi Telegram Tutorial

Contents

• Overview
  • Message Formatting
  • Text Styling
  • Handling Callbacks
• Quick Guide
• Examples and Solutions
  • Counter
  • FAQ Pages (Telekit DSL)
  • Registration
  • Dialogue

Overview

To get the most out of Telekit, we recommend following the full, step-by-step tutorial that covers everything from installation to advanced features and DSL usage.

Even if you don’t go through the entire guide right now, you can quickly familiarize yourself with the core concepts, key building blocks, and basic workflows of Telekit below. This section will introduce you to chains, handlers, message formatting, and some examples, giving you a solid foundation to start building bots right away.

Let’s see how Telekit works in practice 👇

import telekit

class NameHandler(telekit.Handler):

    @classmethod
    def init_handler(cls) -> None:
        cls.on.text("My name is {name}").invoke(cls.display_name)

    def display_name(self, name: str) -> None:
        self.chain.sender.set_title(f"Hello {name}!")
        self.chain.sender.set_message("Your name has been set. You can change it below if you want")
        self.chain.set_inline_keyboard({"✏️ Change": self.change_name})
        self.chain.edit()

    def change_name(self):
        self.chain.sender.set_title("⌨️ Enter your new name")
        self.chain.sender.set_message("Please type your new name below:")

        @self.chain.entry_text(delete_user_response=True)
        def name_handler(message, name: str):
            self.display_name(name)

        self.chain.edit()

telekit.Server("TOKEN").polling()

... and examine each element individually...

Message formatting:

• You can configure everything manually:

self.chain.sender.set_text("*Hello, user!*\n\nWelcome to the Bot!")
self.chain.sender.set_parse_mode("markdown")

• Or let Telekit handle the layout for you:

self.chain.sender.set_title("👋 Hello, user!") # Bold title
self.chain.sender.set_message("Welcome to the Bot!")  # Italic message after the title

Approximate result:

👋 Hello, user!

Welcome to the Bot!

If you want more control:

self.chain.sender.set_use_italic(False)
self.chain.sender.set_add_new_line(False)
self.chain.sender.set_parse_mode("HTML")
self.chain.sender.set_reply_to(message)
self.chain.sender.set_chat_id(chat_id)

# And this is just the beginning...

Want to add an image or an effect in a single line?

self.chain.sender.set_effect(self.chain.sender.Effect.HEART)
self.chain.sender.set_photo("url, bytes or path")

Telekit decides whether to use bot.send_message or bot.send_photo automatically!

Text Styling with Styles

Telekit provides a convenient Styles helper class to create styled text objects for HTML or Markdown. You can use it directly from your self.chain.sender:

# Automatically detects `parse_mode` from `sender`
styles = self.chain.sender.styles

text = styles.bold("Bold") + " and " + styles.italic("Italic")

Combine multiple styles:

text = styles.strike(styles.bold("Hello") + styles.italic("World!"))

For more details, see our tutorial

Handling callbacks and Logic

If your focus is on logic and functionality, Telekit is the ideal library:

Inline keyboard with callback support:

# Inline keyboard `label-callback`:
# - label:    `str`
# - callback: `Chain` | `str` | `func()` | `func(message)`
self.chain.set_inline_keyboard(
    {
        "« Change": prompt,  # Executes `prompt.send()` when clicked
        "Yes »": lambda: print("User: Okay!"),  # Runs this lambda when clicked
        "Youtube": "https://youtube.com"  # Opens a link
    }, row_width=2
)

# Inline keyboard `label-value`:
# - label: `str`
# - value: `Any`
@self.chain.inline_keyboard({
    "Red": (255, 0, 0),
    "Green": (0, 255, 0),
    "Blue": (0, 0, 255),
}, row_width=3)
def _(message, value: tuple[int, int, int]) -> None:
    r, g, b = value
    self.chain.set_message(f"You selected RGB color: ({r}, {g}, {b})")
    self.chain.edit()

Receiving messages with callback support:

# Receive any message type:
@self.chain.entry(
    filter_message=lambda message: bool(message.text),
    delete_user_response=True
)
def handler(message):
    print(message.text)

# Receive text message:
@self.chain.entry_text()
def name_handler(message, name: str):
    print(name)

# Inline keyboard with suggested options:
chain.set_entry_suggestions(["Suggestion 1", "Suggestion 2"])

# Receive a .zip document:
@self.chain.entry_document(allowed_extensions=(".zip",))
def doc_handler(message: telebot.types.Message, document: telebot.types.Document):
    print(document.file_name, document)

# Receive a text document (Telekit auto-detects encoding):
@self.chain.entry_text_document(allowed_extensions=(".txt", ".js", ".py"))
def text_document_handler(message, text_document: telekit.types.TextDocument):
    print(
        text_document.text,      # "Example\n ..."
        text_document.file_name, # "example.txt"
        text_document.encoding,  # "utf-8"
        text_document.document   # <telebot.types.Document>
    )

Telekit is lightweight yet powerful, giving you a full set of built-in tools and solutions for building advanced Telegram bots effortlessly.

• You can find more information about the decorators by checking their doc-strings in Python.

---

Quick Start

You can write the entire bot in a single file, but it’s recommended to organize your project using a simple structure like this one:

handlers/
    __init__.py
    start.py    # `/start` handler
    help.py     # `/help` handler
    ...
server.py       # entry point

Here is a server.py example (entry point) for a project on TeleKit

import telekit
import handlers # Package with all your handlers

telekit.Server("BOT_TOKEN").polling()

Here you can see an example of the handlers/__init__.py file:

from . import (
    start, help #, ...
)

Here is an example of defining a handler using TeleKit (handlers/start.py file):

import telekit

class StartHandler(telekit.Handler):

    @classmethod
    def init_handler(cls) -> None:
        ...

One-file bot example:

import telekit

class NameAgeHandler(telekit.Handler):

    @classmethod
    def init_handler(cls) -> None:
        ...

telekit.Server("TOKEN").polling()

For a full walkthrough, check out our tutorial

---

Examples and Solutions

If you're unsure how the examples work, check out our tutorial for a full walkthrough.

Counter

import telebot.types
import telekit
import typing

class CounterHandler(telekit.Handler):

    @classmethod
    def init_handler(cls) -> None:
        """
        Initializes the message handler for the '/counter' command.
        """
        @cls.on.message(['counter'])
        def handler(message: telebot.types.Message) -> None:
            cls(message).handle()

    def handle(self) -> None:
        self.chain.sender.set_title("Hello")
        self.chain.sender.set_message("Click the button below to start interacting")
        self.chain.sender.set_photo("https://static.wikia.nocookie.net/ssb-tourney/images/d/db/Bot_CG_Art.jpg/revision/latest?cb=20151224123450")
        self.chain.sender.set_effect(self.chain.sender.Effect.PARTY)

        def counter_factory() -> typing.Callable[[int], int]:
            count = 0
            def counter(value: int=1) -> int:
                nonlocal count
                count += value
                return count
            return counter
        
        click_counter = counter_factory()

        @self.chain.inline_keyboard({"⊕": 1, "⊖": -1}, row_width=2)
        def _(message: telebot.types.Message, value: int) -> None:
            self.chain.sender.set_message(f"You clicked {click_counter(value)} times")
            self.chain.edit()
        self.chain.set_remove_inline_keyboard(False)

        self.chain.send()

FAQ Pages (Telekit DSL)

Telekit DSL — this is a custom domain-specific language (DSL) used to create interactive pages, such as FAQs.
It allows you to describe the message layout, add images, and buttons for navigation between pages in a convenient, structured format that your bot can easily process.

The parser and analyzer provide an excellent system of warnings and errors with examples, so anyone can figure it out!

To integrate Telekit DSL into your project, simply add it as a Mixin to your Handler:

import telekit

class GuideHandler(telekit.GuideMixin):
    @classmethod
    def init_handler(cls) -> None:
        cls.on.message(["faq"]).invoke(cls.start_script)
        cls.analyze_source(source)

source = """...Telekit DSL..."""

telekit.Server(TOKEN).polling()

• Even easier: call the appropriate method:

import telekit

telekit.TelekitDSL.from_string("""...Telekit DSL...""", ["start"])

telekit.Server(TOKEN).polling()

For more details on the syntax, see the Telekit DSL Syntax reference.

For a complete, step-by-step walkthrough, check out our full tutorial.

Registration

import telebot.types
import telekit

class UserData:
    names: telekit.Vault = telekit.Vault(
        path             = "data_base", 
        table_name       = "names", 
        key_field_name   = "user_id", 
        value_field_name = "name"
    )
    
    ages: telekit.Vault = telekit.Vault(
        path             = "data_base", 
        table_name       = "ages", 
        key_field_name   = "user_id", 
        value_field_name = "age"
    )
    
    def __init__(self, chat_id: int):
        self.chat_id = chat_id

    def get_name(self, default: str | None=None) -> str | None:
        return self.names.get(self.chat_id, default)

    def set_name(self, value: str):
        self.names[self.chat_id] = value

    def get_age(self, default: int | None=None) -> int | None:
        return self.ages.get(self.chat_id, default)

    def set_age(self, value: int):
        self.ages[self.chat_id] = value

class EntryHandler(telekit.Handler):

    @classmethod
    def init_handler(cls) -> None:
        """
        Initializes the command handler.
        """
        cls.on.command('entry').invoke(cls.handle)

        # Or define the handler manually:

        # @cls.on.command('entry')
        # def handler(message: telebot.types.Message) -> None:
        #     cls(message).handle()

    # ------------------------------------------
    # Handling Logic
    # ------------------------------------------

    def handle(self) -> None:
        self._user_data = UserData(self.message.chat.id)
        self.entry_name()

    # -------------------------------
    # NAME HANDLING
    # -------------------------------

    def entry_name(self) -> None:
        self.chain.sender.set_title("⌨️ What`s your name?")
        self.chain.sender.set_message("Please, send a text message")

        self.add_name_listener()

        name: str | None = self._user_data.get_name( # from own data base
            default=self.user.username # from telebot API
        )
        
        if name:
            self.chain.set_entry_suggestions([name])

        self.chain.edit()

    def add_name_listener(self):
        @self.chain.entry_text(delete_user_response=True)
        def _(message: telebot.types.Message, name: str) -> None:
            self.chain.sender.set_title(f"👋 Bonjour, {name}!")
            self.chain.sender.set_message(f"Is that your name?")

            self._user_data.set_name(name)

            self.chain.set_inline_keyboard(
                {
                    "« Change": self.entry_name,
                    "Yes »": self.entry_age,
                }, row_width=2
            )

            self.chain.edit()

    # -------------------------------
    # AGE HANDLING
    # -------------------------------

    def entry_age(self, message: telebot.types.Message | None=None) -> None:
        self.chain.sender.set_title("⏳ How old are you?")
        self.chain.sender.set_message("Please, send a numeric message")

        self.add_age_listener()

        age: int | None = self._user_data.get_age()

        if age:
            self.chain.set_entry_suggestions([str(age)])

        self.chain.edit()

    def add_age_listener(self):
        @self.chain.entry_text(
            filter_message=lambda message, text: text.isdigit() and 0 < int(text) < 130,
            delete_user_response=True
        )
        def _(message: telebot.types.Message, text: str) -> None:
            self._user_data.set_age(int(text))

            self.chain.sender.set_title(f"😏 {text} years old?")
            self.chain.sender.set_message("Noted. Now I know which memes are safe to show you")

            self.chain.set_inline_keyboard(
                {
                    "« Change": self.entry_age,
                    "Ok »": self.show_result,
                }, row_width=2
            )
            self.chain.edit()

    # ------------------------------------------
    # RESULT
    # ------------------------------------------

    def show_result(self):
        name = self._user_data.get_name()
        age = self._user_data.get_age()

        self.chain.sender.set_title("😏 Well well well")
        self.chain.sender.set_message(f"So your name is {name} and you're {age}? Fancy!")

        self.chain.set_inline_keyboard({
            "« No, change": self.entry_name,
        }, row_width=2)

        self.chain.edit()

Optimized version: minimal memory usage and no recursive creation of chain objects

Dialogue

import telebot.types
import telekit
import typing

class DialogueHandler(telekit.Handler):

    # ------------------------------------------
    # Initialization
    # ------------------------------------------

    @classmethod
    def init_handler(cls) -> None:
        """
        Initializes message handlers
        """
        @cls.on_text("Hello!", "hello!", "Hello", "hello")
        def _(message: telebot.types.Message):
            cls(message).handle_hello()

    # ------------------------------------------
    # Handling Logic
    # ------------------------------------------

    def handle_hello(self) -> None:
        self.chain.sender.set_text("👋 Hello! What is your name?")

        @self.chain.entry_text()
        def _(message: telebot.types.Message, name: str):
            self.handle_name(name)
            
        self.chain.send()

    def handle_name(self, name: str):
        self._user_name: str = name

        self.chain.sender.set_text(f"Nice! How are you?")

        @self.chain.entry_text()
        def _(message, feeling: str):
            self.handle_feeling(feeling)

        self.chain.send()

    def handle_feeling(self, feeling: str):
        self.chain.sender.set_text(f"Got it, {self._user_name.title()}! You feel: {feeling}")
        self.chain.send()

If you're unsure how the examples work, check out our tutorial for a full walkthrough.

Developer

Telegram: Romashka

Gravatar: Romashka

---

Changelog:

1.0.0 (BETA 3)

Overview:
This release makes creating triggers simpler, styling messages easier, and the DSL smarter. We removed tricky Chain workarounds that could cause unexpected behavior, improved automatic handling of HTML and Markdown in messages, and added powerful new styles. Everything is now safer, cleaner, and more intuitive for developers.

✅ New Features

• The new on API provides a cleaner and more intuitive way to declare triggers for messages and commands:

@cls.on.command('start')
def start_handler(message):
    cls(message).handle_start()

@cls.on.text("My name is {name}")
def name_handler(message, name: str):
    cls(message).handle_name(name)

# A simpler ways (Automatic instance creation `cls(message)`):

cls.on.command("start").invoke(cls.handle_start)
cls.on.text("My name is {name}").invoke(cls.handle_name)

Sender Improvements

• Automatic HTML and Markdown handling – processes HTML tags and Markdown formatting applied via Bold(...), Sanitize(...), etc.
• Enhanced Sender logic – automatically sanitizes content in style blocks and assigns the correct parse_mode.
• New methods:
  • sender.set_media(...)
  • chain.create_sender(chat_id)
  • sender.add_message(...)

Telekit Utilities

• telekit.enable_file_logging()

Telekit DSL

• Added types: none, true, false (case-insensitive)
• Parser prevents creation of scenes with reserved name back
• New syntax:
  • row_width syntax: buttons[2] → buttons(2)
• TelekitDSL.from_file(...) and TelekitDSL.from_string(...)
• Renamed GuideMixin → TelekitDSL.Mixin
  • Buttons without labels supported (details)
• Full Telekit DSL Documentation updated

Chain Utilities

• handler.new_chain() -> None - creates a new chain
• chain.remove_all_handlers() – removes all callback handlers
• chain.remove_timeout() – removes active timeout
• chain.remove_entry_handler() – removes current entry handler
• chain.remove_inline_keyboard() – removes inline keyboard and callback bindings
• Automatic removal after chain.send() or .edit(), but can be disabled:
  • chain.set_remove_timeout(False)
  • chain.set_remove_entry_handler(False)
  • chain.set_remove_inline_keyboard(False)

Tutorials

• New tutorial: Tutorial
• Other miscellaneous improvements

---

⚠️ Breaking Changes

• GuideKit and GuideMixin renamed → TelekitDSL and TelekitDSL.Mixin
• GuideKit(...) replaced → TelekitDSL.from_file(...)
• Removed methods:
  • chain.set_always_edit_previous_message(...)
  • chain.parent and all related functionality
  • handler.get_child()
  • handler.get_chain(...) → use handler.new_chain()
• Renamed for clarity:
  • chain.edit_previous_message() → chain.mark_previous_message_for_edit()
• Default parse_mode in DSL → none
• DSL syntax updated: buttons[2] → buttons(2)

---

⏳ Delayed until v1.1.0

• DSL warning for strings with too many buttons or excessive text
• Localization support for self.user.enable_logging() (currently global)

---

Old release notes are available in previous commits.