MatterMiners/cobald

Add programmatic configuration schemas

Open

#84 opened on Feb 19, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Python (13 forks)auto 404
enhancementhelp wantedusability

Repository metrics

Stars
 (11 stars)
PR merge metrics
 (PR metrics pending)

Description

The configuration is currently treated as a blob of raw YAML/JSON equivalent data. This makes validation and error reporting difficult, as keys/values are checked on usage.

cobald should provide means to define expected schemas for configuration. This would allow to efficiently detect and report errors. Schemas would also allow to generated documentation; this is not required for the base functionality.
Schemas perhaps should (allow to) be automatically generated from the objects taking the configuration.

Related issues:

External packages:

  • The pydantic package for validating runtime types based on annotations.

Contributor guide

Research direction
Explore pydantic to define configuration schemas, integrate with existing YAML/JSON loading, and implement validation. Investigate auto generating schemas from runtime objects.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50