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.1.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.1-py3-none-any.whl (2.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apitelematel_client-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 7e6b93b3b97966739c8f86d139c0b61f3f2194a083c0c1f55255130b5506b86d
MD5 58204d643bac9ba0cbd7b2beadfdd4e0
BLAKE2b-256 47172ab85ac33dce8e42fc734f58f14a08699e131a2ef8fcdf1a751fafe8dd7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apitelematel_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 920dbb0a4dfb7d74b4b087b6587d695ed079cc36a254cde4ff47adcd93dbedd1
MD5 2752e4dbb6d69b792dc192595cb52013
BLAKE2b-256 07078b195e81818572bd1441854826abc1fcf874a03d6299ceb79290a729c452

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