wekon 0.1.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.
- wekon-0.1.0/.gitignore +9 -0
- wekon-0.1.0/LICENSE +21 -0
- wekon-0.1.0/PKG-INFO +123 -0
- wekon-0.1.0/README.md +93 -0
- wekon-0.1.0/pyproject.toml +47 -0
- wekon-0.1.0/wekon/__init__.py +20 -0
- wekon-0.1.0/wekon/aio.py +5 -0
- wekon-0.1.0/wekon/bot.py +538 -0
- wekon-0.1.0/wekon/cards.py +263 -0
- wekon-0.1.0/wekon/client.py +524 -0
- wekon-0.1.0/wekon/errors.py +68 -0
- wekon-0.1.0/wekon/inline.py +55 -0
- wekon-0.1.0/wekon/keyboards.py +224 -0
- wekon-0.1.0/wekon/payments.py +217 -0
- wekon-0.1.0/wekon/py.typed +0 -0
- wekon-0.1.0/wekon/simple.py +175 -0
- wekon-0.1.0/wekon/types.py +240 -0
wekon-0.1.0/.gitignore
ADDED
wekon-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Wekon
|
|
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.
|
wekon-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: wekon
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Библиотека для ботов Wekon
|
|
5
|
+
Project-URL: Homepage, https://github.com/SpeachGame/wekon_python
|
|
6
|
+
Project-URL: Source, https://github.com/SpeachGame/wekon_python
|
|
7
|
+
Project-URL: Issues, https://github.com/SpeachGame/wekon_python/issues
|
|
8
|
+
Author: Wekon
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: api,async,bot,bots,wekon
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Natural Language :: Russian
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Communications :: Chat
|
|
22
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
23
|
+
Classifier: Typing :: Typed
|
|
24
|
+
Requires-Python: >=3.10
|
|
25
|
+
Requires-Dist: httpx>=0.27
|
|
26
|
+
Provides-Extra: dev
|
|
27
|
+
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
|
|
28
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
29
|
+
Description-Content-Type: text/markdown
|
|
30
|
+
|
|
31
|
+
# wekon
|
|
32
|
+
|
|
33
|
+
Библиотека для ботов Wekon на Python 3.10+.
|
|
34
|
+
|
|
35
|
+
## Установка
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
pip install wekon
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Пока пакета нет на PyPI, ставьте напрямую с GitHub:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
pip install "wekon @ git+https://github.com/SpeachGame/wekon_python.git"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Первый бот
|
|
48
|
+
|
|
49
|
+
Создайте бота у `@god_bot`, получите ключ и запишите его в переменную `WEKON_BOT_API_KEY`.
|
|
50
|
+
|
|
51
|
+
```python
|
|
52
|
+
from wekon import Bot
|
|
53
|
+
|
|
54
|
+
bot = Bot("echo_bot") # ключ из WEKON_BOT_API_KEY
|
|
55
|
+
|
|
56
|
+
@bot.command("start")
|
|
57
|
+
def start(msg):
|
|
58
|
+
msg.reply("Привет! Как вас зовут?", buttons=[("Сайт", "https://wekon.ru")])
|
|
59
|
+
|
|
60
|
+
@bot.message()
|
|
61
|
+
def echo(msg):
|
|
62
|
+
msg.reply(msg.text)
|
|
63
|
+
|
|
64
|
+
bot.run()
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Библиотека сама получает и обновляет токен, повторяет запросы при лимитах и сбоях, не шлёт
|
|
68
|
+
дубли при обрыве связи, держит порядок событий внутри чата и отвечает на нажатия кнопок.
|
|
69
|
+
|
|
70
|
+
Обычные функции работают параллельно по чатам. Для тысяч одновременных пользователей есть
|
|
71
|
+
асинхронный вариант с теми же возможностями: `from wekon.aio import Bot` и `async def`.
|
|
72
|
+
|
|
73
|
+
## Примеры
|
|
74
|
+
|
|
75
|
+
- [`examples/game_2048.py`](examples/game_2048.py) — игра: сетка кнопок, размеры, цвета, удержание.
|
|
76
|
+
- [`examples/shop_bot.py`](examples/shop_bot.py) — магазин: карточка, форма, оплата.
|
|
77
|
+
|
|
78
|
+
## Чистый экран
|
|
79
|
+
|
|
80
|
+
В личном чате с ботом можно удалять и сообщения человека, например команду или ответ на вопрос:
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
@bot.message(state="name")
|
|
84
|
+
def save_name(msg):
|
|
85
|
+
msg.delete() # ответ человека исчезает, на экране остаётся только карточка бота
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
В группе чужие сообщения удаляет только бот с правом модератора, а в подключённом чате двух людей чужие удалять нельзя.
|
|
89
|
+
|
|
90
|
+
## Файлы от людей
|
|
91
|
+
|
|
92
|
+
Фото, видео, голосовые, кружки, аудио и документы приходят во вложениях:
|
|
93
|
+
|
|
94
|
+
```python
|
|
95
|
+
@bot.message(types=["photo", "voice", "document"])
|
|
96
|
+
def save(msg):
|
|
97
|
+
file = msg.message.file # media_type, name, mime_type, size, duration
|
|
98
|
+
data = msg.download() # байты
|
|
99
|
+
msg.download(path=file.name) # или сразу на диск
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Адрес
|
|
103
|
+
|
|
104
|
+
По умолчанию `https://prod.wekon.ru/api/v1`. Другой адрес: `Bot("my_bot", base_url="...")`.
|
|
105
|
+
|
|
106
|
+
## Диалоги и счета в проде
|
|
107
|
+
|
|
108
|
+
`MemoryStorage` держит шаги диалогов и связь «заказ — счёт» в памяти: при перезапуске они
|
|
109
|
+
теряются. Для работы в проде передайте свой класс с методами `get(key)` и `set(key, state, data)`:
|
|
110
|
+
`Bot("my_bot", storage=MyStorage())`.
|
|
111
|
+
|
|
112
|
+
## Оплата
|
|
113
|
+
|
|
114
|
+
Ключи кассы остаются в вашей программе, на сервер Wekon они не попадают. Варианты на выбор:
|
|
115
|
+
|
|
116
|
+
1. Готовая касса: `bot.send_payment(chat_id, YooKassa(...), order_id, amount, title)`.
|
|
117
|
+
2. Своя интеграция и заготовка карточки: `send_invoice` и `set_invoice_status`.
|
|
118
|
+
3. Полностью своя оплата: обычные карточки, кнопки и формы.
|
|
119
|
+
|
|
120
|
+
ЮKassa и CloudPayments написаны по их документации. Т-Банк и Robokassa перед запуском сверьте
|
|
121
|
+
с документацией кассы. Ни одна касса пока не проверена настоящим платежом.
|
|
122
|
+
|
|
123
|
+
Пример: [`examples/shop_bot.py`](examples/shop_bot.py).
|
wekon-0.1.0/README.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# wekon
|
|
2
|
+
|
|
3
|
+
Библиотека для ботов Wekon на Python 3.10+.
|
|
4
|
+
|
|
5
|
+
## Установка
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pip install wekon
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Пока пакета нет на PyPI, ставьте напрямую с GitHub:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pip install "wekon @ git+https://github.com/SpeachGame/wekon_python.git"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Первый бот
|
|
18
|
+
|
|
19
|
+
Создайте бота у `@god_bot`, получите ключ и запишите его в переменную `WEKON_BOT_API_KEY`.
|
|
20
|
+
|
|
21
|
+
```python
|
|
22
|
+
from wekon import Bot
|
|
23
|
+
|
|
24
|
+
bot = Bot("echo_bot") # ключ из WEKON_BOT_API_KEY
|
|
25
|
+
|
|
26
|
+
@bot.command("start")
|
|
27
|
+
def start(msg):
|
|
28
|
+
msg.reply("Привет! Как вас зовут?", buttons=[("Сайт", "https://wekon.ru")])
|
|
29
|
+
|
|
30
|
+
@bot.message()
|
|
31
|
+
def echo(msg):
|
|
32
|
+
msg.reply(msg.text)
|
|
33
|
+
|
|
34
|
+
bot.run()
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Библиотека сама получает и обновляет токен, повторяет запросы при лимитах и сбоях, не шлёт
|
|
38
|
+
дубли при обрыве связи, держит порядок событий внутри чата и отвечает на нажатия кнопок.
|
|
39
|
+
|
|
40
|
+
Обычные функции работают параллельно по чатам. Для тысяч одновременных пользователей есть
|
|
41
|
+
асинхронный вариант с теми же возможностями: `from wekon.aio import Bot` и `async def`.
|
|
42
|
+
|
|
43
|
+
## Примеры
|
|
44
|
+
|
|
45
|
+
- [`examples/game_2048.py`](examples/game_2048.py) — игра: сетка кнопок, размеры, цвета, удержание.
|
|
46
|
+
- [`examples/shop_bot.py`](examples/shop_bot.py) — магазин: карточка, форма, оплата.
|
|
47
|
+
|
|
48
|
+
## Чистый экран
|
|
49
|
+
|
|
50
|
+
В личном чате с ботом можно удалять и сообщения человека, например команду или ответ на вопрос:
|
|
51
|
+
|
|
52
|
+
```python
|
|
53
|
+
@bot.message(state="name")
|
|
54
|
+
def save_name(msg):
|
|
55
|
+
msg.delete() # ответ человека исчезает, на экране остаётся только карточка бота
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
В группе чужие сообщения удаляет только бот с правом модератора, а в подключённом чате двух людей чужие удалять нельзя.
|
|
59
|
+
|
|
60
|
+
## Файлы от людей
|
|
61
|
+
|
|
62
|
+
Фото, видео, голосовые, кружки, аудио и документы приходят во вложениях:
|
|
63
|
+
|
|
64
|
+
```python
|
|
65
|
+
@bot.message(types=["photo", "voice", "document"])
|
|
66
|
+
def save(msg):
|
|
67
|
+
file = msg.message.file # media_type, name, mime_type, size, duration
|
|
68
|
+
data = msg.download() # байты
|
|
69
|
+
msg.download(path=file.name) # или сразу на диск
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Адрес
|
|
73
|
+
|
|
74
|
+
По умолчанию `https://prod.wekon.ru/api/v1`. Другой адрес: `Bot("my_bot", base_url="...")`.
|
|
75
|
+
|
|
76
|
+
## Диалоги и счета в проде
|
|
77
|
+
|
|
78
|
+
`MemoryStorage` держит шаги диалогов и связь «заказ — счёт» в памяти: при перезапуске они
|
|
79
|
+
теряются. Для работы в проде передайте свой класс с методами `get(key)` и `set(key, state, data)`:
|
|
80
|
+
`Bot("my_bot", storage=MyStorage())`.
|
|
81
|
+
|
|
82
|
+
## Оплата
|
|
83
|
+
|
|
84
|
+
Ключи кассы остаются в вашей программе, на сервер Wekon они не попадают. Варианты на выбор:
|
|
85
|
+
|
|
86
|
+
1. Готовая касса: `bot.send_payment(chat_id, YooKassa(...), order_id, amount, title)`.
|
|
87
|
+
2. Своя интеграция и заготовка карточки: `send_invoice` и `set_invoice_status`.
|
|
88
|
+
3. Полностью своя оплата: обычные карточки, кнопки и формы.
|
|
89
|
+
|
|
90
|
+
ЮKassa и CloudPayments написаны по их документации. Т-Банк и Robokassa перед запуском сверьте
|
|
91
|
+
с документацией кассы. Ни одна касса пока не проверена настоящим платежом.
|
|
92
|
+
|
|
93
|
+
Пример: [`examples/shop_bot.py`](examples/shop_bot.py).
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "wekon"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Библиотека для ботов Wekon"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
13
|
+
authors = [{ name = "Wekon" }]
|
|
14
|
+
keywords = ["wekon", "bot", "bots", "api", "async"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 4 - Beta",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"Natural Language :: Russian",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.10",
|
|
22
|
+
"Programming Language :: Python :: 3.11",
|
|
23
|
+
"Programming Language :: Python :: 3.12",
|
|
24
|
+
"Programming Language :: Python :: 3.13",
|
|
25
|
+
"Topic :: Communications :: Chat",
|
|
26
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
27
|
+
"Typing :: Typed",
|
|
28
|
+
]
|
|
29
|
+
dependencies = ["httpx>=0.27"]
|
|
30
|
+
|
|
31
|
+
[project.urls]
|
|
32
|
+
Homepage = "https://github.com/SpeachGame/wekon_python"
|
|
33
|
+
Source = "https://github.com/SpeachGame/wekon_python"
|
|
34
|
+
Issues = "https://github.com/SpeachGame/wekon_python/issues"
|
|
35
|
+
|
|
36
|
+
[project.optional-dependencies]
|
|
37
|
+
dev = ["pytest>=8", "pytest-asyncio>=0.23"]
|
|
38
|
+
|
|
39
|
+
[tool.hatch.build.targets.wheel]
|
|
40
|
+
packages = ["wekon"]
|
|
41
|
+
|
|
42
|
+
[tool.hatch.build.targets.sdist]
|
|
43
|
+
include = ["wekon", "README.md", "LICENSE", "pyproject.toml"]
|
|
44
|
+
|
|
45
|
+
[tool.pytest.ini_options]
|
|
46
|
+
asyncio_mode = "auto"
|
|
47
|
+
asyncio_default_fixture_loop_scope = "function"
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"""wekon — библиотека для ботов Wekon."""
|
|
2
|
+
from . import inline, payments
|
|
3
|
+
from .bot import Context, MemoryStorage
|
|
4
|
+
from .cards import Card, Form, cell, gap, item, mark, option, stat, step, tag
|
|
5
|
+
from .client import Client, bind, check_login
|
|
6
|
+
from .errors import (AuthError, BadRequest, Conflict, Forbidden, NetworkError, NotFound, NotSupported,
|
|
7
|
+
RateLimited, ServerError, WekonError)
|
|
8
|
+
from .keyboards import (ForceReply, Keyboard, RemoveKeyboard, ReplyKeyboard, button, copy_button, form_button,
|
|
9
|
+
inline_button, login_button, url_button)
|
|
10
|
+
from .simple import Bot
|
|
11
|
+
from .types import Attachment, CallbackQuery, Chat, InlineQuery, Message, Sent, Update, User
|
|
12
|
+
|
|
13
|
+
__version__ = "0.1.0"
|
|
14
|
+
__all__ = [
|
|
15
|
+
"Bot", "Client", "Context", "MemoryStorage", "Card", "Form", "Keyboard", "ReplyKeyboard", "RemoveKeyboard", "ForceReply",
|
|
16
|
+
"button", "url_button", "copy_button", "form_button", "inline_button", "login_button", "cell", "gap", "item", "mark", "option",
|
|
17
|
+
"stat", "step", "tag", "bind", "check_login", "inline", "payments", "WekonError", "AuthError", "BadRequest", "Conflict", "Forbidden",
|
|
18
|
+
"NetworkError", "NotFound", "NotSupported", "RateLimited", "ServerError", "Attachment", "CallbackQuery", "Chat", "InlineQuery",
|
|
19
|
+
"Message", "Sent", "Update", "User",
|
|
20
|
+
]
|