Skip to main content

Pure Python interface for Bot API. Bot cookbook for Humans.

Project description

🐍 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 and 3.6.

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

Project details


Download files

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

Source Distribution

mailru-im-bot-0.0.14.tar.gz (10.4 kB view hashes)

Uploaded Source

Built Distributions

mailru_im_bot-0.0.14-py3.6.egg (29.3 kB view hashes)

Uploaded Source

mailru_im_bot-0.0.14-py2.py3-none-any.whl (12.5 kB view hashes)

Uploaded Python 2 Python 3

mailru_im_bot-0.0.14-py2.7.egg (28.3 kB view hashes)

Uploaded Source

Supported by

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