Metadata-Version: 2.1
Name: ICQBot
Version: 0.2.0b0
Summary: UNKNOWN
Home-page: https://github.com/kamuridesu/ICQBotPy
Download-URL: https://github.com/kamuridesu/ICQBotPy/archive/refs/heads/main.zip
Author: Kamuri Amorim
Author-email: luiz.k.amorim@gmail.com
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# ICQBOT
An actually working ICQ bot framework

- [Purpose](https://github.com/kamuridesu/ICQBotPy#purpose)
- [Getting Started](https://github.com/kamuridesu/ICQBotPy#getting-started)
	- [Installation](https://github.com/kamuridesu/ICQBotPy/README.md#installation)
	- [Example](https://github.com/kamuridesu/ICQBotPy/README.md#example)
- [Current State](https://github.com/kamuridesu/ICQBotPy#current-state)
- [TODO](https://github.com/kamuridesu/ICQBotPy#todo)


## Purpose
I made this bot framework for personal use, since the original ICQ bot framework is a mess and almost impossible to work with.

This bot allows for easy development and has a concise syntax based of Aiogram with a really simple async impl.

## Getting started
### Installation
You can install this framework with the command `pip install ICQBot`.
### Example
[Checkout this example](https://github.com/kamuridesu/ICQBotPy/blob/main/example.py).

## Current state
The bot does not implements full control of the ICQ new api yet, I'll try to map the other endpoints asap. The current implementations are:
- Self:
	- `​/self​/get`
- Chats:
	- `/chats/members/delete`
	- `POST /chats/avatar/set`
	- `/chats/sendActions`
	- `/chats/getInfo`
	- `/chats/getAdmins`
	- `/chats/getMembers`
	- `/chats/getBlockedUsers`
	- `/chats/getPendingUsers`
	- `/chats/blockUser`
	- `/chats/unblockUser`
	- `/chats/resolvePending`
	- `/chats/setTitle`
	- `/chats/setAbout`
	- `/chats/setRules`
	- `/chats/pinMessage`
	- `/chats/unpinMessage`
- Message:
	- `/messages/deleteMessages`
	- `/messages/sendText`
	- `/messages/editText`
	- `/messages/answerCallbackQuery`
	- `GET ​/messages​/sendFile`
	- `POST /messages/sendFile`
	- `GET /messages/sendVoice`
	- `POST /messages/sendVoice`
- Files:
	- `/files/getInfo`
	- `/messages/sendFile`
- Events:
	- `/events/get`
		- `newMessage`
		- `callbackQuery`


## TODO
- Map all of the others endpoints
- Use matches with regex or string match to search for terms in messages


