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.0.tar.gz (2.1 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.0-py3-none-any.whl (2.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apitelematel_client-0.1.0.tar.gz
  • Upload date:
  • Size: 2.1 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.0.tar.gz
Algorithm Hash digest
SHA256 3ee01f2a2997e711a9d4fb35c8ccbb461054ac85da6b3e6f514b09bbf7676375
MD5 b74e897830ef2fb2a2218382309b5329
BLAKE2b-256 eefe6631c64ee795c84f3582e8d978c3d6e3a203a3159e7fde9824bba93f484c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apitelematel_client-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45a53a1cbd0874aab059ea380e9199ea7ebcc370e43687c6802954e778637755
MD5 984b59642b64d4500722a5c56a75ce6d
BLAKE2b-256 84db9653b5184f5243b8689b5b2e76a3e31805a733a606790678bb0dd3a02561

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