Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve validation of metadata documents #29

Open
davemfish opened this issue Jul 26, 2024 · 0 comments
Open

Improve validation of metadata documents #29

davemfish opened this issue Jul 26, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@davemfish
Copy link
Collaborator

Since our metadata documents are designed with the idea that people will edit them directly in text editors, we'll need to do more to validate these documents, so that they can be read by geometamaker or other systems.

Pydantic could be useful to do type-checking for all the dataclasses, since their attributes are already defined with types hints.

User Stories:

  1. I edited a metadata document in my text editor. I want to be sure it is valid before archiving it along with the dataset.

This user may not be a Python user, so perhaps a CLI for validation is warranted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant