telekit 2.4.0b0

Declarative, developer-friendly library for building Telegram bots

Telekit

Telekit is a declarative, developer-friendly library for building Telegram bots. It gives developers a dedicated Sender for composing and sending messages and a Chain for handling dialogue between the user and the bot. The library also handles inline keyboards and callback routing automatically, letting you focus on the bot's behavior instead of repetitive tasks.

import telekit

class MyStartHandler(telekit.Handler):
    @classmethod
    def init_handler(cls):
        cls.on.command('start').invoke(cls.handle_start)

    def handle_start(self):
        self.chain.sender.set_text("Hello!")
        self.chain.sender.set_photo("robot.png")
        self.chain.send()

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

Send "Hello!" with a photo on /start

Telekit comes with a built-in DSL, allowing developers to create fully interactive bots with minimal code. It also integrates Jinja, giving you loops, conditionals, expressions, and filters to generate dynamic content.

@ main {
    title   = "🎉 Fun Facts Quiz";
    message = "Test your knowledge with 10 fun questions!";

    buttons {
        question_1("Start Quiz");
    }
}

See the full example

Even in its beta stage, Telekit accelerates bot development, offering typed command parameters, text styling via Bold(), Italic(), a built-in declarative calendar picker, emoji game results for 🎲 🎯 🏀 ⚽ 🎳 🎰, and much more out of the box. Its declarative design makes bots easier to read, maintain, and extend.

Key features:

• Declarative bot logic with chains for effortless handling of complex conversations
• Ready-to-use DSL for FAQs and other interactive scripts
• Automatic handling of message formatting via Sender and callback routing
• Deep Linking support with type-checked Command Parameters for flexible user input
• Built-in Permission and Logging system for user management
• Reusable Traits system for pluggable, self-contained behavior modules
• Seamless integration with pyTelegramBotAPI
• Fast to develop and easy-to-extend code

GitHub PyPI Telegram Community

Contents

• 🌟 Tutorial
• 🎆 Gallery
• 👀 Examples
  • Dialogue
  • Risk Game
  • Counter
  • Quiz (DSL)
  • Hotel (DSL)
  • More...

Overview

Telekit is a library for building Telegram bots where dialogs look like normal method calls. No bulky state machines. No scattered handlers.

The idea is simple: you point to the next step — Telekit calls it when the user replies.

Entries

No state machines. Just tell Telekit which method should handle the next user message.

def handle(self):
    self.chain.sender.set_text("👋 Hello! What is your name?")
    self.chain.set_entry_text(self.handle_name)
    self.chain.send()

def handle_name(self, name: str):
    self.chain.sender.set_text(f"Nice to meet you, {name}!")
    self.chain.send()

The handle method sends a message and registers handle_name as the next step using set_entry_text. When the user replies, Telekit automatically calls handle_name and passes the user's message as a plain str argument.

That's it. No enums. No manual state tracking. No boilerplate.

Inline Keyboards

Buttons can either return a value or call a method directly.

Choice keyboard — map button labels to values. The selected value is passed straight into your handler:

self.chain.set_inline_choice(
    self.on_choice,
    choices={
        "Option 1": "Value 1",
        "Option 2": "Value 2",
        "Option 3": [3, "Yes, it's an array"],
    }
)

def on_choice(self, choice: str | list):
    print(f"{choice!r}") # "Value 1", "Value 2" or [3, "Yes, it's an array"]

Inside on_choice, you receive exactly what you defined in choices: a string, list, number, function — anything.

Callback keyboard — each button calls its own method:

self.chain.set_inline_keyboard({
    "« Back": self.display_previous_page,
    "Next »": self.display_next_page,
})

Useful for pagination, navigation, or menus.

Command Parameters

Telekit can parse and validate command parameters for you.

from telekit.parameters import *

class GreetHandler(telekit.Handler):
    @classmethod
    def init_handler(cls) -> None:
        cls.on.command("greet", params=[Int(), Str()]).invoke(cls.handle)

    def handle(self, age: int | None = None, name: str | None = None):
        if age is None or name is None:
            self.chain.sender.set_text("Usage: /greet <age> <name>")
        else:
            self.chain.sender.set_text(f"Hello, {name}! You are {age} years old. Next year you'll turn {age + 1} 😅")
        self.chain.send()

