Metadata-Version: 2.4
Name: unixgram-py
Version: 1.0.0
Summary: Библиотека для написания ботов Unixgram: форма pyTelegramBotAPI, ноль зависимостей
Author-email: Unixgram <dev@unixgram.com>
Maintainer-email: Unixgram <dev@unixgram.com>
License: MIT License
        
        Copyright (c) 2026 Unixgram
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://unixgram.com
Project-URL: Documentation, https://unixgram.com/docs/bots
Project-URL: Source, https://github.com/unixgram/unixgram-py
Project-URL: Issues, https://github.com/unixgram/unixgram-py/issues
Keywords: unixgram,bot,bot-api,chat,messenger
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# unixgram (Python)

Библиотека для написания ботов Unixgram. Без зависимостей — только стандартная библиотека.

Форма API повторяет `pyTelegramBotAPI`, а формат запросов — Bot API Telegram, поэтому пример,
написанный под Telegram, переносится сюда сменой одного импорта.

## Установка

```bash
pip install unixgram-py
```

Пакет называется `unixgram-py`, а импортируется как `unixgram` — имя `unixgram` на PyPI занято
чужим проектом. Зависимостей нет: весь клиент — это `urllib` из стандартной библиотеки. Бот
поднимается на любом сервере, где есть Python 3.9+.

## Первый бот

Токен выдаётся в приложении: **бургер-меню → Мои боты → Создать**. Показывается он один раз.

```python
from unixgram import Bot, InlineKeyboardMarkup, InlineKeyboardButton

bot = Bot("123456789:F7hK…")

@bot.message_handler(commands=["start"])
def start(message):
    kb = InlineKeyboardMarkup()
    kb.row(InlineKeyboardButton("Нажми", callback_data="ping"))
    bot.send_message(message.chat.id, "Привет!", reply_markup=kb)

@bot.callback_query_handler(func=lambda q: q.data == "ping")
def on_ping(query):
    bot.answer_callback_query(query.id, "Понг!", show_alert=True)

bot.polling()
```

Больше примеров — в `examples/`.

## Обработчики

Проверяются в порядке объявления, срабатывает первый подошедший. Поэтому общий обработчик
(«на любое сообщение») ставят последним — иначе он перехватит команды.

```python
@bot.message_handler(commands=["help", "start"])      # /help или /start
@bot.message_handler(content_types=["photo"])          # только картинки
@bot.message_handler(regexp=r"\d{4}")                  # текст по регулярке
@bot.message_handler(func=lambda m: m.body == "Меню")  # произвольное условие
@bot.message_handler()                                 # всё остальное
```

## Кнопки

| Класс | Где рисуется | Что приходит боту |
|---|---|---|
| `InlineKeyboardMarkup` | под сообщением | `callback_query` с `data` |
| `ReplyKeyboardMarkup` | вместо системной клавиатуры | обычное сообщение с текстом клавиши |
| `ReplyKeyboardRemove` | — | снимает клавиатуру |
| `ForceReply` | — | открывает поле ввода в режиме ответа |

У inline-кнопки ровно одно действие: `callback_data`, `url`, `web_app`, `copy_text` или
`switch_inline_query_current_chat`. Это проверяется при сборке — не в момент отправки.
`web_app` открывает страницу внутри чата и передаёт ей подписанные данные о том, кто её открыл.

**На каждое нажатие нужно ответить** `answer_callback_query`, даже пустым текстом: до ответа кнопка
у человека остаётся в состоянии ожидания.

## Методы

**Сообщения:** `send_message` (с `parse_mode`), `reply_to`, `send_photo`, `send_video`, `send_voice`,
`send_document`, `send_sticker`, `send_video_note`, `send_animation`, `send_media_group`,
`send_location`, `send_venue`, `send_poll`, `send_dice`, `send_chat_action`, `forward_message`,
`copy_message`, `edit_message_text`, `edit_message_caption`, `edit_message_reply_markup`,
`delete_message`.

**Бот:** `get_me`, `get_updates`, `answer_callback_query`, `set_my_commands`, `set_my_description`,
`set_my_short_description`, `set_webhook`, `delete_webhook`.

