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.4.tar.gz (3.9 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.4-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apitelematel_client-0.1.4.tar.gz
  • Upload date:
  • Size: 3.9 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.4.tar.gz
Algorithm Hash digest
SHA256 52bfe8b0977164abdfc8f97d3c8c2bb86b9907f69353a6cbed2117a02d4c1189
MD5 a19568c4f05e459c7d5d6e1ace4ea8d0
BLAKE2b-256 28f239db0bf534489a552d53c863c8a4592023891503a777e8e9d7f5b6d7b920

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apitelematel_client-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 eb1f85f55545c4f056f072cb28aa33425542f31e1070258d1ac9618a54d4257f
MD5 6807ae50a91f6fadb6b8994aa29f0963
BLAKE2b-256 ccf9dab22229707d773ad7114666caabc62ed90a7516d6ceb214f11a1b8ebccf

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