Telegant is an elegant modern bot framework for Python, designed to provide developers with simple and elegant access to the Telegram bot API. This project is now in Beta phase. All Telegram bot api methods are now supported automatically.
- Automated coverage of all Telegram bot api methods
- Support of snake_case, camelCase and PascalCase for methods
- Asynchronous bot
- Lightweight
- Fast
- Simple
- Bot Helpers
- Regex Expressions for text messages
To install the project, simply run:
pip install telegant
For contribution to this project you have to open discussion under Contribution section. It will be decided if your request is going to be accepted or not.
from telegant import Bot
bot = Bot("YOUR_BOT_TOKEN_HERE")
@bot.hear("hello")
async def say_hello(bot, update):
await bot.send_message(text="What's up?")
#Your code here (Recommended to write your functions in order)
bot.start_polling()
If you need your bot to respond to specified text just use @bot.hear()
@bot.hear("hello")
async def say_hello(bot, update):
await bot.send_message(text="What's up?")
Or many texts
@bot.hears(["hello"])
async def say_hello(bot, update):
await bot.send_message(text="What's up?")
Ability to use different case styles
@bot.hear("hello")
async def say_hello(bot, update):
await bot.send_message(text="What's up?")
@bot.hear("hello")
async def say_hello(bot, update):
await bot.sendMessage(text="What's up?")
@bot.hear("hello")
async def say_hello(bot, update):
await bot.SendMessage(text="What's up?")
@bot.hear("hello")
async def say_hello(bot, update):
buttons = [
[
{"text": "Option 1 (inline)", "callback_data": "option1"},
]
]
#snake_case example
await bot.send_message(text="What's up?", reply_markup=buttons)
@bot.hear("hello")
async def say_hello(bot, update):
buttons = [
[
{"text": "Option 1 (reply)"},
]
]
await bot.send_message(text="What's up?", reply_markup=buttons)
Bot always detects your buttons type automatically by callback_data key. If you want to use inline buttons you have to write text and data values for each button. As it is detects your inline button when you have "data" key in your button. Otherwise, it will detect as reply keyboard.
You can assign to one function one command or many commands as needed. For single command use @bot.command() decorator.
@bot.command("start")
async def say_hello(bot, update):
await bot.send_message(text="Sup I'm start")
For several commands use @bot.commands() decorator.
@bot.commands(['help', 'ask'])
async def say_hello(bot, update):
await bot.send_message(text="You've reached for help")
Export data after command by your keys
@bot.commands(['usernameandage'])
@bot.with_args(['username', 'age'])
async def handler(bot, update, data):
await bot.send_message(text=f"Hello {data['username']}, you are {data['age']} years old.")
Telegant also offers to you simply detect your callbacks where you able to assign many or one callback to your function
@bot.callbacks(['option1', 'option2'])
async def say_hello(bot, update):
await bot.send_message(text="Callbacks are perfect!")
@bot.callback('option1')
async def say_hello(bot, update):
await bot.send_message(text="Callback is perfect")