Now /greet 64 "Alice Reingold" or /greet 128 Dracula are parsed automatically.

[!INFO] If arguments are invalid or missing, you simply receive None and decide how to respond.

Dialogue

Dialogs are built as a chain of steps. Each method waits for the user before continuing.

class DialogueHandler(telekit.Handler):

    @classmethod
    def init_handler(cls) -> None:
        cls.on.text("hello", "hi", "hey").invoke(cls.handle_hello)

    def handle_hello(self) -> None:
        self.chain.sender.set_text("👋 Hello! What is your name?")
        if self.user.first_name:
            self.chain.set_entry_suggestions([self.user.first_name])
        self.chain.set_entry_text(self.handle_name)
        self.chain.send()

    def handle_name(self, name: str) -> None:
        self.user_name = name
        self.chain.sender.set_text("Nice! How are you feeling today?")
        self.chain.set_entry_text(self.handle_feeling)
        self.chain.send()

    def handle_feeling(self, feeling: str) -> None:
        self.chain.sender.set_text(f"Got it, {self.user_name.title()}! You feel: {feeling}")
        self.chain.set_inline_keyboard({"↺ Restart": self.handle_hello})
        self.chain.send()

How it works:

• The handler reacts to "hello", "hi", or "hey" (lowercase, UPPERCASE, or mixed).
• handle_hello asks for the user's name.
• set_entry_suggestions attaches the user's Telegram first_name as a suggestion button.
• handle_name stores the name in self.user_name.
• handle_feeling completes the flow and adds a "↺ Restart" button that routes back to the beginning.

It looks like regular Python. And reads like it too.

Sender

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

self.chain.sender.set_effect(Effect.HEART) # Add effect to message. Use enum or string
self.chain.sender.set_photo("robot.png") # Attach photo. URL, file_id, or path
self.chain.sender.set_document("README.md") # Attach document. URL, file_id, or path
self.chain.sender.set_text_as_document("Hello, this is a text document!") # Convert string to text document
self.chain.sender.send_chat_action(ChatAction.TYPING) # Send chat action. Use enum or string

[!NOTE] Telekit automatically decides whether to use 'bot.send_message' or 'bot.send_photo' based on the content

Styles

Telekit lets you describe formatting as objects instead of writing raw HTML or Markdown.

from telekit.styles import *

def handle(self) -> None:
    self.chain.sender.set_text(
        Bold("Text style examples:\n"),
        Stack(
            Bold("Bold text"),
            Italic("Italic text"),
            Bold(Italic("Bold + italic")),
            Link("Link", url="https://example.com"),
            BotLink("Deep link", username="MyBot", start="promo_42"),
            start="- {{index}}. ",
            sep=".\n",
        )
    )
    self.chain.send()

You describe structure. Telekit generates HTML or MarkdownV2 automatically:

<b>Text style examples:</b>

- 1. <b>Bold text</b>.
- 2. <i>Italic text</i>.
- 3. <b><i>Bold + italic</i></b>.
- 4. <a href="https://example.com">Link</a>.
- 5. <a href="https://t.me/MyBot?start=promo_42">Deep link</a>

No manual escaping. No broken formatting because of one missing character.

Telekit DSL

If you prefer not to write dialog logic in Python, you can use the built-in DSL with Jinja support.

import telekit

class QuizHandler(telekit.TelekitDSL.Mixin):
    @classmethod
    def init_handler(cls) -> None:
        cls.analyze_string(script)
        cls.on.command("start").invoke(cls.start_script)

script = """
$ timeout {
    time = 20; // 20 sec.
}

@ main {
    title   = "🎉 Fun Facts Quiz";
    message = "Test your knowledge with 10 fun questions!";

    buttons {
        next("Start Quiz");
    }
}

@ question_1 {
    title   = "🐶 Question 1";
    message = "Which animal is the fastest on land?";
    buttons {
        _lose("Elephant");
        next("Cheetah");       // correct answer
        _lose("Horse");
        _lose("Lion");
    }
}

/* ... */
"""

telekit.Server(BOT_TOKEN).polling()

Key features of the Telekit DSL:

• Scene-based architecture
• Anonymous scenes
• Automatic navigation stack management
• Input handling
• Images support and link buttons
• Template variables
• Custom variables
• Hooks (Python API integration)
• Jinja template engine

Click to see what you can do with the DSL

