Skip to main content

eco-back

Librería Python para backend con soporte para PostgreSQL/PostGIS, clientes API, manejo de excepciones y logging

Características

  • Base de datos: Conexión y operaciones con PostgreSQL
  • PostGIS: Operaciones geoespaciales (puntos, polígonos, búsquedas por proximidad)
  • Cliente API: Cliente HTTP genérico y cliente específico UNP
  • Patrón Repository: Implementación de patrones de diseño para acceso a datos
  • Utils: Sistema de excepciones y logging para Django
  • Registro: Funciones de trazabilidad para Django REST Framework

Descripción

eco-back es una librería modular que facilita el desarrollo de aplicaciones backend, proporcionando abstracciones para bases de datos geoespaciales, consumo de APIs REST, manejo de excepciones y logging estructurado.

Instalación

Desde PyPI

pip install eco-back

Desde el código fuente

pip install -e .

Para desarrollo

pip install -e ".[dev]"

Uso

Cliente de Consecutivos (UNP)

from eco_back.api import Consecutivo

# Crear cliente
client = Consecutivo(base_url="https://api.unp.example.com")

# Obtener consecutivo
consecutivo = client.obtener(origen=1)
if consecutivo:
    print(f"Consecutivo: {consecutivo}")

client.close()

# Forma recomendada: usar context manager
with Consecutivo(base_url="https://api.unp.example.com") as client:
    consecutivo = client.obtener(origen=1)
    # Usar el consecutivo...

Cliente API Genérico

from eco_back.api import APIConfig, APIClient

config = APIConfig(
    base_url="https://api.example.com",
    timeout=30,
    headers={"Authorization": "Bearer token"}
)

with APIClient(config) as client:
    # GET request
    data = client.get("/endpoint")
    
    # POST request
    result = client.post("/endpoint", json={"key": "value"})

Conexión básica a PostgreSQL

from eco_back.database import DatabaseConfig, DatabaseConnection

config = DatabaseConfig(
    host="localhost",
    port=5432,
    database="mi_base_datos",
    user="usuario",
    password="password"
)

with DatabaseConnection(config) as db:
    resultados = db.execute_query("SELECT * FROM tabla")
    for row in resultados:
        print(row)

Uso de PostGIS

from eco_back.database import DatabaseConfig, DatabaseConnection, PostGISHelper

config = DatabaseConfig(
    host="localhost",
    port=5432,
    database="mi_db_geo",
    user="postgres",
    password="password"
)

with DatabaseConnection(config) as db:
    postgis = PostGISHelper(db)
    
    # Habilitar PostGIS
    postgis.enable_postgis()
    
    # Insertar un punto geográfico
    punto_id = postgis.insert_point(
        table_name="ubicaciones",
        lat=40.4168,
        lon=-3.7038,
        data={"nombre": "Madrid", "tipo": "ciudad"}
    )
    
    # Buscar puntos cercanos (5km)
    cercanos = postgis.find_within_distance(
        table_name="ubicaciones",
        lat=40.4168,
        lon=-3.7038,
        distance_meters=5000
    )

Desarrollo

Ejecutar tests

pytest

Formatear código

black src/ tests/

Linting

flake8 src/ tests/

Type checking

mypy src/

Manejo de excepciones y logging (Django)

from eco_back.utils import (
    ServiceValidationError,
    handle_service_validation_error,
    _log_warn
)
from rest_framework.decorators import api_view
from rest_framework.response import Response

@api_view(['GET'])
@handle_service_validation_error
def mi_vista(request, user_id):
    try:
        _log_warn(f"Buscando usuario {user_id}", level="info")
        
        usuario = Usuario.objects.get(id=user_id)
        return Response({"usuario": usuario.username})
        
    except Usuario.DoesNotExist:
        _log_warn(f"Usuario {user_id} no encontrado", level="warning")
        raise ServiceValidationError(
            "Usuario no encontrado",
            code=404,
            context={"user_id": user_id}
        )

Trazabilidad de registros (Django)

from eco_back.registro import TrazabilidadRegistroPermiso
from django.urls import path

urlpatterns = [
    path('api/trazabilidad/<int:registro_id>/', TrazabilidadRegistroPermiso),
]

Módulos disponibles

  • eco_back.database - Conexiones y operaciones con PostgreSQL/PostGIS
  • eco_back.api - Clientes HTTP y consumo de APIs
  • eco_back.documento - Manejo de documentos y anexos
  • eco_back.utils - Excepciones y logging para Django
  • eco_back.registro - Funciones de trazabilidad (Django REST Framework)

Para más información, consulta los README de cada módulo:

Licencia

MIT

Metadata

Release files for eco-back 0.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eco-back 0.2.5
File Size Uploaded Provenance Actions
eco_back-0.2.5.tar.gz 51.5 kB Without provenance Details for eco_back-0.2.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for eco-back 0.2.5
File Interpreter ABI Platform Actions
eco_back-0.2.5-py3-none-any.whl Python 3 none any Details for eco_back-0.2.5-py3-none-any.whl

Total release size: 103.2 kB

Release files / eco_back-0.2.5.tar.gz

Download URL eco_back-0.2.5.tar.gz
Size 51.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4e882fe73081f282f1e6d64b467e509ef75200d12692ff1ad3a45a7601527253
BLAKE2b-256 checksum
How to use checksums
e5155c2585ee3ad11470bb3c2d690c7815593078e708e68b0bd6e0b0796139e8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.9

Release files / eco_back-0.2.5-py3-none-any.whl

Download URL eco_back-0.2.5-py3-none-any.whl
Size 51.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
716c2a24047ddd34dd96870b1318f408d204569abca8967e5f92f310346c5b7f
BLAKE2b-256 checksum
How to use checksums
f68c920fd2694793fafcc0ac03f6e2ed54ae5827be5b756eb13fb8812fdc7e0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.9

Security for eco-back 0.2.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page