Skip to main content

A python wrapper for bale api

Project description

pyrobaletext

Bale Bot API Python Library

A Python wrapper for the Bale Bot API that makes it easy to build Bale bots.

Features

  • Full Bale Bot API support
  • Object-oriented design
  • Easy-to-use interface
  • Support for:
    • Messages
    • Photos
    • Documents
    • Audio
    • Video
    • Voice messages
    • Location
    • Contact sharing
    • Inline keyboards
    • Menu keyboards
    • Callback queries
    • Chat administration
    • Payment system
    • Database integration

Installation

pip install pyrobale

Quick Start

from bale import Client, MenuKeyboardMarkup, MenuKeyboardButton

# Initialize bot with token
bot = Client("YOUR_BOT_TOKEN")

# Handle incoming messages
@bot.on_message
def handle_message(message):
    if message.text == "/start":
        # Create keyboard
        keyboard = MenuKeyboardMarkup()
        keyboard.add(MenuKeyboardButton("Hello!"))
  
        # Send welcome message
        message.reply_message("Welcome!", reply_markup=keyboard)

# Start the bot
bot.run()

Key Components

Client

The main class for interacting with Bale API. Handles all API requests and provides event decorators.

Message

Represents a message in Bale with methods for replying, editing, and deleting messages.

User

Represents a Bale user with their properties and methods.

Chat

Represents a chat conversation with methods for sending messages and managing chat settings.

Keyboards

  • MenuKeyboardMarkup: For creating text keyboards
  • InlineKeyboardMarkup: For creating inline keyboards

Database

Built-in SQLite database support for storing persistent data.

Event Handlers

Message handler

@bot.on_message
def handle_message(message):
    pass

Callback query handler

@bot.on_callback_query
def handle_callback(callback):
    pass

Periodic task handler

@bot.on_tick(60)  # Runs every 60 seconds
def handle_tick():
    pass

Ready event handler

@bot.on_ready
def handle_ready():
    pass

Member join handler

@bot.on_member_chat_join
def handle_join(message, chat, user):
    pass

Member leave handler

@bot.on_member_chat_leave
def handle_leave(message, chat, user):
    pass

Database Usage

Access database

with bot.database as db:
    db.write_key("user_123", {"points": 100})
  
    data = db.read_key("user_123")

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrobale-0.2.8.3.tar.gz (73.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyrobale-0.2.8.3-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

Details for the file pyrobale-0.2.8.3.tar.gz.

File metadata

  • Download URL: pyrobale-0.2.8.3.tar.gz
  • Upload date:
  • Size: 73.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for pyrobale-0.2.8.3.tar.gz
Algorithm Hash digest
SHA256 c57bca60a89286de2deb710c1e06914f357e4eaf75c5052c6980ba815dc9d27f
MD5 3f0bd04c03b09e867876d198bd8d9cb0
BLAKE2b-256 5e00c016f84dbdf94b65d141817b920dae161fb35e8435f89864ecf5182b59c4

See more details on using hashes here.

File details

Details for the file pyrobale-0.2.8.3-py3-none-any.whl.

File metadata

  • Download URL: pyrobale-0.2.8.3-py3-none-any.whl
  • Upload date:
  • Size: 39.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for pyrobale-0.2.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a1e2dffffba960dcd86a937037d7261144a66892970f1b655321ce8dc75cafd9
MD5 a430a403212435c54d050ad5fe67f883
BLAKE2b-256 bc8181f0d7ef6f8ac2a958fcb396e990c0ba7fdc00ba365e51280b0b5c1c9152

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page