search

ImperialCollegeLondon / pycsvy

Python reader/writer for CSV files with YAML header information
BSD 3-Clause "New" or "Revised" License
6 stars 7 forks source link

Implement the Tabular Schema to declare tabular data #3

Open dalonsoa opened 2 years ago

dalonsoa commented 2 years ago

Problem

Complementary to the CSV Dialect, this schema provides information about the contents of the columns in a standardised way, from column names to description of the content, its units or the type of the data, among many others. It will help to understand what the data in each column represent.

What is needed

Capture the Table Schema in a pydantic class, so it can be used where needed. Probably, it will be necessary at least 2 objects, one for the individual field descriptors and another one for the list of field descriptors and the other optional fields.

Using the schema in the load/save workflow is a separate issue.

alexdewar commented 2 years ago

Hacktoberfest task, maybe?

dalonsoa commented 3 days ago

I've updated the issue to use pydantic, which is much more usable and modern.