https://github.com/autogram/Botkit
Opinionated, library-agnostic Python framework for rapid development of Telegram bots and userbots with focus on maintainability for large projects.
https://github.com/autogram/Botkit
framework python3 telegram telegram-bot telegram-userbot
Last synced: 12 months ago
JSON representation
Opinionated, library-agnostic Python framework for rapid development of Telegram bots and userbots with focus on maintainability for large projects.
- Host: GitHub
- URL: https://github.com/autogram/Botkit
- Owner: autogram
- License: gpl-3.0
- Archived: true
- Created: 2020-07-25T03:34:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-16T03:04:43.000Z (about 3 years ago)
- Last Synced: 2024-10-30T21:37:53.207Z (over 1 year ago)
- Topics: framework, python3, telegram, telegram-bot, telegram-userbot
- Language: Python
- Homepage:
- Size: 2.33 MB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Autogram Botkit
**Warning:** At this point, the framework is very much in an alpha stage and many parts will be subject to change. Do not depend on it in production. As of now, this is just the basis of my various bot projects, but I am very actively working on smoothing
out the rough parts and delivering a comprehensive demo project using the framework.
## When is this framework for you?
1. You want to work on regular bots, userbots, or especially a _combination_ thereof (a.k.a. "companion bots") in
Python. Botkit makes it easy to combine multiple Bot API or MTProto clients from different (!) libraries.
2. You have some experience with another Telegram bot library that you would like to supercharge with more tools, testability, and best practices.
3. You **care about clean, maintainable code** and tend to work on large code bases over long stretches of time
4. You know the basics of **asyncio**.
5. You're not afraid of Python type annotations and using Pydantic (https://pydantic-docs.helpmanual.io/) sounds like a good idea to you.
6. You use a Python IDE that supports autocompletion (and this is a must)! Botkit is built from the ground up to provide fluent builder patterns that only work well if you can discover what features you have at your disposal.
## Roadmap
### Implemented features
- [ ] One config to rule them all: [Pyrogram and Telethon clients can be instantiated from a common `ClientConfig`](https://github.com/autogram/Botkit/blob/81cf9ec49ca0bde1a541605b62ca0bf9e2b055ef/botkit/configuration/client_config.py)
### In progress
- [ ]
### In design phase
- [ ]
### Under consideration
- [ ]