Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Support multiple versions of target dandischema

Abierto
#1,571 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
cli

Línea de trabajo

Empieza revisando cómo dandi-cli y dandi-archive reutilizan actualmente la biblioteca Python dandischema y, después, lee la migración propuesta a LinkML y los modelos exportados en schema/releases. Antes de la implementación, aclara el diseño de selección de versiones, las reglas de compatibilidad y el tratamiento de las interfaces Pydantic existentes; se considera terminado cuando dandi-cli pueda manipular y validar metadatos conforme a la versión compatible del esquema solicitada por el servidor.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
29
Forks
37
Merge medio
1 d 10 h
PR fusionados (30 d)
17

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de dandi/dandi-cli

Todos los issues de dandi/dandi-cli

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.