Skip to main content

Cliente ligero para consumir la API de apitelematel desde otras aplicaciones

Project description

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/api_v1.0
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")

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

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

Funcionalidades principales

Método Endpoint Parámetros relevantes
query(sql, connection_key=None, dsn=None) /query SQL completo, opciona connection_key/dsn
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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apitelematel_client-0.1.2.tar.gz (1.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apitelematel_client-0.1.2-py3-none-any.whl (2.0 kB view details)

Uploaded Python 3

File details

Details for the file apitelematel_client-0.1.2.tar.gz.

File metadata

  • Download URL: apitelematel_client-0.1.2.tar.gz
  • Upload date:
  • Size: 1.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for apitelematel_client-0.1.2.tar.gz
Algorithm Hash digest
SHA256 272c1e9ed220722177bb1eceff8d52e6876315840c9ca6421bf75c022d6096fc
MD5 9f7422b76eff838ef4454f1c8d9eafc6
BLAKE2b-256 e3005ec44bc5ea3982bc5dc1cd0dea03402b2bfc565357474b214075f2e45eda

See more details on using hashes here.

File details

Details for the file apitelematel_client-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for apitelematel_client-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d6153323487e40b853dd10150b5fb75049a409435b87a33d61d0a094daab7763
MD5 4ef98cb4d10353cb1f77620f363bd035
BLAKE2b-256 5e8bd2bd1f683378b6e20b06ac78f5ba10f560997ad69fc6ae8407d6cfa01ef6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page