# aiorum

[![PyPI version](https://img.shields.io/pypi/v/aiorum?style=flat-square)](https://pypi.org/project/aiorum/)
[![Python Versions](https://img.shields.io/pypi/pyversions/aiorum?style=flat-square)](https://pypi.org/project/aiorum/)
[![License: GPL v3](https://img.shields.io/pypi/l/aiorum?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.html)

**aiorum** is a modern and fully asynchronous framework for building bots on  
[flarum](https://flarum.org/) forums using [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](https://github.com/aio-libs/aiohttp).  

Make your forum bots **faster, smarter, and more powerful** ⚡

---

## ✨ Features

- 🚀 **Asynchronous** — built on `asyncio` and `aiohttp`
- 🎯 **Command system** — register bot commands with decorators
- 💬 **Events** — handle new messages and new discussions
- 🔒 **Typed API client** — safe and extensible HTTP wrapper
- 🔄 **Manager layer** — simplifies interaction with Flarum API
- 🧩 **Extensible** — ready for middlewares and custom integrations

---

## 📖 Documentation

- 📂 [Examples](https://github.com/atheop1337/aiorum/tree/main/examples) — ready-to-use bot samples  
- 📚 [Docs](https://github.com/atheop1337/aiorum/tree/main/docs) — detailed API reference and guides 
---

## 📜 License

Licensed under the **GNU General Public License v3.0 (GPL-3.0)**.  
See [LICENSE](LICENSE) for details.
