ICQ/VK Teams Bot API interface
Project description
Async ICQ/VK Teams bot API wrapper
Pure Async Python interface for Bot API.
Table of contents
Introduction
This library provides complete ICQ/Myteam Bot API 1.0 interface and requires Python 3.5+
Quick start
- Create your own bot by sending the /newbot command to Metabot and follow the instructions.
Note: a bot can only reply after the user has added it to his contact list, or if the user was the first to start a dialogue.
- You can configure the domain that hosts your ICQ server. When instantiating the Bot class, add the address of your domain.
Example: Bot(token=TOKEN, url="https://api.icq.net"), by default we use the domain: https://api.icq.net/bot/v1 (ICQ) or http://myteam.mail.ru (VK Teams)
Installing
Install using pip:
pip install -U async-icq
Install from sources:
git clone https://github.com/mail-ru-im/bot-python.git
cd async-icq
python setup.py install
Examples
Basic example of using this library will look like this
import random
import asyncio
from async_icq.bot import AsyncBot
from async_icq.events import Event
# Creating bot
example = AsyncBot(
token='TOKEN',
url='https://api.icq.net',
)
# Adding some basic event handler by decorators (handler must accept 2 arguments: bot and event)
# Diffent decorators will set it up for diffent types of events
@example.start_handler()
async def hello(bot: AsyncBot, event: Event):
await bot.send_text(
chatId=event.from_chat,
text=f'Hi, {event.message_author["userId"]}'
)
await bot.logger.debug(f'Answered to {event.from_chat}')
# Starting to poll new events and sending them to middleware and handlers
example.start_poll()
Example of how to use this library could be found in async-icq/examples
API description
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
async_icq-1.1.0.tar.gz
(4.5 kB
view hashes)
Built Distribution
Close
Hashes for async_icq-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4e8c230dcb869c3075e1ffa37bac6fd7b852e8482adbee54e8c578711034f5e |
|
MD5 | 60fc9b2913ce4cce5a0b114046d44997 |
|
BLAKE2b-256 | 22a04a41a50925d0992e4ff0f3da0a706f126b5ebc05afbd4fafe62ad3130806 |