Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bloodielie/state_manager
bots fsm for people
https://github.com/bloodielie/state_manager
aiogram async asyncio bot fsm pydantic python python-types python3 telegram-bot telegram-bot-api vk vk-api vkwave
Last synced: 2 months ago
JSON representation
bots fsm for people
- Host: GitHub
- URL: https://github.com/bloodielie/state_manager
- Owner: Bloodielie
- License: apache-2.0
- Created: 2020-06-28T16:14:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-13T20:58:27.000Z (over 3 years ago)
- Last Synced: 2024-10-01T10:02:46.900Z (3 months ago)
- Topics: aiogram, async, asyncio, bot, fsm, pydantic, python, python-types, python3, telegram-bot, telegram-bot-api, vk, vk-api, vkwave
- Language: Python
- Homepage:
- Size: 297 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StateManager - fsm for people
> Convenient FSM implementation for telegram/vk
[Russian version](https://github.com/Bloodielie/state_manager/tree/master/README_ru.md)
___
## Installation
`Supports python3.7+`
Library only
```sh
pip install state-manager
```
Library and vkwave
```sh
pip install state-manager[vk]
```
Library and aiogram
```sh
pip install state-manager[telegram]
```
Full installation
```sh
pip install state-manager[full]
```
## Examples
[VkWave](https://github.com/fscdev/vkwave)
```python
from vkwave.bots import SimpleLongPollBot
import logging
from state_manager.routes.vkwave.state import VkWaveMainStateRouter
from state_manager.models.state_managers.vkwave import VkWaveStateManager
logging.basicConfig(level=logging.INFO)
bot = SimpleLongPollBot(tokens="your token", group_id=123123,)
main_state = VkWaveMainStateRouter(bot)
@main_state.message_handler()
async def home(event: bot.SimpleBotEvent, state_manager: VkWaveStateManager):
await event.answer("go to home2")
await state_manager.set_next_state("home2")
@main_state.message_handler()
async def home2(event: bot.SimpleBotEvent, state_manager: VkWaveStateManager):
await event.answer("go to home")
await state_manager.back_to_pre_state()
main_state.install()
bot.run_forever(ignore_errors=True)
```
[Aiogram](https://github.com/aiogram/aiogram/)
```python
import logging
from aiogram import Bot, Dispatcher, executor, types
from state_manager.models.state_managers.aiogram import AiogramStateManager
from state_manager.routes.aiogram.state import AiogramMainStateRouter
logging.basicConfig(level=logging.INFO)
bot = Bot(token='your token')
dp = Dispatcher(bot)
main_state = AiogramMainStateRouter(dp)
main_state.install()
@main_state.message_handler()
async def home(msg: types.Message, state_manager: AiogramStateManager):
await msg.answer("go to home2")
await state_manager.set_next_state("home2")
@main_state.message_handler()
async def home2(msg: types.Message, state_manager: AiogramStateManager):
await msg.answer("go to home")
await state_manager.set_next_state("home")
executor.start_polling(dp, skip_updates=True)
```
[more examples](https://github.com/Bloodielie/state_manager/tree/master/examples)
## Storage
The library currently supports:
- RedisStorage
- MemoryStorage
If you do not pass arguments to install, Redis Storage is used, which takes the settings from env.
Settings:
- storage_dsn, default: "redis://localhost:6379"
- storage_ssl, default: None
- storage_db: default: None
- pool_size: default: 10
- storage_timeout: default: 5
## Filters
The library supports out of the box:
- text_filter
- text_contains_filter
- regex_filter
You can also write your filters.
[aiogram](https://github.com/Bloodielie/state_manager/tree/master/examples/aiogram/their_filters.py), [vkwave](https://github.com/Bloodielie/state_manager/tree/master/examples/vkwave/their_filters.py)
## TODO
- [ ] Middleware
- [ ] SyncEvent
- [ ] VkBottle support