Metadata-Version: 2.1
Name: telegrinder
Version: 0.1.dev171
Summary: Modern visionary telegram bot framework.
Home-page: https://github.com/timoniq/telegrinder
License: MIT
Keywords: asyncio,api schema,async,bot building,bot api,custom rules,telegram,telegram bot api framework,telegrinder framework,middleware,composition,framework,telegrinder,waiter machine
Author: timoniq
Author-email: tesseradecades@mail.ru
Maintainer: luwqz1
Maintainer-email: howluwqz1@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Typing :: Typed
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
Requires-Dist: certifi (>=2024.2.2,<2025.0.0)
Requires-Dist: choicelib (>=0.1.5,<0.2.0)
Requires-Dist: colorama (>=0.4.0,<0.5.0)
Requires-Dist: envparse (>=0.2.0,<0.3.0)
Requires-Dist: fntypes (>=0.1.3,<0.2.0)
Requires-Dist: msgspec (>=0.18.6,<0.19.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Requires-Dist: typing-extensions (>=4.10.0,<5.0.0)
Requires-Dist: vbml (>=1.1.post1,<2.0)
Project-URL: Bug Tracker, https://github.com/timoniq/telegrinder/issues
Project-URL: Repository, https://github.com/timoniq/telegrinder
Description-Content-Type: text/markdown

# 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:

```console
pip install telegrinder
```

Using poetry:

```console
poetry add telegrinder
```

Install from github:

```console
pip install -U https://github.com/timoniq/telegrinder/archive/dev.zip
```

```console
poetry add git+https://github.com/timoniq/telegrinder.git#dev
```

Basic example:

```python
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](https://telegrinder.readthedocs.io)

# Community

Join our [telegram forum](https://t.me/botoforum).

# [Contributing](https://github.com/timoniq/telegrinder/blob/main/contributing.md)

# License

Telegrinder is [MIT licensed](./LICENSE)\
Copyright © 2022-2024 [timoniq](https://github.com/timoniq)\
Copyright © 2024 [luwqz1](https://github.com/luwqz1)

