-
Notifications
You must be signed in to change notification settings - Fork 0
Pubblicare Toolkit v1.0 come runtime tecnico dei repo dataset DataCivicLab #1
Copy link
Copy link
Closed
Copy link
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Contesto
Il toolkit è stato progressivamente rafforzato e rifocalizzato come runtime tecnico dei repo dataset DataCivicLab.
Nel modello organizzativo aggiornato:
.githubospita policy condivise, community health, onboarding GitHub e template issue/PRdataciviclabè l’hub pubblico, umano e minimale dell’ecosistematoolkitè il runtime tecnico e la fonte della documentazione tecnica di config/path/outputproject-templateè il template operativo da cui nascono i repo dataset- i repo dataset sono i progetti concreti
Questa issue serve a tracciare la pubblicazione del toolkit come componente stabile v1.
Ambito della v1
Il workflow canonico è ora esplicitamente centrato su:
toolkit run all --config dataset.ymltoolkit validate all --config dataset.ymltoolkit status --dataset <dataset> --year <year> --latest --config dataset.ymltoolkit inspect paths --config dataset.yml --year <year> --json
Questo è il contratto che i repo dataset e i notebook locali sono chiamati a usare.
Cosa è già pronto
Contratto runtime
- i path relativi in
dataset.ymlsono risolti rispetto alla directory che contienedataset.yml, non rispetto alcwd - questo comportamento è coperto nei principali flussi CLI
- output e run record sono stabili e leggibili dai notebook
Config e governance
- config tipizzato con strict mode
- schema config documentato
- compatibilità legacy mantenuta, ma non più promossa nel percorso base
Ergonomia runtime
- aggiunto
inspect paths --jsonper notebook e repo dataset resume,profile raw,run raw|clean|martrestano disponibili come tooling avanzatogen-sqlresta come helper di bootstrap congelato
Documentazione
README.mdrifocalizzato sul workflow canonicodocs/advanced-workflows.mddocs/feature-stability.mddocs/notebook-contract.md
CI / qualità
- CI matrix Ubuntu/Windows, Python 3.10/3.11
- coverage in CI
- smoke install/CLI
- build +
twine check
Obiettivo
Pubblicare toolkit v1 come motore tecnico stabile dei repo dataset nell’ecosistema DataCivicLab.
Criteri di accettazione
- la repo si presenta chiaramente come runtime tecnico, non come hub organizzativo
- il workflow canonico è documentato ed è coerente
- i contratti di path/config/output sono stabili e testati
- i repo dataset possono usare
inspect paths --jsonsenza ricostruire i path a mano - le feature avanzate restano supportate ma non sono più presentate come percorso base
- la repo è pronta per essere collegata dal
project-templatee dall’hub pubblico dell’organizzazione
Follow-up opzionali
- rafforzare i riferimenti dal
project-templateai docs del toolkit - continuare a ridurre la superficie pubblica non essenziale nel README
- valutare deprecazioni future solo dopo evidenza d’uso reale
Note
Questa issue riguarda la pubblicazione del toolkit come componente tecnico stabile dell’ecosistema.
Non riguarda:
- governance generale dell’organizzazione
- policy condivise GitHub
- logica dataset-specifica
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Type
Projects
Status
Completato