| Name | telegrinder JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | Modern visionary telegram bot framework. |
| upload_time | 2025-07-10 11:27:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.12 |
| license | MIT License Copyright (c) 2022 timoniq Copyright (c) 2024 luwqz1 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api schema
async
asyncio
bot api
bot building
custom rules
framework
middleware
nodes
telegram
telegram bot api framework
telegrinder
telegrinder framework
waiter machine
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p>
<a href="https://github.com/timoniq/telegrinder">
<img width="200px" height="145px" alt="Telegrinder" src="https://github.com/timoniq/telegrinder/blob/main/docs/logo.jpg">
</a>
</p>
</p>
<h1>
telegrinder
</h1>
<p>
— effective and reliable telegram bot building.
</p>
<p>
<a href="#contributors"><img alt="Still in development" src="https://img.shields.io/badge/Still_in_development-E3956B?logo=textpattern&logoColor=fff&style=flat-square&color=black"></img></a>
<a href="#license"><img alt="GitHub License" src="https://img.shields.io/github/license/timoniq/telegrinder.svg?color=lightGreen&labelColor=black&style=flat-square"></img></a>
<a href="https://docs.astral.sh/ruff/"><img alt="Code Style" src="https://img.shields.io/badge/code_style-Ruff-D7FF64?logo=ruff&logoColor=fff&style=flat-square&labelColor=black"></img></a>
<a href="https://docs.basedpyright.com/latest/"><img alt="Type Checker" src="https://img.shields.io/badge/types-basedpyright-black?logo=python&color=%23FBCA04&logoColor=edb641&labelColor=black&style=flat-square"></img></a>
<a href="https://pypi.org/project/telegrinder/"><img alt="Python versions" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Ftimoniq%2Ftelegrinder%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&style=flat-square&logo=python&logoColor=fff&labelColor=black"></img></a>
<a href="https://core.telegram.org/bots/api"><img alt="Telegram Bot API Version" src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Ftimoniq%2Ftelegrinder%2Frefs%2Fheads%2Fmain%2Ftypegen%2Fconfig.toml&query=%24.telegram-bot-api.version&style=flat-square&logo=telegram&label=Telegram%20API&labelColor=black&color=%23FBCA04"></img></a>
</p>
* Type hinted
* Customizable and extensible
* Ready to use scenarios and rules
* Fast models built on [msgspec](https://github.com/jcrist/msgspec)
* Both low-level and high-level API
Basic example:
```python
from telegrinder import API, Message, Telegrinder, Token
from telegrinder.modules import logger
from telegrinder.rules import Text
logger.set_level("INFO")
api = API(token=Token("123:token"))
bot = Telegrinder(api)
@bot.on.message(Text("/start"))
async def start(message: Message) -> None:
me = (await api.get_me()).unwrap()
await message.answer(f"Hello, {message.from_user.full_name}! I'm {me.full_name}.")
bot.run_forever()
```
# Getting started
Install using pip, uv or poetry:
<a href="https://pypi.org/project/telegrinder/"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/telegrinder.svg?labelColor=black&style=flat-square&logo=pypi"></img></a>
```console
uv add telegrinder
poetry add telegrinder
pip install telegrinder
```
Or install from source (unstable):
<a href="https://github.com/timoniq/telegrinder/actions/workflows/push.yml"><img alt="GitHub CI" src="https://img.shields.io/github/actions/workflow/status/timoniq/telegrinder/push.yml?branch=main&style=flat-square&labelColor=black&label=CI&logo=github"></img></a>
```console
uv add "telegrinder @ git+https://github.com/timoniq/telegrinder@dev"
poetry add git+https://github.com/timoniq/telegrinder.git#dev
pip install git+https://github.com/timoniq/telegrinder/archive/dev.zip
```
# Documentation
[Tutorial](/docs/tutorial/en/0_tutorial.md)
# Community
Join our [telegram forum](https://t.me/botoforum).
# License
Telegrinder is [MIT licensed](./LICENSE)\
Copyright © 2022 [timoniq](https://github.com/timoniq)\
Copyright © 2024 [luwqz1](https://github.com/luwqz1)
# Contributors
[How to contribute](https://github.com/timoniq/telegrinder/blob/main/contributing.md)
<a href="https://github.com/timoniq/telegrinder/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=timoniq/telegrinder" />
</a>
Raw data
{
"_id": null,
"home_page": null,
"name": "telegrinder",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": "luwqz1 <howluwqz1@gmail.com>",
"keywords": "api schema, async, asyncio, bot api, bot building, custom rules, framework, middleware, nodes, telegram, telegram bot api framework, telegrinder, telegrinder framework, waiter machine",
"author": null,
"author_email": "timoniq <tesseradecades@mail.ru>",
"download_url": "https://files.pythonhosted.org/packages/1b/68/9066a40c1b6b5aee9289dce4b7bc2a5a41c10b316351a304fbb48d453a82/telegrinder-0.5.1.tar.gz",
"platform": null,
"description": "<p>\n <a href=\"https://github.com/timoniq/telegrinder\">\n <img width=\"200px\" height=\"145px\" alt=\"Telegrinder\" src=\"https://github.com/timoniq/telegrinder/blob/main/docs/logo.jpg\">\n </a>\n</p>\n\n</p>\n<h1>\n telegrinder\n</h1>\n\n<p>\n\u2014 effective and reliable telegram bot building.\n</p>\n\n<p>\n <a href=\"#contributors\"><img alt=\"Still in development\" src=\"https://img.shields.io/badge/Still_in_development-E3956B?logo=textpattern&logoColor=fff&style=flat-square&color=black\"></img></a>\n <a href=\"#license\"><img alt=\"GitHub License\" src=\"https://img.shields.io/github/license/timoniq/telegrinder.svg?color=lightGreen&labelColor=black&style=flat-square\"></img></a>\n <a href=\"https://docs.astral.sh/ruff/\"><img alt=\"Code Style\" src=\"https://img.shields.io/badge/code_style-Ruff-D7FF64?logo=ruff&logoColor=fff&style=flat-square&labelColor=black\"></img></a>\n <a href=\"https://docs.basedpyright.com/latest/\"><img alt=\"Type Checker\" src=\"https://img.shields.io/badge/types-basedpyright-black?logo=python&color=%23FBCA04&logoColor=edb641&labelColor=black&style=flat-square\"></img></a>\n <a href=\"https://pypi.org/project/telegrinder/\"><img alt=\"Python versions\" src=\"https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Ftimoniq%2Ftelegrinder%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&style=flat-square&logo=python&logoColor=fff&labelColor=black\"></img></a>\n <a href=\"https://core.telegram.org/bots/api\"><img alt=\"Telegram Bot API Version\" src=\"https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Ftimoniq%2Ftelegrinder%2Frefs%2Fheads%2Fmain%2Ftypegen%2Fconfig.toml&query=%24.telegram-bot-api.version&style=flat-square&logo=telegram&label=Telegram%20API&labelColor=black&color=%23FBCA04\"></img></a>\n</p>\n\n\n* Type hinted\n* Customizable and extensible\n* Ready to use scenarios and rules\n* Fast models built on [msgspec](https://github.com/jcrist/msgspec)\n* Both low-level and high-level API\n\n\nBasic example:\n\n```python\nfrom telegrinder import API, Message, Telegrinder, Token\nfrom telegrinder.modules import logger\nfrom telegrinder.rules import Text\n\nlogger.set_level(\"INFO\")\napi = API(token=Token(\"123:token\"))\nbot = Telegrinder(api)\n\n\n@bot.on.message(Text(\"/start\"))\nasync def start(message: Message) -> None:\n me = (await api.get_me()).unwrap()\n await message.answer(f\"Hello, {message.from_user.full_name}! I'm {me.full_name}.\")\n\n\nbot.run_forever()\n```\n\n# Getting started\n\nInstall using pip, uv or poetry:\n\n <a href=\"https://pypi.org/project/telegrinder/\"><img alt=\"PyPI Version\" src=\"https://img.shields.io/pypi/v/telegrinder.svg?labelColor=black&style=flat-square&logo=pypi\"></img></a>\n\n```console\nuv add telegrinder\npoetry add telegrinder\npip install telegrinder\n```\n\nOr install from source (unstable):\n\n <a href=\"https://github.com/timoniq/telegrinder/actions/workflows/push.yml\"><img alt=\"GitHub CI\" src=\"https://img.shields.io/github/actions/workflow/status/timoniq/telegrinder/push.yml?branch=main&style=flat-square&labelColor=black&label=CI&logo=github\"></img></a>\n\n```console\nuv add \"telegrinder @ git+https://github.com/timoniq/telegrinder@dev\"\npoetry add git+https://github.com/timoniq/telegrinder.git#dev\npip install git+https://github.com/timoniq/telegrinder/archive/dev.zip\n```\n\n# Documentation\n\n[Tutorial](/docs/tutorial/en/0_tutorial.md)\n\n# Community\n\nJoin our [telegram forum](https://t.me/botoforum).\n\n# License\n\nTelegrinder is [MIT licensed](./LICENSE)\\\nCopyright \u00a9 2022 [timoniq](https://github.com/timoniq)\\\nCopyright \u00a9 2024 [luwqz1](https://github.com/luwqz1)\n\n# Contributors\n\n[How to contribute](https://github.com/timoniq/telegrinder/blob/main/contributing.md)\n\n\n<a href=\"https://github.com/timoniq/telegrinder/graphs/contributors\">\n <img src=\"https://contributors-img.web.app/image?repo=timoniq/telegrinder\" />\n</a>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 timoniq Copyright (c) 2024 luwqz1 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Modern visionary telegram bot framework.",
"version": "0.5.1",
"project_urls": {
"Bug Tracker": "https://github.com/timoniq/telegrinder/issues",
"Documentation": "https://github.com/timoniq/telegrinder/blob/dev/docs/index.md",
"Source": "https://github.com/timoniq/telegrinder"
},
"split_keywords": [
"api schema",
" async",
" asyncio",
" bot api",
" bot building",
" custom rules",
" framework",
" middleware",
" nodes",
" telegram",
" telegram bot api framework",
" telegrinder",
" telegrinder framework",
" waiter machine"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f9ad910cb6de397418d9aeb6a7132956a5452960a391c42ad8e5a1494affa1cf",
"md5": "2f317879d6c585ec42eb1c01f74c4b48",
"sha256": "e16df97936844aa998c0cc75c735026f38164ea453a178667303cae9c8d10a8a"
},
"downloads": -1,
"filename": "telegrinder-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f317879d6c585ec42eb1c01f74c4b48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 283144,
"upload_time": "2025-07-10T11:27:38",
"upload_time_iso_8601": "2025-07-10T11:27:38.305286Z",
"url": "https://files.pythonhosted.org/packages/f9/ad/910cb6de397418d9aeb6a7132956a5452960a391c42ad8e5a1494affa1cf/telegrinder-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1b689066a40c1b6b5aee9289dce4b7bc2a5a41c10b316351a304fbb48d453a82",
"md5": "ebcbce4a4e9d64e347f4f108777fc3e8",
"sha256": "711b622598f132ba645aa9c496a066abb2e6d63ce53d3650d52da08e031ec20b"
},
"downloads": -1,
"filename": "telegrinder-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "ebcbce4a4e9d64e347f4f108777fc3e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 459320,
"upload_time": "2025-07-10T11:27:40",
"upload_time_iso_8601": "2025-07-10T11:27:40.392475Z",
"url": "https://files.pythonhosted.org/packages/1b/68/9066a40c1b6b5aee9289dce4b7bc2a5a41c10b316351a304fbb48d453a82/telegrinder-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 11:27:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timoniq",
"github_project": "telegrinder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "telegrinder"
}
