Skip to main content

Python library for PVM

Project description

pvmlib

Una librería personalizada para manejo de logging, validación de tokens, manejo de excepciones y consumo de servicios REST.

Instalación

Para instalar la librería, usa pip:

pip install pvmlib

Implementación

Logger

from pvmlib import logger_singleton, default_logger, application, measurement
from datetime import datetime

# Crear instancias de Application y Measurement
app_info = application(
    name="bs-customer",
    version="1.3.7",
    env="PROD",
    kind="rest-service"
)

measure = measurement(
    method="getClientInfo",
    elapsedTime=50
)

# Crear una entrada de log
log_entry = default_logger(
    level="INFO",
    schemaVersion="1.0.0",
    logType="TRANSACTION",
    sourceIP="10.1.130.25",
    status="SUCCESS",
    message="Obtener info del cliente",
    logOrigin="INTERNAL",
    timestamp=datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f")[:-3],
    tracingId="48ad2b64a76dc6ab66da565b6298e0e6fad5b7796a8a35aa6b",
    hostname="server-1",
    eventType="TRANSACTION_PAYMENT_PROCESSING_FAILED",
    application=app_info,
    measurement=measure,
    destinationIP="10.10.129.200",
    additionalInfo={"clientID": 123}
)

# Obtener el logger y registrar la entrada de log
logger = logger_singleton().get_logger()
logger.info(log_entry.json())

Interceptor

from fastapi import FastAPI
from pvmlib import intercept_middleware, application

app = FastAPI()

app_info = application(
    name="bs-customer",
    version="1.3.7",
    env="PROD",
    kind="rest-service"
)

auth_service_url = "https://auth-service-url.com"

app.add_middleware(intercept_middleware, app_info=app_info, auth_service_url=auth_service_url)

RestClient

from pvmlib import call_service_network

base_url = "https://api.example.com"
client = call_service_network(base_url)

# Realizar una solicitud GET
response = client.get("/endpoint", params={"key": "value"}, headers={"Authorization": "Bearer token"})
print(response)

# Realizar una solicitud POST
response = client.post("/endpoint", json={"key": "value"}, headers={"Authorization": "Bearer token"})
print(response)

Manejo de Excepciones

from pvmlib import response_exception

try:
    # Código que puede lanzar una excepción
    raise response_exception(
        error_code="CUSTOM_ERROR",
        message="Ocurrió un error personalizado",
        http_status_code=400,
        headers={"X-Custom-Header": "value"}
    )
except response_exception as e:
    print(e.to_dict())

Respuesta Exitosa

from pvmlib import response_ok

response = response_ok(
    status_code=200,
    message="Operación exitosa",
    transaction_id="12345",
    time_elapsed=100,
    data={"key": "value"}
)

print(response.to_dict())

Contribución

Si deseas contribuir a este proyecto, por favor abre un issue o envía un pull request en el repositorio de GitHub.

Licencia

Este proyecto está licenciado bajo los términos de la licencia MIT.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

pvmlib-1.4.2-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file pvmlib-1.4.2-py3-none-any.whl.

File metadata

  • Download URL: pvmlib-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for pvmlib-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 17c16f63e145ebf7795729146e2a4d1d860a7523a4e3f519b9a0ff6147f0a89d
MD5 1b7bf8d05e96a0bcfb23f66f69b5ab25
BLAKE2b-256 74a4b92fa811765a7f4d6022d2e960ed833d578cc67d1cc7118bdf4404271110

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