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: # Store data db.write_key("user_123", {"points": 100})

# Read data
data = db.read_key("user_123")

Running Multiple Bots

from bale import run_multiple_clients

bot1 = Client("TOKEN1") bot2 = Client("TOKEN2")

run_multiple_clients(bot1, bot2)

License

This project is licensed under the MIT License - see the LICENSE file for details.

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.1.tar.gz (35.8 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.1-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyrobale-0.2.1.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for pyrobale-0.2.1.tar.gz
Algorithm Hash digest
SHA256 f97f02b1ddfac56c02679f942e1f52039e46cbbfeec1ef6120853dabba9831b9
MD5 ef17dff3003fb8390573777df14e8a59
BLAKE2b-256 ebf7f92959af244faa14243b36c5e9fc3e4bb87ab9818a82198dcd192d98cfdd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyrobale-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 36.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for pyrobale-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 487eaf5865acf47cafe105f9635bd0d61b5458f3b9cc53ab542c6b872dbebb1c
MD5 df6db2bdacd3b425020cb1fd8b6d4f91
BLAKE2b-256 703ddb5595d34471dbed0deef89df685bfbec15e619cb650d9d7d9d0b5a1739e

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