**Группы:** `get_chat`, `get_chat_member`, `get_chat_administrators`, `ban_chat_member`,
`promote_chat_member`, `set_chat_title`, `set_chat_photo`, `leave_chat`.

**Звёзды:** `send_invoice`, `answer_pre_checkout_query`, `refund_star_payment`.

Файл передаётся ссылкой (`send_photo(chat_id, "https://…/pic.jpg")`) или сам —
`send_photo(chat_id, InputFile("chart.png"))`, `InputFile(pdf_bytes, name="счёт.pdf")`.
Непрозрачного `file_id`, как в Telegram, здесь нет: в ответе всегда стоит адрес.

## Обработчики

```python
@bot.message_handler(commands=["start"])      # сообщение
@bot.edited_message_handler()                 # человек поправил своё сообщение
@bot.callback_query_handler()                 # нажали кнопку
@bot.pre_checkout_query_handler()             # вопрос перед списанием звёзд
@bot.my_chat_member_handler()                 # бота добавили в беседу или выгнали
```

## Оплата звёздами

```python
@bot.message_handler(commands=["buy"])
def buy(message):
    bot.send_invoice(message.chat.id, "Подписка", "Месяц доступа", payload="sub-1", amount_stars=120)

@bot.pre_checkout_query_handler()
def checkout(query):
    # ⚠️ Ответить нужно за десять секунд: человек смотрит на крутилку, без ответа платёж отменится.
    bot.answer_pre_checkout_query(query.id, ok=True)
```

Звёзды получает ВЛАДЕЛЕЦ бота: у самого бота кошелька нет. Возврат — `refund_star_payment`.

## Опрос и вебхук

`bot.polling()` — long-poll: сервер держит запрос до 25 секунд и отвечает сразу, как только
появляется обновление. Обрыв сети переживается с нарастающей паузой; отказ сервера (неверный токен)
останавливает бота с исключением — это ошибка, которую нужно увидеть, а не пережить.

Вебхук — альтернатива, а не дополнение: пока он задан, `getUpdates` отвечает отказом.

```python
bot.set_webhook("https://example.com/hook", secret_token="…")
```

Unixgram шлёт `POST` с телом `{"update_id": …, "message": {…}}` и заголовком
`X-Unixgram-Bot-Api-Secret-Token`. **Проверяйте его** — иначе адрес вебхука сам по себе становится
способом слать боту что угодно.

## Чем отличается от Bot API Telegram

- `chat_id` личного чата равен идентификатору собеседника, как в Telegram; принимается также
  `@ник`. Идентификаторы — целые числа (у групп отрицательные), как и там.
- `file_id` — это адрес файла, а не непрозрачный идентификатор; `getFile` за ненадобностью нет.
- `ban_chat_member` исключает из группы, но не банит: списка забаненных в Unixgram нет.
- Права администратора одни на всех: `promote_chat_member` даёт роль целиком.
- Платежи только в звёздах, платёжных провайдеров нет. Инлайн-режима нет.

## Другой адрес сервера

```python
bot = Bot(token, base_url="http://localhost:3000")
```

## Можно не этой библиотекой

Bot API Unixgram совместим с готовыми библиотеками для Telegram — бот переносится заменой адреса
сервера. Для aiogram:

```python
from aiogram import Bot
from aiogram.client.session.aiohttp import AiohttpSession
from aiogram.client.telegram import TelegramAPIServer

URL = "https://unixgram.com"
session = AiohttpSession(
    api=TelegramAPIServer(base=f"{URL}/api/bot/{{token}}/{{method}}", file=f"{URL}/api/bot/file/{{path}}")
)
bot = Bot(token="<токен>", session=session)
```

Рабочий пример — `docs/bots/examples/aiogram_bot.py`: тот же мини-бот, что и `examples/mini_bot.py`,
но без единой строки из `unixgram` (и лежит он вне этой библиотеки — aiogram к ней отношения не имеет). Эта библиотека остаётся ради одного: ноль зависимостей.
