Metadata-Version: 2.4
Name: kamihi
Version: 0.5.2
Summary: Framework for building Telegram bots in Python
Project-URL: Documentation, https://kamihi-dev.github.io/kamihi/
Project-URL: Repository, https://github.com/kamihi-dev/kamihi
Project-URL: Issues, https://github.com/kamihi-dev/kamihi/issues
Project-URL: Changelog, https://github.com/kamihi-dev/kamihi/blob/master/CHANGELOG.md
Author-email: kiinami <kinami@posteo.net>
License-Expression: MIT
License-File: LICENSE.md
Keywords: bot,framework,python,python-telegram-bot,telegram
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Pydantic
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: apprise>=1.9.2
Requires-Dist: jinja2>=3.1.6
Requires-Dist: loguru>=0.7.3
Requires-Dist: multipledispatch>=1.0.0
Requires-Dist: pydantic-settings>=2.8.1
Requires-Dist: pydantic>=2.10.6
Requires-Dist: python-telegram-bot>=22.0
Requires-Dist: pytz>=2025.2
Requires-Dist: types-pytz>=2025.2.0.20250326
Description-Content-Type: text/markdown

<div align="center">
  <img src="https://api.iconify.design/flowbite:paper-plane-solid.svg?color=%231520A6" width="200" height="200">
  <h1>Kamihi</h1>
  <p>Python framework for rapid Telegram bot development and management</p>
    <a href="https://app.deepsource.com/gh/kamihi-dev/kamihi/" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/kamihi-dev/kamihi.svg/?label=code+coverage&show_trend=false&token=XJwx56oI7k7Bm23vhsstts9q"/></a>
</div>

> This project is currently in the early stages of development. Expect frequent changes and updates as we work towards a stable release. Your feedback and contributions are welcome!

## TL;DR

Install with:
```sh
uv add kamihi # or pip install kamihi
```

Create a bot with:
```python
from kamihi import bot

@bot.action
async def start():
    return "Hello! I'm your friendly bot. How can I help you today?"

bot.start({"token": "123456789:ABC-DEF1234ghIkl-zyx57W2P0s"})
```

Execute the bot with:
```
python your_script.py
```

## Documentation

The documentation is available at [kamihi-dev.github.io/kamihi](https://kamihi-dev.github.io/kamihi/). It includes a comprehensive guide to using Kamihi, including installation instructions, usage examples, and API references.

## Contributing

We welcome contributions to Kamihi! If you have an idea for a new feature, bug fix, or improvement, please open an 
issue or submit a pull request. For more information on how to contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.

## License

This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for more information.
