Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Support multiple versions of target dandischema

Aperta
  • Qualcosa non va?
#1,571 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
cli

Direzione di ricerca

Inizia esaminando come dandi-cli e dandi-archive riutilizzano attualmente la libreria Python dandischema, quindi leggi la migrazione LinkML proposta e i modelli esportati in schema/releases. Prima dell'implementazione, chiarisci il design della selezione della versione, le regole di compatibilità e la gestione delle interfacce Pydantic esistenti; il lavoro è completo quando dandi-cli può manipolare e convalidare i metadati rispetto alla versione compatibile dello schema richiesta dal server.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

schema vendoring

Inspired by

by @kabilar , and ongoing work on "vendorization" of DANDI archive codebase to support multiple instances of DANDI.

ATM both dandi-cli and dandi-archive re-use dandischema Python library for manipulating and validating metadata records. As a result, any upgrade of dandischema in server requires upgrade of dandischema in dandi-cli installation which also might require upgrade of dandi-cli itself.

With multiple archive instances in play (already DANDI and LINC and EMBER is coming), synchronizing all of them to align with most recent dandischema would be getting close to infeasible. So I think we should distill a solution which would allow dandi-cli to manipulate different/needed versions of dandischema.

Possible roadmap to achieve that

  • migrate pydantic model to linkml (effort ongoing by @candleindark ) + potentially additional "instance specific" restrictions (TODO: link issues in dandi-schema)
  • export linkml models into https://github.com/dandi/schema/tree/master/releases
  • define dandischema_schema_version -- as long as it is "compatible" in terms of its formulation with dandi-cli. In a similar situation in BIDS we have BIDS_VERSION and its SCHEMA_VERSION, see https://github.com/bids-standard/bids-specification/tree/master/src/schema#version-of-the-schema
  • in dandi-cli implement loading of models from linkml models for the version desired by the server:
    • as long as that linkml model is described in compatible version of schema (based on minimal dandischema_schema_version supported by dandi-cli) , we should be good
    • potentially extend the model with instance specific models where needed for validation (most likely the base model would be sufficient to describe)
    • not yet sure what we should do for currently used pydantic models in Python interfaces, might need to populate classes for different versions. So issue similarish to what we discussed with @rly and other nwb developers about nwb versions.

Also attn @jwodder @satra @bendichter @dandi/dandiarchive to potentially also think about enhancement to above plan or just to suggest alternative approaches.

Lingua principale
Python
Stelle
29
Fork
37
Merge medio
1g 5h
PR unite (30g)
20

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di dandi/dandi-cli

Tutte le issue di dandi/dandi-cli

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.