maxbridge-client 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,46 @@
1
+ # Changelog
2
+
3
+ Все заметные изменения в этом проекте будут документироваться в этом файле.
4
+
5
+ Формат основан на [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ и этот проект придерживается [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [0.2.0] - 2026-03-14
9
+
10
+ ### Добавлено
11
+ - Интерактивное меню в test_cli.py для работы с чатами
12
+ - Метод `get_chat_messages()` для получения сообщений чата
13
+ - Подробная документация API в `docs/API.md`
14
+ - Примеры использования в `examples/`
15
+ - Файл CONTRIBUTING.md для контрибьюторов
16
+ - Кэширование пользователей при логине
17
+ - Правильное отображение названий чатов
18
+
19
+ ### Изменено
20
+ - Улучшена обработка ошибок
21
+ - Обновлена структура документации
22
+ - Улучшен README.md
23
+
24
+ ### Исправлено
25
+ - Исправлен импорт в test_cli.py
26
+ - Убрано тестовое сообщение из основного скрипта
27
+
28
+ ## [0.1.0] - 2026-03-14
29
+
30
+ ### Добавлено
31
+ - Базовый WebSocket клиент для MAX API
32
+ - Авторизация по токену и SMS
33
+ - Отправка текстовых сообщений
34
+ - Управление чатами и пользователями
35
+ - Загрузка и скачивание файлов
36
+ - Модели данных (User, Chat, Message)
37
+ - Система исключений
38
+ - Асинхронный контекстный менеджер
39
+ - Базовая документация
40
+
41
+ ### Технические детали
42
+ - WebSocket соединение к `wss://ws-api.oneme.ru/websocket`
43
+ - JSON-RPC 2.0 протокол с кастомными полями
44
+ - Автоматическое keepalive
45
+ - Кэширование данных
46
+ - Обработка переподключений
@@ -0,0 +1,150 @@
1
+ # Contributing to VK Max Client
2
+
3
+ Спасибо за интерес к проекту! Вот как вы можете помочь развитию библиотеки.
4
+
5
+ ## 🚀 Быстрый старт
6
+
7
+ 1. Форкните репозиторий
8
+ 2. Создайте ветку для вашей фичи: `git checkout -b feature/amazing-feature`
9
+ 3. Установите зависимости: `./venv/bin/pip install -r requirements.txt`
10
+ 4. Внесите изменения
11
+ 5. Протестируйте: `./venv/bin/python test_cli.py`
12
+ 6. Создайте коммит: `git commit -m 'Add amazing feature'`
13
+ 7. Отправьте в ваш форк: `git push origin feature/amazing-feature`
14
+ 8. Создайте Pull Request
15
+
16
+ ## 📝 Стиль кода
17
+
18
+ ### Python стиль
19
+ - Используйте `black` для форматирования
20
+ - Следуйте PEP 8
21
+ - Добавляйте типизацию (type hints)
22
+ - Документируйте функции docstrings
23
+
24
+ ### Структура кода
25
+ ```
26
+ maxbridge/
27
+ ├── client.py # Основной клиент
28
+ ├── models.py # Модели данных
29
+ ├── exceptions.py # Исключения
30
+ ├── functions/ # API функции
31
+ │ ├── __init__.py
32
+ │ ├── messages.py # Функции сообщений
33
+ │ ├── users.py # Функции пользователей
34
+ │ └── ...
35
+ └── __init__.py
36
+ ```
37
+
38
+ ## 🧪 Тестирование
39
+
40
+ ### Запуск тестов
41
+ ```bash
42
+ ./venv/bin/python test_cli.py
43
+ ```
44
+
45
+ ### Добавление новых тестов
46
+ - Создавайте тесты в `tests/` директории
47
+ - Используйте `pytest` для запуска
48
+ - Тестируйте как успешные, так и ошибочные сценарии
49
+
50
+ ## 🔍 Отладка API
51
+
52
+ ### Анализ трафика
53
+ 1. Используйте Wireshark или аналог для захвата WebSocket трафика
54
+ 2. Анализируйте JSON пакеты
55
+ 3. Определяйте opcode для новых функций
56
+
57
+ ### Логирование
58
+ ```python
59
+ import logging
60
+ logging.basicConfig(level=logging.DEBUG)
61
+ ```
62
+
63
+ ## 📚 Добавление новой функциональности
64
+
65
+ ### 1. Исследование
66
+ - Изучите официальное приложение MAX
67
+ - Найдите нужную функцию в UI
68
+ - Захватите сетевой трафик
69
+
70
+ ### 2. Реализация
71
+ ```python
72
+ # functions/new_feature.py
73
+ async def new_function(client: MaxClient, param: str) -> dict:
74
+ """Description of the function"""
75
+ return await client.invoke_method(
76
+ opcode=NEW_OPCODE,
77
+ payload={"param": param}
78
+ )
79
+ ```
80
+
81
+ ### 3. Документация
82
+ - Добавьте docstring
83
+ - Обновите `docs/API.md`
84
+ - Добавьте пример в `examples/`
85
+
86
+ ### 4. Тестирование
87
+ - Протестируйте все сценарии
88
+ - Проверьте обработку ошибок
89
+ - Убедитесь в совместимости
90
+
91
+ ## 🐛 Сообщение об ошибках
92
+
93
+ ### Шаблон issue
94
+ ```
95
+ **Описание проблемы:**
96
+ Краткое описание
97
+
98
+ **Шаги воспроизведения:**
99
+ 1. Шаг 1
100
+ 2. Шаг 2
101
+ 3. Шаг 3
102
+
103
+ **Ожидаемое поведение:**
104
+ Что должно происходить
105
+
106
+ **Фактическое поведение:**
107
+ Что происходит на самом деле
108
+
109
+ **Скриншоты/логи:**
110
+ Приложите если возможно
111
+
112
+ **Среда:**
113
+ - OS: [Windows/Linux/Mac]
114
+ - Python: [версия]
115
+ - Версия библиотеки: [версия]
116
+ ```
117
+
118
+ ## 📋 Соглашение о коммитах
119
+
120
+ ```
121
+ feat: add new message reactions
122
+ fix: handle connection timeout
123
+ docs: update API documentation
124
+ style: format code with black
125
+ refactor: simplify message parsing
126
+ test: add tests for file upload
127
+ ```
128
+
129
+ ## 🎯 Roadmap
130
+
131
+ ### Краткосрочные цели
132
+ - [ ] Полная поддержка всех типов сообщений
133
+ - [ ] Поддержка групповых звонков
134
+ - [ ] Кэширование файлов
135
+ - [ ] Поддержка stickers
136
+
137
+ ### Долгосрочные цели
138
+ - [ ] Синхронный API wrapper
139
+ - [ ] CLI инструмент
140
+ - [ ] GUI приложение
141
+ - [ ] Поддержка других платформ
142
+
143
+ ## 📞 Контакты
144
+
145
+ - Issues: [GitHub Issues](https://github.com/username/max-bridge/issues)
146
+ - Discussions: [GitHub Discussions](https://github.com/username/max-bridge/discussions)
147
+
148
+ ## 📄 Лицензия
149
+
150
+ Все контрибуции принимаются под лицензией MIT.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 MaxBridge contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,10 @@
1
+ include README.md
2
+ include CHANGELOG.md
3
+ include CONTRIBUTING.md
4
+ include LICENSE
5
+ include requirements.txt
6
+ recursive-include docs *.md
7
+ recursive-include examples *.py
8
+ global-exclude *.pyc
9
+ global-exclude __pycache__
10
+ global-exclude .git*
@@ -0,0 +1,299 @@
1
+ Metadata-Version: 2.4
2
+ Name: maxbridge-client
3
+ Version: 0.2.0
4
+ Summary: Асинхронная Python библиотека для MAX API
5
+ Home-page: https://github.com/username/max-bridge
6
+ Author: VK Max Client Team
7
+ Author-email:
8
+ Maintainer: VK Max Client Team
9
+ License: MIT License
10
+
11
+ Copyright (c) 2026 MaxBridge contributors
12
+
13
+ Permission is hereby granted, free of charge, to any person obtaining a copy
14
+ of this software and associated documentation files (the "Software"), to deal
15
+ in the Software without restriction, including without limitation the rights
16
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
+ copies of the Software, and to permit persons to whom the Software is
18
+ furnished to do so, subject to the following conditions:
19
+
20
+ The above copyright notice and this permission notice shall be included in all
21
+ copies or substantial portions of the Software.
22
+
23
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
+ SOFTWARE.
30
+ Project-URL: Homepage, https://github.com/username/max-bridge
31
+ Project-URL: Documentation, https://github.com/username/max-bridge/docs/
32
+ Project-URL: Repository, https://github.com/username/max-bridge
33
+ Project-URL: Bug Reports, https://github.com/username/max-bridge/issues
34
+ Project-URL: Source, https://github.com/username/max-bridge
35
+ Keywords: vk,max,messenger,api,websocket,async
36
+ Classifier: Development Status :: 3 - Alpha
37
+ Classifier: Intended Audience :: Developers
38
+ Classifier: License :: OSI Approved :: MIT License
39
+ Classifier: Operating System :: OS Independent
40
+ Classifier: Programming Language :: Python :: 3
41
+ Classifier: Programming Language :: Python :: 3.9
42
+ Classifier: Programming Language :: Python :: 3.10
43
+ Classifier: Programming Language :: Python :: 3.11
44
+ Classifier: Programming Language :: Python :: 3.12
45
+ Classifier: Topic :: Communications :: Chat
46
+ Classifier: Topic :: Internet :: WWW/HTTP
47
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
48
+ Requires-Python: >=3.9
49
+ Description-Content-Type: text/markdown
50
+ License-File: LICENSE
51
+ Requires-Dist: aiohttp>=3.8.0
52
+ Requires-Dist: websockets>=12.0
53
+ Provides-Extra: dev
54
+ Requires-Dist: black; extra == "dev"
55
+ Requires-Dist: pytest; extra == "dev"
56
+ Requires-Dist: pytest-asyncio; extra == "dev"
57
+ Requires-Dist: mypy; extra == "dev"
58
+ Dynamic: home-page
59
+ Dynamic: license-file
60
+ Dynamic: requires-python
61
+
62
+ # MaxBridge
63
+
64
+ [![Python](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://www.python.org/)
65
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
+ [![Asyncio](https://img.shields.io/badge/Asyncio-Supported-green.svg)](https://docs.python.org/3/library/asyncio.html)
67
+
68
+ Асинхронная Python библиотека для взаимодействия с API мессенджера MAX через WebSocket соединение.
69
+
70
+ ## Описание
71
+
72
+ MaxBridge предоставляет удобный интерфейс для работы с мессенджером MAX, позволяя отправлять и получать сообщения, управлять чатами, пользователями и файлами в асинхронном режиме.
73
+
74
+ ## 🚀 Быстрый старт
75
+
76
+ ```python
77
+ import asyncio
78
+ from maxbridge import MaxClient
79
+
80
+ async def main():
81
+ async with MaxClient() as client:
82
+ # Авторизация по токену
83
+ await client.login_by_token("ваш_токен")
84
+
85
+ # Получение списка чатов
86
+ chats = client.get_cached_chats()
87
+ print(f"Найдено чатов: {len(chats)}")
88
+
89
+ asyncio.run(main())
90
+ ```
91
+
92
+ ## 📦 Установка
93
+
94
+ ```bash
95
+ # Установка из PyPI (предполагается, что пакет опубликован)
96
+ pip install maxbridge
97
+
98
+ # Или из исходников
99
+ git clone <repository-url>
100
+ cd max-bridge
101
+ pip install -e .
102
+ ```
103
+
104
+ ## 🔐 Авторизация
105
+
106
+ ### По токену
107
+
108
+ **Важно:** Для авторизации необходимо получить токен доступа из веб-версии MAX.
109
+
110
+ #### Как получить токен:
111
+
112
+ 1. Откройте https://web.max.ru в браузере
113
+ 2. Авторизуйтесь в вашем аккаунте
114
+ 3. Откройте DevTools (F12) → Application → Local Storage → https://web.max.ru
115
+ 4. Найдите ключ `token` и скопируйте его значение
116
+
117
+ ```python
118
+ async with MaxClient() as client:
119
+ await client.login_by_token("ваш_длинный_токен")
120
+ ```
121
+
122
+ **Примечание:** Токен является конфиденциальной информацией. Храните его securely.
123
+
124
+ ## 💬 Работа с чатами
125
+
126
+ ### Получение списка чатов
127
+
128
+ ```python
129
+ chats = client.get_cached_chats()
130
+ for chat_id, chat_info in chats.items():
131
+ print(f"ID: {chat_id}, Тип: {chat_info['type']}, Название: {chat_info.get('title', 'Диалог')}")
132
+ ```
133
+
134
+ ### Получение сообщений чата
135
+
136
+ ```python
137
+ messages = await client.get_chat_messages(chat_id=123456, count=50, offset=0)
138
+ if "payload" in messages and "messages" in messages["payload"]:
139
+ for msg_id, msg in messages["payload"]["messages"].items():
140
+ print(f"{msg['sender']}: {msg['text']}")
141
+ ```
142
+
143
+ ## 📨 Отправка сообщений
144
+
145
+ ```python
146
+ from maxbridge.functions import messages
147
+
148
+ # Текстовое сообщение
149
+ await messages.send_message(client, chat_id=123456, text="Привет!")
150
+
151
+ # С фото
152
+ await messages.send_photo(client, chat_id=123456, image_path="photo.jpg", caption="Фото")
153
+
154
+ # Реплай
155
+ await messages.reply_message(client, chat_id=123456, text="Ответ", reply_to_message_id="msg_id")
156
+ ```
157
+
158
+ ## 👥 Управление пользователями
159
+
160
+ ```python
161
+ from maxbridge.functions import users
162
+
163
+ # Информация о пользователях
164
+ user_info = await users.resolve_users(client, user_ids=[12345, 67890])
165
+
166
+ # Добавить в контакты
167
+ await users.add_to_contacts(client, user_id=12345)
168
+ ```
169
+
170
+ ## 📁 Работа с файлами
171
+
172
+ ```python
173
+ from maxbridge.functions import messages, uploads
174
+
175
+ # Отправка файла
176
+ await messages.send_file(client, chat_id=123456, file_path="document.pdf", caption="Документ")
177
+
178
+ # Скачивание файла
179
+ download_url = await uploads.download_file(
180
+ client, chat_id=123456, message_id="msg_id", file_id=789
181
+ )
182
+ ```
183
+
184
+ ## 📺 Работа с медиа
185
+
186
+ ```python
187
+ # Скачивание видео
188
+ video_url = await uploads.download_video(
189
+ client, chat_id=123456, message_id="msg_id", video_id=101112
190
+ )
191
+ ```
192
+
193
+ ## 👥 Группы и каналы
194
+
195
+ ```python
196
+ from maxbridge.functions import groups, channels
197
+
198
+ # Создание группы
199
+ await groups.create_group(client, "Название группы", participant_ids=[123, 456])
200
+
201
+ # Присоединение к каналу
202
+ await channels.join_channel(client, "username_канала")
203
+
204
+ # Информация о канале
205
+ channel_info = await channels.resolve_channel_username(client, "username")
206
+ ```
207
+
208
+ ## 🛠️ Обработка ошибок
209
+
210
+ ```python
211
+ from maxbridge.exceptions import APIError, ConnectionError
212
+
213
+ try:
214
+ await client.login_by_token("токен")
215
+ except APIError as e:
216
+ print(f"Ошибка API {e.error_code}: {e.message}")
217
+ except ConnectionError:
218
+ print("Ошибка подключения")
219
+ ```
220
+
221
+ ## 📊 Модели данных
222
+
223
+ ```python
224
+ from maxbridge.models import User, Chat, Message
225
+
226
+ # Примеры
227
+ user = User(id=123, name="Имя", username="username")
228
+ chat = Chat(id=456, title="Название", type="DIALOG")
229
+ message = Message(id="msg_id", chat_id=456, user_id=123, text="Текст")
230
+ ```
231
+
232
+ ## 🔧 Продвинутые возможности
233
+
234
+ ### Обработка событий в реальном времени
235
+
236
+ ```python
237
+ def event_handler(client, packet):
238
+ if packet.get("opcode") == 64: # Новое сообщение
239
+ print("Новое сообщение!")
240
+
241
+ client.set_packet_callback(event_handler)
242
+ ```
243
+
244
+ ### Кастомные настройки
245
+
246
+ ```python
247
+ # Профиль
248
+ profile = client.profile
249
+
250
+ # Кэшированные пользователи
251
+ users = client.get_cached_users()
252
+ ```
253
+
254
+ ## 📚 Документация
255
+
256
+ - [API Reference](docs/API.md)
257
+ - [Примеры](examples/)
258
+ - [Contributing](CONTRIBUTING.md)
259
+ - [Changelog](CHANGELOG.md)
260
+
261
+ ## 🏗️ Структура проекта
262
+
263
+ ```
264
+ maxbridge/
265
+ ├── __init__.py
266
+ ├── client.py # WebSocket клиент
267
+ ├── models.py # Модели данных
268
+ ├── exceptions.py # Исключения
269
+ ├── packet.py # Обработка пакетов
270
+ └── functions/ # API функции
271
+ ├── __init__.py
272
+ ├── messages.py # Сообщения
273
+ ├── users.py # Пользователи
274
+ ├── groups.py # Группы
275
+ ├── channels.py # Каналы
276
+ ├── profile.py # Профиль
277
+ └── uploads.py # Загрузки
278
+
279
+ docs/ # Документация
280
+ examples/ # Примеры
281
+ ```
282
+
283
+ ## ⚠️ Важные замечания
284
+
285
+ - Все методы асинхронные — используйте `await`
286
+ - Рекомендуется `async with MaxClient() as client:`
287
+ - Токены имеют срок действия
288
+ - Соблюдайте лимиты API
289
+
290
+ ## 🐛 Отладка
291
+
292
+ ```python
293
+ import logging
294
+ logging.basicConfig(level=logging.INFO)
295
+ ```
296
+
297
+ ## 📄 Лицензия
298
+
299
+ MIT License