apitelematel-client 0.1.6

Cliente ligero para consumir la API de apitelematel desde otras aplicaciones

Cliente oficial de apitelematel

Paquete Python ligero para invocar los endpoints autorizados de apitelematel desde otras aplicaciones.

Instalación

pip install apitelematel-client

Si lo usas desde el mismo repositorio (para pruebas), instala las dependencias con pip install -e . y asegúrate de que apitelematel_client esté en el PYTHONPATH.

Configuración

Se pueden usar variables de entorno o pasar los valores manualmente:

APITELEMATEL_BASE_URL=http://servidor:5000
APITELEMATEL_SECRET_KEY=clave-secreta
APITELEMATEL_TIMEOUT=15

En código:

from apitelematel_client import ApiTelematelClient
from apitelematel_client.config import ClientSettings

settings = ClientSettings.from_env()
cliente = ApiTelematelClient(settings=settings)
resultado = cliente.query("SELECT * FROM PUB.gmclien", dsn="tlmplus", max_rows=20)

La llamada anterior limita la respuesta a 20 filas usando max_rows; si tu servidor lo soporta puedes enviar cualquier valor entero para controlar el tamaño del resultado.

También puedes instanciar ApiTelematelClient pasando directamente base_url y secret_key:

cliente = ApiTelematelClient(base_url="http://servidor:5000", secret_key="clave")

Nota: ApiTelematelClient ya añade internamente el prefijo /api/v1.0, así que solo necesitas pasar la parte de host/puerto en base_url.

Funcionalidades principales

Método	Endpoint	Parámetros relevantes
query(sql, connection_key=None, dsn=None, max_rows=None)	/query	SQL completo, connection_key/dsn y max_rows opcional
get_cliente(cod_cli, connection_key=None)	/clientes	cod_cli y connection_key opcional

Los métodos lanzan ApiTelematelClientError o ApiTelematelServerError cuando la llamada falla.

Contribuir

1. Clona el repositorio y crea un entorno virtual.
2. Ejecuta pip install -e .[dev] para tener las dependencias de tests.
3. Corre pytest tests_client antes de enviar cambios.

Licencia

Este paquete sigue la misma licencia que el proyecto principal (consulta LICENSE).