windmill-sdk 1.0.0

Libreria Python asincrona per interagire con PocketBase e SDC, pensata per Windmill

windmill-sdk

Libreria Python asincrona per interagire con sistemi PocketBase e SDC, pensata per l'uso all'interno di Windmill.

✨ Funzionalità

• Recupero asincrono dei tenant da PocketBase (filtrabile)
• Interrogazione dei servizi e utenti da API SDC con autenticazione automatica
• Compatibilità futura con Directus tramite interfaccia unificata
• Supporto alla validazione con Pydantic
• Invio opzionale di notifiche su Slack in caso di errore

📦 Installazione

pip install windmill-sdk
# oppure
poetry add windmill-sdk

⚙️ Requisiti

• Python 3.10+
• httpx, pydantic, pytest, respx, pytest-asyncio

🚀 Esempio d’uso

import asyncio
from windmill_sdk.clients.pocketbase import PocketBaseClient
from windmill_sdk.clients.sdc import SDCClient

async def main():
    pb = PocketBaseClient("https://pb.example.com", "admin", "password")
    await pb.authenticate()
    tenants = await pb.list_tenants(filters={"identifier": "oc-pnrr-1"})
    await pb.close()

    for tenant in tenants:
        sdc = SDCClient(str(tenant.production_url), "sdc_user", "sdc_pass")
        services = await sdc.list_services()
        await sdc.close()
        for service in services:
            print(service.name)

asyncio.run(main())

✅ Test

pytest

📁 Struttura del progetto

windmill_sdk/
├── clients/
│   ├── pocketbase.py
│   ├── sdc.py
│   ├── directus.py
│   └── base_client.py
├── models.py
├── notifiers/
│   └── slack.py

🧪 Esecuzione dei test

Per eseguire la suite di test e controllare che tutto funzioni correttamente:

pytest

Assicurati di avere le dipendenze installate:

pip install -r requirements-dev.txt

✅ Verifica della copertura

Per eseguire i test e generare un report di copertura del codice:

pytest --cov=windmill_sdk --cov-report=term-missing

Questo comando:

• Esegue tutti i test
• Mostra a terminale le righe di codice non coperte
• Usa il modulo windmill_sdk come riferimento per il calcolo della copertura

Puoi anche generare un report HTML navigabile:

pytest --cov=windmill_sdk --cov-report=html

Il report sarà disponibile nella cartella htmlcov/index.html.