Metadata-Version: 2.1
Name: wonda
Version: 0.5.5
Summary: Asynchronous feature-rich Telegram bot framework for building great bots
Home-page: https://github.com/wondergram-org/wonda/
License: MIT
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: auto-reload
Provides-Extra: power-ups
Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
Requires-Dist: certifi (>=2022.6.15,<2023.0.0)
Requires-Dist: choicelib (>=0.1.5,<0.2.0)
Requires-Dist: orjson (>=3.8.5,<4.0.0); extra == "power-ups"
Requires-Dist: pydantic (>=1.10.4,<2.0.0)
Requires-Dist: typing-extensions (>=4.3.0,<5.0.0)
Requires-Dist: uvloop (>=0.16.0,<0.17.0); extra == "power-ups"
Requires-Dist: watchfiles (>=0.16.0,<0.17.0); extra == "auto-reload"
Description-Content-Type: text/markdown

# Wonda ✨

[//]: # (Examples)
[examples]: examples/high_level
[text formatting]: examples/high_level/formatting_example.py
[middleware]: examples/high_level/setup_middleware.py
[file uploading]: examples/high_level/file_upload_example.py
[blueprints]: examples/high_level/load_blueprints.py
[FSM]: examples/high_level/use_state_dispenser.py

[//]: # (Badges)
![Version](https://img.shields.io/pypi/v/wonda?label=version&style=flat-square)
![Package downloads](https://img.shields.io/pypi/dw/wonda?label=downloads&style=flat-square)
![Supported Python versions](https://img.shields.io/pypi/pyversions/wonda?label=supported%20python%20versions&style=flat-square)

## Why

Wonda can help you build bots using simple tools with exceptional performance. All batteries are included: there are [text formatting], [file uploading], [blueprints], [middleware] and [FSM].

## Flavors

### Regular

To install regular version of Wonda, enter this command in your terminal:

```shell script
pip install -U wonda
```

If you decide to go beta, use the same command with `--pre` option or update from dev branch .zip [archive](https://github.com/wondergram-org/wonda/archive/refs/heads/dev.zip).

### Performance

Wonda is built with customizations in mind, so you can squeeze out the most speed from it. To do so, install it with some extras:

```shell script
pip install --force wonda[power-ups]
```

To see the full list of extra packages, refer to our [project file](pyproject.toml).

## Guide

It's easy to build a bot with Wonda — it's ready in *six* lines of code. Extending it is no problem too.

```python
from wonda import Bot

bot = Bot("your-token")


@bot.on.message()
async def handler(_) -> str:
    return "Hello world!"

bot.run_forever()
```

With Wonda, it's possible to achieve this much with so little code. To get started, check out our [examples].

## Contributing

Wonda is a work in progress and a lot of stuff is expected to change! It's the right time for your input.

If you want to report a bug or suggest a feature, [create an issue](https://github.com/wondergram-org/wonda/issues/new/choose). To ask a question, please use [discussions](https://github.com/wondergram-org/wonda/discussions). Big thanks!

## License

This project is MIT licensed. Based upon hard work of maintainers and contributors of [VKBottle](https://github.com/vkbottle/vkbottle).

Copyright © timoniq (2019-2021), feeeek (2022), geo-madness (2022-2023)

