| Name | wonda JSON |
| Version |
0.7.4
JSON |
| download |
| home_page | https://github.com/wondergram-org/wonda/ |
| Summary | A light, blazing fast framework for developing capable bots. |
| upload_time | 2024-09-06 14:42:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Wonda 🍄
[//]: # "Features"
[examples]: examples/
[format text]: examples/text_styling_example.py
[upload files]: examples/file_upload_example.py
[an advanced state system]: examples/use_state_manager.py
[//]: # "Badges"
Wonda is a Telegram bot framework. It strikes a perfect balance between simple and advanced and makes bot development a breeze. Its concepts are easy to understand and extend. And, with immediate support for latest Bot API versions, it always stays up to the standard.
## Install
```bash
pip install wonda
```
A stable version of Wonda can be installed using this command. Add `--pre` to the command to install a pre-release version.
## Features
Ever wanted to build a bot? You can do that in only 6 lines of code.
```python
from wonda import Bot, Message
bot = Bot("your-token")
@bot.on.message()
async def handler(m: Message) -> None:
await m.answer("Hello world!")
bot.run_forever()
```
You can already [format text], [upload files], and make use of [an advanced state system] to build complex interactions. More features are expected to come! Check out the [examples].
## Customization
Wonda ships with few dependencies by default. To customize your experience, you may want to install some extra dependencies on top.
### Speed up event loop
```bash
pip install uvloop
```
Wonda supports uvloop, an event loop implementation which makes I/O [2-4x quicker](https://github.com/magicstack/uvloop#performance).
### Replace default JSON module
```bash
pip install orjson
```
Swap out the module that is used under the hood to manipulate JSON and increase speed up to [5 times](https://github.com/ijl/orjson#performance).
### Display tracebacks in greater detail
```bash
pip install rich
```
Check out [rich](https://github.com/textualize/rich), a library which provides amazing rich text capabilities for your logs.
## Contrubuting
This framework is a robust solution for what it's worth, but the API may be unstable for a while. That means it's not yet ready for production use.
So, if you like our work, help us develop this amazing project! Here are some ways you can help.
### With code
Contributions are welcome! [File a ticket](https://github.com/wondergram-org/wonda/issues) if you have something to say about the state of the framework.
### With finances
There are a couple options available for monetary help. Click [Sponsor](https://boosty.to/geo_madness) to see them. Thank you!
## License
This project exists thanks to the amazing work done by timoniq. Code is licensed under [MIT](LICENSE). Copyright (c) 2022-2024 kikimaradoni
Raw data
{
"_id": null,
"home_page": "https://github.com/wondergram-org/wonda/",
"name": "wonda",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/27/03/64d4ad47d3aeed926b5ceb718aa721340bc953f3c9e830c81c32a5e114bd/wonda-0.7.4.tar.gz",
"platform": null,
"description": "# Wonda \ud83c\udf44\n\n[//]: # \"Features\"\n[examples]: examples/\n[format text]: examples/text_styling_example.py\n[upload files]: examples/file_upload_example.py\n[an advanced state system]: examples/use_state_manager.py\n\n[//]: # \"Badges\"\n\n\n\n\nWonda is a Telegram bot framework. It strikes a perfect balance between simple and advanced and makes bot development a breeze. Its concepts are easy to understand and extend. And, with immediate support for latest Bot API versions, it always stays up to the standard.\n\n## Install\n\n```bash\npip install wonda\n```\n\nA stable version of Wonda can be installed using this command. Add `--pre` to the command to install a pre-release version.\n\n## Features\n\nEver wanted to build a bot? You can do that in only 6 lines of code.\n\n```python\nfrom wonda import Bot, Message\n\nbot = Bot(\"your-token\")\n\n\n@bot.on.message()\nasync def handler(m: Message) -> None:\n await m.answer(\"Hello world!\")\n\nbot.run_forever()\n```\n\nYou can already [format text], [upload files], and make use of [an advanced state system] to build complex interactions. More features are expected to come! Check out the [examples].\n\n## Customization\n\nWonda ships with few dependencies by default. To customize your experience, you may want to install some extra dependencies on top.\n\n### Speed up event loop\n\n```bash\npip install uvloop\n```\n\nWonda supports uvloop, an event loop implementation which makes I/O [2-4x quicker](https://github.com/magicstack/uvloop#performance).\n\n### Replace default JSON module\n\n```bash\npip install orjson\n```\n\nSwap out the module that is used under the hood to manipulate JSON and increase speed up to [5 times](https://github.com/ijl/orjson#performance).\n\n### Display tracebacks in greater detail\n\n```bash\npip install rich\n```\n\nCheck out [rich](https://github.com/textualize/rich), a library which provides amazing rich text capabilities for your logs.\n\n## Contrubuting\n\nThis framework is a robust solution for what it's worth, but the API may be unstable for a while. That means it's not yet ready for production use.\n\nSo, if you like our work, help us develop this amazing project! Here are some ways you can help.\n\n### With code\n\nContributions are welcome! [File a ticket](https://github.com/wondergram-org/wonda/issues) if you have something to say about the state of the framework.\n\n### With finances\n\nThere are a couple options available for monetary help. Click [Sponsor](https://boosty.to/geo_madness) to see them. Thank you!\n\n## License\n\nThis project exists thanks to the amazing work done by timoniq. Code is licensed under [MIT](LICENSE). Copyright (c) 2022-2024 kikimaradoni\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A light, blazing fast framework for developing capable bots.",
"version": "0.7.4",
"project_urls": {
"Homepage": "https://github.com/wondergram-org/wonda/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb266d4880b02334b210a4549625d204820a968608af8d8c37d365b8dc5b5fc7",
"md5": "3df73a807331c150665a03437bb319d5",
"sha256": "d41f906ab24845c8a93211a3e42f8fcff43b3faff1a985708fa5b528d714043e"
},
"downloads": -1,
"filename": "wonda-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3df73a807331c150665a03437bb319d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 107206,
"upload_time": "2024-09-06T14:42:09",
"upload_time_iso_8601": "2024-09-06T14:42:09.457165Z",
"url": "https://files.pythonhosted.org/packages/eb/26/6d4880b02334b210a4549625d204820a968608af8d8c37d365b8dc5b5fc7/wonda-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "270364d4ad47d3aeed926b5ceb718aa721340bc953f3c9e830c81c32a5e114bd",
"md5": "d01b06da7ce7f687af0714d63f4264ec",
"sha256": "a8a0179e3168c8296b2c276cde999b4320b16df7f22d92f055ab375526f175b2"
},
"downloads": -1,
"filename": "wonda-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "d01b06da7ce7f687af0714d63f4264ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 84116,
"upload_time": "2024-09-06T14:42:11",
"upload_time_iso_8601": "2024-09-06T14:42:11.075230Z",
"url": "https://files.pythonhosted.org/packages/27/03/64d4ad47d3aeed926b5ceb718aa721340bc953f3c9e830c81c32a5e114bd/wonda-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-06 14:42:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wondergram-org",
"github_project": "wonda",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wonda"
}
