| Name | telegrinder JSON |
| Version |
0.4.2
JSON |
| download |
| home_page | None |
| Summary | Modern visionary telegram bot framework. |
| upload_time | 2025-03-18 20:29:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.12 |
| license | MIT License Copyright (c) 2022-2025 timoniq Copyright (c) 2024-2025 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
composition
custom rules
framework
middleware
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.
|
# 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](https://github.com/jcrist/msgspec)
* Both low-level and high-level API
* Support [optional dependecies](https://github.com/timoniq/telegrinder/blob/dev/docs/guide/optional_dependencies.md)
# Getting started
Install using pip:
```console
pip install telegrinder
```
Using poetry:
```console
poetry add telegrinder
```
Using uv:
```console
uv add telegrinder
```
Install from github:
```console
pip install -U https://github.com/timoniq/telegrinder/archive/dev.zip
```
```console
uv add "telegrinder @ git+https://github.com/timoniq/telegrinder.git@dev"
```
```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) -> 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()
```
# 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-2025 [timoniq](https://github.com/timoniq)\
Copyright © 2024-2025 [luwqz1](https://github.com/luwqz1)
# Contributors
<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, composition, custom rules, framework, middleware, 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/24/fd/8be9da531cd5018318ad352c8c9be7cca4598302023d79d0326f1e0c2a94/telegrinder-0.4.2.tar.gz",
"platform": null,
"description": "# Telegrinder\n\nFramework for effective and reliable telegram bot building.\n\nStill in development.\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* Support [optional dependecies](https://github.com/timoniq/telegrinder/blob/dev/docs/guide/optional_dependencies.md)\n\n# Getting started\n\nInstall using pip:\n\n```console\npip install telegrinder\n```\n\nUsing poetry:\n```console\npoetry add telegrinder\n```\n\nUsing uv:\n\n```console\nuv add telegrinder\n```\n\nInstall from github:\n\n```console\npip install -U https://github.com/timoniq/telegrinder/archive/dev.zip\n```\n\n```console\nuv add \"telegrinder @ git+https://github.com/timoniq/telegrinder.git@dev\"\n```\n\n```console\npoetry add git+https://github.com/timoniq/telegrinder.git#dev\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\napi = API(token=Token(\"123:token\"))\nbot = Telegrinder(api)\nlogger.set_level(\"INFO\")\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# Documentation\n\n[Readthedocs](https://telegrinder.readthedocs.io)\n\n# Community\n\nJoin our [telegram forum](https://t.me/botoforum).\n\n# [Contributing](https://github.com/timoniq/telegrinder/blob/main/contributing.md)\n\n# License\n\nTelegrinder is [MIT licensed](./LICENSE)\\\nCopyright \u00a9 2022-2025 [timoniq](https://github.com/timoniq)\\\nCopyright \u00a9 2024-2025 [luwqz1](https://github.com/luwqz1)\n\n# Contributors\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-2025 timoniq Copyright (c) 2024-2025 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.4.2",
"project_urls": {
"Bug Tracker": "https://github.com/timoniq/telegrinder/issues",
"Documentation": "https://telegrinder.readthedocs.io/en/latest/",
"Source": "https://github.com/timoniq/telegrinder"
},
"split_keywords": [
"api schema",
" async",
" asyncio",
" bot api",
" bot building",
" composition",
" custom rules",
" framework",
" middleware",
" telegram",
" telegram bot api framework",
" telegrinder",
" telegrinder framework",
" waiter machine"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5ea8d65c68b9fc59e85821ed5cdff20c985a8a1a56f6adc069ab310283b8663b",
"md5": "9857fded0ac33696ce65b6d035140b85",
"sha256": "e45f0652fb537b01b511cbfe66a46807321d0cf72c58caab4b4bc5c241730b6d"
},
"downloads": -1,
"filename": "telegrinder-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9857fded0ac33696ce65b6d035140b85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 255797,
"upload_time": "2025-03-18T20:29:05",
"upload_time_iso_8601": "2025-03-18T20:29:05.782139Z",
"url": "https://files.pythonhosted.org/packages/5e/a8/d65c68b9fc59e85821ed5cdff20c985a8a1a56f6adc069ab310283b8663b/telegrinder-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "24fd8be9da531cd5018318ad352c8c9be7cca4598302023d79d0326f1e0c2a94",
"md5": "fbb4eab1d0f32af95bab2479667a3bb7",
"sha256": "e241aee2b9f85a844e241d88c7de8b3f3bebae872fc5648251119f3f6e19a663"
},
"downloads": -1,
"filename": "telegrinder-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "fbb4eab1d0f32af95bab2479667a3bb7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 352980,
"upload_time": "2025-03-18T20:29:07",
"upload_time_iso_8601": "2025-03-18T20:29:07.876933Z",
"url": "https://files.pythonhosted.org/packages/24/fd/8be9da531cd5018318ad352c8c9be7cca4598302023d79d0326f1e0c2a94/telegrinder-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-18 20:29:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timoniq",
"github_project": "telegrinder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "telegrinder"
}
