BlueBrain / BlueBrain/nexus-python-sdk

Take decision on whether / how the nexus-python-sdk checks Nexus API specific constraints

Abierto
#50 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
6
Forks
10
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

This is feedback provided after a first usage of the nexus-python-sdk and its documentation to perform basic operations in a Nexus V1 deployment.

Regarding propagating specifics from the Nexus API, the following questions were noted:

* Should constraints given by the Nexus API be checked / explicitely stated in the nexus-python-sdk, e.g. should the parameter `org_label` in `nexussdk.organizations.create` be checked to not contain upper case letters or spaces?
* Should terms like `vocab` and `base` be further described in the docstrings of the nexus-python-sdk?

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza revisando el punto de entrada nexussdk.organizations.create y los docstrings de nexus-python-sdk; después, compara las preguntas con las restricciones de la Nexus V1 API. Se considera completado cuando el proyecto haya registrado una decisión sobre si validar o documentar las restricciones de org_label y sobre si definir vocab y base.

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

Evaluación

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.