surfgram 0.7.2

Modern asynchronous Telegram bot framework

Surfgram

Overview

Surfgram is a high-level, object-oriented framework for building scalable Telegram bots with minimal boilerplate. It's designed for developers who want a clean architecture without sacrificing flexibility.

Key Features

• ✅ Pure OOP – Classes and dependency injection
• ✅ Fast Setup – Get a bot running in under 20 lines of code
• ✅ Extensible – Add custom handlers, filters, and database integrations
• ✅ Async-Ready – Built with asyncio for high performance
• ✅ Full support for Telegram Bot API 9.0+

Development Roadmap

• Core framework implementation
• Basic command handlers
• Middleware support
• Advanced state management
• Built-in rate limiting
• Webhook support
• i18n integration
• Built-in admin panel
• Plugin system

Quick Start

1. Install using PIP:

   pip install surfgram
   

2. Create your first bot:

   from surfgram import APIObject, Bot
   from surfgram.types import Command
   from typing import Callable, List
   
   class StartCommand(Command):
       @property
       def __names__(self) -> List[str]:
           return ["start"]
   
       @property
       def __callback__(self) -> Callable:
           return self.handle
   
       async def handle(
           self,
           update: APIObject,
           bot: Bot
       ) -> None:
           await bot.send_message(
               chat_id=update.message.chat.id,
               text="Hello, world!"
           )
   

Documentation

• 📖 Full documentation
• 📚 Examples

Contributing

We welcome contributions! Please read our Contributing Guidelines for more information on how to get started.

Support

• 🐞 Found a bug? Open an Issue
• 💡 Have an idea? Start a Discussion
• 📮 Join our Telegram Channel

License

MIT License. See LICENSE for more details.