You can find a full quiz example and DSL reference in the repository.

Traits

Traits are reusable behavior modules you can mix into any handler.

This example demonstrates the simplest way to use the built-in CalendarPick trait. It allows a user to pick a date from an inline calendar and handles the result via a callback.

from telekit.traits import CalendarPick

class CalendarHandler(CalendarPick, telekit.Handler):

    @classmethod
    def init_handler(cls) -> None:
        cls.on.command("calendar").invoke(cls.handle)

    def handle(self) -> None:
        self.chain.sender.set_title("📅 Choose a date")
        self.chain.sender.set_message("Select any date — past or future:")
        self.chain.sender.set_remove_text(False)

        self.calendar_pick(self.handle_date) # HERE

    def handle_date(self, date: datetime.date) -> None:
        self.chain.sender.set_text(f"You picked: {date}")
        self.chain.send()

Result

Example Bot

You can launch an example bot by running the following code:

import telekit

telekit.example(YOUR_BOT_TOKEN)

It includes example commands, dialogs, keyboards, and style usage.

Why Telekit

• No FSM — just chains.
• Declarative, behavior-focused bot logic with minimal boilerplate.
• Automatic callback routing and input handling.
• Styles API for rich text (Bold, Italic, Links) with automatic escaping.
• Deep linking and typed command parameters.
• Built-in DSL for menus, FAQs, and simple bots.
• Reusable Traits for composable, plug-and-play behavior (for example, a built-in declarative calendar picker).
• Zero-code Obsidian Canvas mode.
• Seamless integration with pyTelegramBotAPI.

Telekit doesn't try to be everything.
It tries to make Telegram bot development easier.

[!TIP] If you're interested and want to learn more, check out the Tutorial

---

Changes in version 2.4.0b0

Scheduler

• Added every decorator for scheduling functions in a background daemon thread.
• Implemented PeriodicTask class to manage periodic execution and error handling.

Telekit DSL

InstanceDSLHandler

Instance-oriented variant of DSLHandler where each instance carries its own executable_model, _script_data_factory, and _jinja_env — allowing multiple instances to run completely independent scripts simultaneously.

Use the *_locally instance methods instead of the class-level ones:

class MyHandler(telekit.InstanceDSLHandler):
    @classmethod
    def init_handler(cls) -> None:
        cls.on.message().invoke(cls.handle)

    def handle(self):
        script = fetch_script_from_db(self.user.id)  # per-user DSL
        self.analyze_string_locally(script)
        self.start_script()

Method	Description
analyze_file_locally(path, encoding)	Analyse a script file on this instance.
analyze_string_locally(script)	Analyse a DSL string on this instance.
analyze_canvas_locally(file_path)	Analyse an Obsidian .canvas file on this instance.
analyze_executable_model_locally(model)	Load a pre-built model dict on this instance.

Security

When accepting scripts from untrusted users, restrict dangerous features via the RESTRICTED class attribute. Set DEFAULT_TIMEOUT to control the fallback timeout, and DEFAULT_CONFIG to provide a safe base config.

class SafeDSL(telekit.InstanceDSLHandler):
    RESTRICTED: list[RestrictedToken] = ["hook", "jinja", "redirect", "handoff", "config"]
    DEFAULT_TIMEOUT = 120
    DEFAULT_CONFIG  = {"template": "vars"}

Token	Effect
"handoff"	Disables handoff button type (cross-handler transitions).
"redirect"	Disables redirect button type (simulated user messages).
"hook"	Removes all on_enter, on_enter_once, on_exit, on_timeout hooks.
"jinja"	Forces template engine to "vars"; Jinja is never executed.
"timeout"	Ignores per-script timeout_time; uses DEFAULT_TIMEOUT only.
"config"	Replaces script config with DEFAULT_CONFIG; vars_* keys are preserved unless "vars" is also set.
"vars"	Removes all vars_* keys and disables {{variable}} substitution.
"images"	Strips image field from every scene.
"links"	Disables link button type (external URLs).
"suggest"	Disables suggest button type (pre-filled entry suggestions).
"entry"	Disables entry handlers (free-text input routing).
"next"	Disables next magic scene navigation.
"back"	Disables back magic scene navigation.

Others

• Enhanced Debug class with callback query tracing functionality.
• Refactored BaseSender to use send_or_handle_error.