Skip to main content

Framework for effective and reliable async telegram bot building.

Project description

Telegrinder

Framework for effective and reliable telegram bot building.

Still in development.

  • Type hinted
  • Customizable and extensible
  • Ready to use scenarios and rules
  • Fast models built on msgspec
  • Both low-level and high-level API

Getting started

Install using pip:

pip install telegrinder

Using poetry:

poetry add telegrinder

Install from github:

pip install -U https://github.com/timoniq/telegrinder/archive/dev.zip
poetry add git+https://github.com/timoniq/telegrinder.git#dev

Basic example:

from telegrinder import API, Message, Telegrinder, Token
from telegrinder.modules import logger
from telegrinder.rules import Text

api = API(token=Token("123:token"))
bot = Telegrinder(api)
logger.set_level("INFO")


@bot.on.message(Text("/start"))
async def start(message: Message):
    me = (await api.get_me()).unwrap()
    await message.answer(
        f"Hello, {message.from_user.full_name}! I'm {me.full_name}."
    )


bot.run_forever()

Documentation

Readthedocs

Community

Join our telegram forum.

Contributing

License

Telegrinder is MIT licensed
Copyright © 2022-2024 timoniq
Copyright © 2024 luwqz1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telegrinder-0.1.dev163.tar.gz (139.0 kB view hashes)

Uploaded Source

Built Distribution

telegrinder-0.1.dev163-py3-none-any.whl (178.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page