ctm-web-client 2.0.0__tar.gz

ctm_web_client-2.0.0/LICENSE

@@ -0,0 +1,17 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2026 MI19979
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.

ctm_web_client-2.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-include ctm_web_client *.py

ctm_web_client-2.0.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: ctm-web-client
+Version: 2.0.0
+Summary: Cliente Python para Control-M/EM Web: reportes, logs y monitoreo sin Automation API
+Author: MI19979
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/MI19979/ctm-web-client
+Project-URL: Issues, https://github.com/MI19979/ctm-web-client/issues
+Keywords: control-m,controlm,bmc,scheduling,monitoring,reports
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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 :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: urllib3>=1.26.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: responses>=0.23; extra == "dev"
+Dynamic: license-file
+
+# ctm-web-client
+
+Cliente Python para **Control-M/EM Web** (on-premise). Permite descargar reportes, logs de ejecucion y monitorear jobs sin necesidad de privilegios de Automation API.
+
+Funciona usando los mismos endpoints internos que utiliza la interfaz web de Control-M.
+
+## Instalacion
+
+```bash
+pip install ctm-web-client
+```
+
+O desde el codigo fuente:
+
+```bash
+pip install -e .
+```
+
+## Uso rapido
+
+```python
+from ctm_web_client import ControlMWebClient
+
+with ControlMWebClient("https://controlm-server:8443/ControlM", verify_ssl=False) as client:
+    client.login("usuario", "password")
+
+    # Jobs activos con filtros
+    jobs = client.get_jobs(status="Ended Not OK", limit=100)
+    for j in jobs:
+        print(f"{j['jobId']} | {j['name']} | {j['status']}")
+
+    # Log de ejecucion de un job
+    log = client.get_job_log("CTM_SERVER:runid")
+    print(log)
+
+    # Output del proceso
+    output = client.get_job_output("CTM_SERVER:runid")
+    print(output)
+```
+
+## Reportes desde .em.json
+
+Ejecuta cualquier reporte exportado de Control-M Web (archivos `.em.json`):
+
+```python
+import json
+
+with open("mi_reporte.em.json") as f:
+    config = json.load(f)
+
+csv_bytes = client.wait_and_download_report(config["reportName"], config)
+
+with open("reporte.csv", "wb") as f:
+    f.write(csv_bytes)
+```
+
+## Funcionalidades
+
+### Jobs activos
+
+```python
+# Listar todos (con limite)
+jobs = client.get_jobs(limit=1000)
+
+# Filtrar por nombre, folder, estado, servidor
+jobs = client.get_jobs(
+    job_name="MCTD*",
+    status="Ended Not OK",
+    ctm_server="CTM_DATIOPROD",
+)
+
+# Estado de un job especifico
+status = client.get_job_status("CTM_DATIOPROD:4e9uy")
+```
+
+### Logs y Output
+
+```python
+# Log de Control-M (eventos, tiempos, recursos)
+log = client.get_job_log("CTM_DATIOPROD:4e9uy")
+
+# Output del proceso (stdout/stderr del script)
+output = client.get_job_output("CTM_DATIOPROD:4e9uy")
+```
+
+### Reportes
+
+```python
+# Ejecutar reporte por nombre
+result = client.run_report("ACTIVO-MX-*", config)
+
+# Todo en uno: ejecutar, esperar y descargar
+csv_bytes = client.wait_and_download_report("Jobs Definitions_1", config)
+```
+
+### Infraestructura
+
+```python
+# Servidores Control-M
+servers = client.get_servers()
+
+# Recursos cuantitativos
+resources = client.get_resources()
+
+# Permisos del usuario
+rights = client.get_effective_rights()
+```
+
+### Exportadores
+
+```python
+from ctm_web_client.exporters import CSVExporter, JSONExporter, TextExporter
+
+CSVExporter.export(jobs, "jobs.csv")
+JSONExporter.export(data, "data.json")
+TextExporter.export(log_text, "job.log")
+```
+
+### Decoder Protobuf
+
+```python
+from ctm_web_client import decode_nested, decode_strings
+
+raw = client.get_servers_info()
+parsed = decode_nested(raw)
+```
+
+## Tipos de reporte soportados (.em.json)
+
+| Design | Descripcion |
+|--------|-------------|
+| `active-jobs.rptdesign` | Jobs en la red activa |
+| `forecast-execution.rptdesign` | Historial de ejecuciones |
+| `jobs-definitions.rptdesign` | Definiciones de jobs |
+
+## Requisitos
+
+- Python 3.10+
+- Acceso de red al servidor Control-M/EM Web (puerto 8443)
+- Credenciales de usuario web de Control-M (no requiere privilegios de Automation API)
+
+## Notas
+
+- El servidor tiene un limite bajo de sesiones concurrentes. Siempre usa `with` o llama `client.logout()`.
+- Los certificados SSL son self-signed en la mayoria de instalaciones on-premise. Usa `verify_ssl=False`.
+- Los `jobId` tienen formato `SERVIDOR:RUNID` (ej: `CTM_DATIOPROD:4e9uy`).
+
+## Licencia
+
+GPL-3.0-or-later (Copyleft)
+
+## Manejo de errores
+
+```python
+from ctm_web_client.exceptions import (
+    AuthenticationError,
+    SessionExpiredError,
+    ResourceNotFoundError,
+)
+
+try:
+    client.login("user", "wrong_pass")
+except AuthenticationError as e:
+    print(f"Login fallido: {e}")
+
+try:
+    log = client.get_job_log("ID_INVALIDO")
+except ResourceNotFoundError:
+    print("Job no encontrado")
+except SessionExpiredError:
+    client.login("user", "pass")  # Re-autenticar
+```
+
+## Notas importantes
+
+- La biblioteca interactúa con los endpoints internos de la interfaz web de Control-M/EM. Los paths exactos pueden variar según la versión instalada.
+- Si tu Control-M usa paths diferentes, puedes sobrescribir `ControlMWebClient._ENDPOINTS`.
+- Para certificados SSL autofirmados, usa `verify_ssl=False`.
+- Compatible con Control-M/EM v9.x y v20.x (Web interface).
+
+## Personalizar endpoints
+
+Si tu instalación de Control-M usa rutas diferentes:
+
+```python
+client = ControlMWebClient("https://server:8443/ControlM")
+client._ENDPOINTS["jobs"] = "/web/api/monitoring/jobs"
+client._ENDPOINTS["job_log"] = "/web/api/job/{job_id}/log"
+client.login("user", "pass")
+```

