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 git+https://github.com/yourusername/bale-bot-python.git

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyrobale-0.0.1.tar.gz
Algorithm Hash digest
SHA256 66c81731e611273387554ae218596730d7bd37a971ebfa18aed035b118527ae4
MD5 a28a0eaf69bc80187fe5d4e3c9a6c9e5
BLAKE2b-256 1799d4c71d51dfd1e1d42b28e254377a053ad347365822172afe5f0c27515956

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyrobale-0.0.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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cee5f2fdbc0d7518318dd46e5669b1aff48334ea93d69e577c037bcb16f1ff5e
MD5 8d70fcec3261b28b18a04e8171ed753e
BLAKE2b-256 7b6665cc666ee7f42ead36b7bb4f25104d164acc8a9c727a6433e83a45cc120d

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