/bot-python

ICQ Bot API for Python

Primary LanguagePythonMIT LicenseMIT

🐍 bot-python

Pure Python interface for Bot API.

Table of contents

Introduction

This library provides complete Bot API 1.0 interface and compatible with Python 2.7, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10.

Getting started

  • 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, name=NAME, version=VERSION, api_url_base="https://api.icq.net/bot/v1"), by default we use the domain: https://api.icq.net/bot/v1

  • If you are Myteam client, you can add flag "is_myteam=True", when instantiating the Bot class. This will let you use additional chat methods.

    Example: Bot(token=TOKEN, name=NAME, is_myteam=True), by default it is False.

An example of how to use the framework can be seen in example/test_bot.py

Installing

Install using pip:

pip install --upgrade mailru-im-bot

Install from sources:

git clone https://github.com/mail-ru-im/bot-python.git
cd bot-python
python setup.py install

API description