ctm_web_client-2.0.0/README.md

@@ -0,0 +1,190 @@
+# ctm-web-client
+
+Cliente Python para **Control-M/EM Web** (on-premise). Permite descargar reportes, logs de ejecucion y monitorear jobs sin necesidad de privilegios de Automation API.
+
+Funciona usando los mismos endpoints internos que utiliza la interfaz web de Control-M.
+
+## Instalacion
+
+```bash
+pip install ctm-web-client
+```
+
+O desde el codigo fuente:
+
+```bash
+pip install -e .
+```
+
+## Uso rapido
+
+```python
+from ctm_web_client import ControlMWebClient
+
+with ControlMWebClient("https://controlm-server:8443/ControlM", verify_ssl=False) as client:
+    client.login("usuario", "password")
+
+    # Jobs activos con filtros
+    jobs = client.get_jobs(status="Ended Not OK", limit=100)
+    for j in jobs:
+        print(f"{j['jobId']} | {j['name']} | {j['status']}")
+
+    # Log de ejecucion de un job
+    log = client.get_job_log("CTM_SERVER:runid")
+    print(log)
+
+    # Output del proceso
+    output = client.get_job_output("CTM_SERVER:runid")
+    print(output)
+```
+
+## Reportes desde .em.json
+
+Ejecuta cualquier reporte exportado de Control-M Web (archivos `.em.json`):
+
+```python
+import json
+
+with open("mi_reporte.em.json") as f:
+    config = json.load(f)
+
+csv_bytes = client.wait_and_download_report(config["reportName"], config)
+
+with open("reporte.csv", "wb") as f:
+    f.write(csv_bytes)
+```
+
+## Funcionalidades
+
+### Jobs activos
+
+```python
+# Listar todos (con limite)
+jobs = client.get_jobs(limit=1000)
+
+# Filtrar por nombre, folder, estado, servidor
+jobs = client.get_jobs(
+    job_name="MCTD*",
+    status="Ended Not OK",
+    ctm_server="CTM_DATIOPROD",
+)
+
+# Estado de un job especifico
+status = client.get_job_status("CTM_DATIOPROD:4e9uy")
+```
+
+### Logs y Output
+
+```python
+# Log de Control-M (eventos, tiempos, recursos)
+log = client.get_job_log("CTM_DATIOPROD:4e9uy")
+
+# Output del proceso (stdout/stderr del script)
+output = client.get_job_output("CTM_DATIOPROD:4e9uy")
+```
+
+### Reportes
+
+```python
+# Ejecutar reporte por nombre
+result = client.run_report("ACTIVO-MX-*", config)
+
+# Todo en uno: ejecutar, esperar y descargar
+csv_bytes = client.wait_and_download_report("Jobs Definitions_1", config)
+```
+
+### Infraestructura
+
+```python
+# Servidores Control-M
+servers = client.get_servers()
+
+# Recursos cuantitativos
+resources = client.get_resources()
+
+# Permisos del usuario
+rights = client.get_effective_rights()
+```
+
+### Exportadores
+
+```python
+from ctm_web_client.exporters import CSVExporter, JSONExporter, TextExporter
+
+CSVExporter.export(jobs, "jobs.csv")
+JSONExporter.export(data, "data.json")
+TextExporter.export(log_text, "job.log")
+```
+
+### Decoder Protobuf
+
+```python
+from ctm_web_client import decode_nested, decode_strings
+
+raw = client.get_servers_info()
+parsed = decode_nested(raw)
+```
+
+## Tipos de reporte soportados (.em.json)
+
+| Design | Descripcion |
+|--------|-------------|
+| `active-jobs.rptdesign` | Jobs en la red activa |
+| `forecast-execution.rptdesign` | Historial de ejecuciones |
+| `jobs-definitions.rptdesign` | Definiciones de jobs |
+
+## Requisitos
+
+- Python 3.10+
+- Acceso de red al servidor Control-M/EM Web (puerto 8443)
+- Credenciales de usuario web de Control-M (no requiere privilegios de Automation API)
+
+## Notas
+
+- El servidor tiene un limite bajo de sesiones concurrentes. Siempre usa `with` o llama `client.logout()`.
+- Los certificados SSL son self-signed en la mayoria de instalaciones on-premise. Usa `verify_ssl=False`.
+- Los `jobId` tienen formato `SERVIDOR:RUNID` (ej: `CTM_DATIOPROD:4e9uy`).
+
+## Licencia
+
+GPL-3.0-or-later (Copyleft)
+
+## Manejo de errores
+
+```python
+from ctm_web_client.exceptions import (
+    AuthenticationError,
+    SessionExpiredError,
+    ResourceNotFoundError,
+)
+
+try:
+    client.login("user", "wrong_pass")
+except AuthenticationError as e:
+    print(f"Login fallido: {e}")
+
+try:
+    log = client.get_job_log("ID_INVALIDO")
+except ResourceNotFoundError:
+    print("Job no encontrado")
+except SessionExpiredError:
+    client.login("user", "pass")  # Re-autenticar
+```
+
+## Notas importantes
+
+- La biblioteca interactúa con los endpoints internos de la interfaz web de Control-M/EM. Los paths exactos pueden variar según la versión instalada.
+- Si tu Control-M usa paths diferentes, puedes sobrescribir `ControlMWebClient._ENDPOINTS`.
+- Para certificados SSL autofirmados, usa `verify_ssl=False`.
+- Compatible con Control-M/EM v9.x y v20.x (Web interface).
+
+## Personalizar endpoints
+
+Si tu instalación de Control-M usa rutas diferentes:
+
+```python
+client = ControlMWebClient("https://server:8443/ControlM")
+client._ENDPOINTS["jobs"] = "/web/api/monitoring/jobs"
+client._ENDPOINTS["job_log"] = "/web/api/job/{job_id}/log"
+client.login("user", "pass")
+```

