chatops-sdk 1.0.0__tar.gz

chatops_sdk-1.0.0/LICENSE

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

chatops_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: chatops-sdk
+Version: 1.0.0
+Summary: SDK para conectar aplicaciones Python al Relay Hub de ChatOps como bots con comandos slash
+Author-email: Francisco Manzano <keoh77@gmail.com>
+License-Expression: MIT
+Keywords: chatops,bot,websocket,slash-commands,pydantic
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3,>=2.6
+Requires-Dist: websockets>=13
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
+Dynamic: license-file
+
+# chatops-sdk
+
+SDK de Python para convertir cualquier aplicación en un bot del **ChatOps Bot Control Center**.
+Declaras funciones con `@bot.command()` y el SDK genera el manifiesto de comandos a partir de sus
+type hints. El bot abre un WebSocket **saliente** hacia el Relay Hub, así que no necesita puertos
+abiertos ni IP pública.
+
+## Instalación
+
+```bash
+pip install chatops-sdk
+```
+
+Requiere Python 3.11 o superior.
+
+## Uso
+
+```python
+import os
+from typing import Literal
+
+from fastapi import FastAPI
+from chatops_sdk import BotAgent, CommandContext, UIBlock
+
+os.environ.setdefault("CHATOPS_HUB_URL", "ws://localhost:8000/ws/bot")
+os.environ.setdefault("CHATOPS_BOT_TOKEN", "bot_xxxxxxxxxxxx:secreto")
+
+bot = BotAgent(name="Mi-Bot", version="1.0.0", environment="production", project="Pagos")
+
+
+@bot.command(name="deploy", description="Despliega un servicio")
+async def deploy(ctx: CommandContext, service: str, env: Literal["staging", "prod"] = "staging", dry_run: bool = False):
+    await ctx.report_progress(40, f"Construyendo {service}...")
+    return [
+        UIBlock.header(f"✅ {service} desplegado en {env}"),
+        UIBlock.metrics([("Duración", "42s"), ("Réplicas", "3", "up")]),
+    ]
+
+
+app = FastAPI(lifespan=bot.lifespan)   # conecta al arrancar y reconecta con backoff
+```
+
+- `CHATOPS_HUB_URL`: URL del Hub (`ws://…/ws/bot` o `wss://…/ws/bot`).
+- `CHATOPS_BOT_TOKEN`: token del bot (`bot_<id>:<secreto>`), que se obtiene en el Control Center con **+ Nuevo Bot**.
+
+## Versiones
+
+Sigue [semver](https://semver.org). El protocolo con el Relay Hub es un contrato cerrado: un cambio
+incompatible en los sobres o en los `UIBlock` implica subir la versión mayor.
+
+## Licencia
+
+MIT.

chatops_sdk-1.0.0/README.md

@@ -0,0 +1,53 @@
+# chatops-sdk
+
+SDK de Python para convertir cualquier aplicación en un bot del **ChatOps Bot Control Center**.
+Declaras funciones con `@bot.command()` y el SDK genera el manifiesto de comandos a partir de sus
+type hints. El bot abre un WebSocket **saliente** hacia el Relay Hub, así que no necesita puertos
+abiertos ni IP pública.
+
+## Instalación
+
+```bash
+pip install chatops-sdk
+```
+
+Requiere Python 3.11 o superior.
+
+## Uso
+
+```python
+import os
+from typing import Literal
+
+from fastapi import FastAPI
+from chatops_sdk import BotAgent, CommandContext, UIBlock
+
+os.environ.setdefault("CHATOPS_HUB_URL", "ws://localhost:8000/ws/bot")
+os.environ.setdefault("CHATOPS_BOT_TOKEN", "bot_xxxxxxxxxxxx:secreto")
+
+bot = BotAgent(name="Mi-Bot", version="1.0.0", environment="production", project="Pagos")
+
+
+@bot.command(name="deploy", description="Despliega un servicio")
+async def deploy(ctx: CommandContext, service: str, env: Literal["staging", "prod"] = "staging", dry_run: bool = False):
+    await ctx.report_progress(40, f"Construyendo {service}...")
+    return [
+        UIBlock.header(f"✅ {service} desplegado en {env}"),
+        UIBlock.metrics([("Duración", "42s"), ("Réplicas", "3", "up")]),
+    ]
+
+
+app = FastAPI(lifespan=bot.lifespan)   # conecta al arrancar y reconecta con backoff
+```
+
+- `CHATOPS_HUB_URL`: URL del Hub (`ws://…/ws/bot` o `wss://…/ws/bot`).
+- `CHATOPS_BOT_TOKEN`: token del bot (`bot_<id>:<secreto>`), que se obtiene en el Control Center con **+ Nuevo Bot**.
+
+## Versiones
+
+Sigue [semver](https://semver.org). El protocolo con el Relay Hub es un contrato cerrado: un cambio
+incompatible en los sobres o en los `UIBlock` implica subir la versión mayor.
+
+## Licencia
+
+MIT.

chatops_sdk-1.0.0/chatops_sdk/__init__.py

@@ -0,0 +1,91 @@
+"""chatops-sdk: convierte cualquier app Python en un bot controlable desde el Control Center."""
+
+from .agent import BOT_TOKEN_ENV, HUB_URL_ENV, BotAgent, BotConfigurationError, backoff_delay
+from .decorators import (
+    CommandArgumentsError,
+    CommandContext,
+    CommandDefinitionError,
+    CommandRegistry,
+    CommandResult,
+    RegisteredCommand,
+    build_command,
+    execute_command,
+    normalize_blocks,
+)
+from .models import (
+    ActionButton,
+    ActionsBlock,
+    AnyEnvelope,
+    AnyUIBlock,
+    BotDeletedEnvelope,
+    BotMessageEnvelope,
+    BotPresenceChangedEnvelope,
+    BotPresencePayload,
+    BotRegisterEnvelope,
+    BotRegisterPayload,
+    CodeLogBlock,
+    CommandArgSchema,
+    CommandInvokeEnvelope,
+    CommandInvokePayload,
+    CommandManifest,
+    CommandSchema,
+    HeaderBlock,
+    MarkdownBlock,
+    MessageAckEnvelope,
+    MetricItem,
+    MetricsBlock,
+    ProgressBlock,
+    TableBlock,
+    UIBlockBase,
+    parse_block,
+    parse_envelope,
+)
+from .ui import BlockList, UIBlock
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "BOT_TOKEN_ENV",
+    "HUB_URL_ENV",
+    "ActionButton",
+    "ActionsBlock",
+    "AnyEnvelope",
+    "AnyUIBlock",
+    "BlockList",
+    "BotAgent",
+    "BotConfigurationError",
+    "BotDeletedEnvelope",
+    "BotMessageEnvelope",
+    "BotPresenceChangedEnvelope",
+    "BotPresencePayload",
+    "BotRegisterEnvelope",
+    "BotRegisterPayload",
+    "CodeLogBlock",
+    "CommandArgSchema",
+    "CommandArgumentsError",
+    "CommandContext",
+    "CommandDefinitionError",
+    "CommandInvokeEnvelope",
+    "CommandInvokePayload",
+    "CommandManifest",
+    "CommandRegistry",
+    "CommandResult",
+    "CommandSchema",
+    "HeaderBlock",
+    "MarkdownBlock",
+    "MessageAckEnvelope",
+    "MetricItem",
+    "MetricsBlock",
+    "ProgressBlock",
+    "RegisteredCommand",
+    "TableBlock",
+    "UIBlock",
+    "UIBlockBase",
+    "__version__",
+    "backoff_delay",
+    "build_command",
+    "execute_command",
+    "normalize_blocks",
+    "parse_block",
+    "parse_envelope",
+]