lumora-bot 1.1.0__tar.gz

lumora_bot-1.1.0/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+Lumora Bot SDK for Python (`lumora-bot` on pip) and JavaScript (`lumora-bot` on npm).
+Both SDKs share one version number and one feature set. Format: [Keep a Changelog](https://keepachangelog.com/),
+versioning: [SemVer](https://semver.org/).
+
+## 1.1.0 (2026-11-05)
+
+### Added
+- **Checklists:** `send_checklist` / `sendChecklist`, `checklist_toggle`, `checklist_add`, `checklist()` and the
+  `on_checklist` / `onChecklist` handler with the list state and what changed.
+- **Reminders:** `send_reminder`, `reminder_cancel`, `reminders()` and the `on_reminder_due` / `onReminderDue` handler.
+- **Silent messages:** `silent=True` / `{ silent: true }` on every send (no sound or notification).
+- **Files:** `send_file(..., preview=..., thumb=...)` (custom preview shown before download), `on_file` / `onFile`
+  with an extensions filter, `ctx.file` (name, size, preview), `download_file()` / `ctx.download()`, `files()`,
+  `accept_file()`, `cancel_file()`. Received files go to `<data_dir>/downloads` by default.
+- **More message types:** polls, stickers, location and live location, contact cards, voice messages.
+- **Message actions:** edit, delete, pin, react, forward, mentions, reply-to, `typing`, `messages()`, `ctx.edit()` on callbacks.
+- **Groups:** `on_new_member`, `on_member_left`, `on_added_to_group`; admin actions `group_ban`, `group_unban`,
+  `group_remove`, `group_settings` / `set_slow_mode`, `group_purge_member`, `group_leave`; `group_info`, `group_access`,
+  `member_role`, `ctx.is_group_admin`, `search_groups`; `chats="private"|"group"` filters on commands and handlers;
+  `/cmd@otherbot` is ignored.
+- **Handler filters:** `on_text(regex)`, `on_message(pattern=, kinds=, chats=)`, `on_callback(data="buy:*")` or
+  `pattern=`, `on_event(name)` for raw events. Specific handlers win over catch-alls.
+- **Middleware** (`bot.middleware` / `bot.use`), `on_error`, `on_start`.
+- **Jobs:** `every(seconds)`, `daily("HH:MM")`, `after(seconds)`, `cancel(job)` for scheduled broadcasts and tasks.
+- **Errors:** `LumoraError` with `.code`, `.message`, `.detail`, `.cmd`; `LumoraTimeout`, `RunnerStopped`,
+  `NotAllowedForBots`.
+- **Runtime:** structured logging (JSON with `LUMORA_BOT_LOG_FORMAT=json`), Lumora Bot Runner log in
+  `<data_dir>/runner.log`, automatic restart of the runner, graceful shutdown on SIGTERM/Ctrl+C, events of one
+  conversation handled in order, a fair send queue (15 messages/s overall; per chat a burst of 5, then 1/s).
+- Python: optional asyncio support (`async def` handlers, `bot.aio.*`, `bot.acall`). JavaScript: TypeScript
+  declarations (`lumora-bot.d.ts`).
+- Packaging: `pyproject.toml` (`pip install lumora-bot`), `package.json` with `exports` and `types`.
+
+### Changed
+- Errors are `LumoraError` (a `RuntimeError` subclass in Python), so existing `except RuntimeError` code still works.
+  In JavaScript `err.message` is now the plain sentence; the technical cause is in `err.detail`.
+- Callbacks from a group answer in that group (`ctx.conv` is the conversation of the message whose button was pressed).
+- Commands bots must not use (remote control, recovery phrase, backups, passwords, calls) raise `NotAllowedForBots`
+  from `call()`.
+
+### Compatible
+- Bots written for 1.0 run unchanged: same constructor arguments, `command`, `on_message`, `on_callback`,
+  `on_new_user`, `send`, `broadcast`, `users`, `storage`, `roles`, `call`, `ctx.reply`, `ctx.send_file`.
+
+## 1.0.0
+
+- First release: commands with a menu, inline buttons and callbacks, bot admins and roles, JSON storage,
+  paced broadcasts, Bot Studio tokens.

lumora_bot-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lumora
+
+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.

lumora_bot-1.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: lumora-bot
+Version: 1.1.0
+Summary: Lumora Bot SDK for Python: build bots for the Lumora messaging app (commands, buttons, groups, files, checklists, reminders).
+Author: Lumora
+License: MIT
+Requires-Python: >=3.8
+Keywords: lumora,bot,chatbot,messaging,sdk,end-to-end-encryption
+Classifier: Development Status :: 5 - Production/Stable
+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 :: Only
+Classifier: Topic :: Communications :: Chat
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://getlumora.pages.dev/developers/
+Project-URL: Documentation, https://getlumora.pages.dev/developers/reference/python/
+Project-URL: Changelog, https://getlumora.pages.dev/developers/reference/#changelog
+Description-Content-Type: text/markdown
+
+# lumora-bot (Python)
+
+Build bots for the [Lumora](https://getlumora.pages.dev/) messaging app. A bot is a normal Lumora account
+run by your code through **Lumora Bot Runner** (`lumorad`): users add it by its ID or `@name·tag`,
+messages are end-to-end encrypted, and there is no server to rent.
+
+```bash
+pip install lumora-bot
+pip install https://getlumora.pages.dev/developers/packages/lumora_bot-1.1.0-py3-none-any.whl   # or the file directly
+```
+
+The SDK is one file with no dependencies (`lumora_bot.py`, Python 3.8+), so copying it next to your bot works too.
+
+```python
+from lumora_bot import Bot
+
+bot = Bot()                                   # token from $LUMORA_BOT_TOKEN (Bot Studio in the app)
+
+@bot.command("start", "Start")
+def start(ctx):
+    ctx.reply("Hi! Pick one:", buttons=[[("👍 Like", "like")]])
+
+@bot.on_callback(data="like")
+def liked(ctx):
+    ctx.edit("Thanks! 👍")
+
+bot.run()
+```
+
+```bash
+export LUMORA_BOT_TOKEN="lumora_bot_..."      # from Bot Studio in the Lumora app
+export LUMORAD=/path/to/lumorad               # Lumora Bot Runner
+python3 bot.py
+```
+
+Guides, the full API reference and deployment notes: <https://getlumora.pages.dev/developers/>.
+
+License: MIT (see LICENSE). Changes: CHANGELOG.md.

lumora_bot-1.1.0/README.md

@@ -0,0 +1,38 @@
+# lumora-bot (Python)
+
+Build bots for the [Lumora](https://getlumora.pages.dev/) messaging app. A bot is a normal Lumora account
+run by your code through **Lumora Bot Runner** (`lumorad`): users add it by its ID or `@name·tag`,
+messages are end-to-end encrypted, and there is no server to rent.
+
+```bash
+pip install lumora-bot
+pip install https://getlumora.pages.dev/developers/packages/lumora_bot-1.1.0-py3-none-any.whl   # or the file directly
+```
+
+The SDK is one file with no dependencies (`lumora_bot.py`, Python 3.8+), so copying it next to your bot works too.
+
+```python
+from lumora_bot import Bot
+
+bot = Bot()                                   # token from $LUMORA_BOT_TOKEN (Bot Studio in the app)
+
+@bot.command("start", "Start")
+def start(ctx):
+    ctx.reply("Hi! Pick one:", buttons=[[("👍 Like", "like")]])
+
+@bot.on_callback(data="like")
+def liked(ctx):
+    ctx.edit("Thanks! 👍")
+
+bot.run()
+```
+
+```bash
+export LUMORA_BOT_TOKEN="lumora_bot_..."      # from Bot Studio in the Lumora app
+export LUMORAD=/path/to/lumorad               # Lumora Bot Runner
+python3 bot.py
+```
+
+Guides, the full API reference and deployment notes: <https://getlumora.pages.dev/developers/>.
+
+License: MIT (see LICENSE). Changes: CHANGELOG.md.