ctm_web_client-2.0.0/ctm_web_client/__init__.py

@@ -0,0 +1,32 @@
+"""
+ctm_web_client - Biblioteca para extraer reportes y logs de Control-M/EM Web
+sin necesidad de acceso al API oficial.
+
+Uso básico:
+    from ctm_web_client import ControlMWebClient
+
+    client = ControlMWebClient("https://controlm-server:8443/ControlM")
+    client.login("usuario", "contraseña")
+
+    # Obtener jobs ejecutados
+    jobs = client.get_jobs(folder="MI_FOLDER", date="2026-08-20")
+
+    # Descargar log de un job
+    log = client.get_job_log(job_id="SERVER:00abc")
+
+    # Exportar reporte
+    client.export_report("ejecuciones", format="csv", output_path="reporte.csv")
+
+    client.logout()
+"""
+
+from ctm_web_client.client_v2 import ControlMWebClient
+from ctm_web_client.exporters import JSONExporter, CSVExporter, TextExporter
+from ctm_web_client.proto_decoder import decode_em_response, decode_nested, decode_strings
+
+__version__ = "2.0.0"
+__all__ = [
+    "ControlMWebClient",
+    "JSONExporter", "CSVExporter", "TextExporter",
+    "decode_em_response", "decode_nested", "decode_strings",
+]