<img src="https://github.com/mail-ru-im/bot-python/blob/master/logo.png" width="100" height="100">
# 🐍 bot-python
Pure Python interface for Bot API.
# Table of contents
- [Introduction](#introduction)
- [Getting started](#getting-started)
- [Installing](#installing)
- [API description](#api-description)
# 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 <a href="https://icq.com/people/70001">Metabot</a> 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:
```bash
pip install --upgrade mailru-im-bot-updated
```
Install from sources:
```bash
git clone https://github.com/Lunatik-cyber/bot-python-icq.git
cd bot-python-icq
python setup.py install
```
# API description
<ul>
<li><a href="https://icq.com/botapi/">icq.com/botapi/</a></li>
<li><a href="https://agent.mail.ru/botapi/">agent.mail.ru/botapi/</a></li>
</ul>
Raw data
{
"_id": null,
"home_page": "https://github.com/mail-ru-im/bot-python",
"name": "mailru-im-bot-updated",
"maintainer": "",
"docs_url": null,
"requires_python": ">= 2.7, != 3.0.*, != 3.1.*, != 3.2.*, != 3.3.*",
"maintainer_email": "",
"keywords": "mailru im bot api",
"author": "ICQ LLC (Mail.Ru Group)",
"author_email": "support@icq.com",
"download_url": "https://files.pythonhosted.org/packages/07/6a/85d6243ea8ec13f02b9684ff7885dea38b894def55a074c60cb064b438ad/mailru-im-bot-updated-0.0.21.tar.gz",
"platform": null,
"description": "<img src=\"https://github.com/mail-ru-im/bot-python/blob/master/logo.png\" width=\"100\" height=\"100\">\r\n\r\n# \ud83d\udc0d bot-python\r\n\r\nPure Python interface for Bot API.\r\n\r\n# Table of contents\r\n- [Introduction](#introduction)\r\n- [Getting started](#getting-started)\r\n- [Installing](#installing)\r\n- [API description](#api-description)\r\n\r\n# Introduction\r\n\r\nThis 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.\r\n\r\n# Getting started\r\n\r\n* Create your own bot by sending the /newbot command to <a href=\"https://icq.com/people/70001\">Metabot</a> and follow the instructions.\r\n >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.\r\n* You can configure the domain that hosts your ICQ server. When instantiating the Bot class, add the address of your domain.\r\n > 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\r\n* 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.\r\n > Example: Bot(token=TOKEN, name=NAME, is_myteam=True), by default it is False.\r\n\r\n\r\n> An example of how to use the framework can be seen in example/test_bot.py \r\n\r\n# Installing\r\nInstall using pip:\r\n```bash\r\npip install --upgrade mailru-im-bot-updated\r\n```\r\n\r\nInstall from sources:\r\n```bash\r\ngit clone https://github.com/Lunatik-cyber/bot-python-icq.git\r\ncd bot-python-icq\r\npython setup.py install\r\n```\r\n\r\n# API description\r\n<ul>\r\n <li><a href=\"https://icq.com/botapi/\">icq.com/botapi/</a></li>\r\n <li><a href=\"https://agent.mail.ru/botapi/\">agent.mail.ru/botapi/</a></li>\r\n</ul>\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pure Python interface for Bot API. Bot cookbook for Humans.",
"version": "0.0.21",
"split_keywords": [
"mailru",
"im",
"bot",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "fc41079fba118e427719a4f4a99662e5",
"sha256": "4aab52208e8a09b46bafb94b263e7aecc98a86a54079920db90ea95c1c678bfa"
},
"downloads": -1,
"filename": "mailru-im-bot-updated-0.0.21.tar.gz",
"has_sig": false,
"md5_digest": "fc41079fba118e427719a4f4a99662e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">= 2.7, != 3.0.*, != 3.1.*, != 3.2.*, != 3.3.*",
"size": 13761,
"upload_time": "2022-12-14T23:23:34",
"upload_time_iso_8601": "2022-12-14T23:23:34.337540Z",
"url": "https://files.pythonhosted.org/packages/07/6a/85d6243ea8ec13f02b9684ff7885dea38b894def55a074c60cb064b438ad/mailru-im-bot-updated-0.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-14 23:23:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mail-ru-im",
"github_project": "bot-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "mailru-im-bot-updated"
}
JSON
