search

seedcase-project / seedcase-sprout

Upload your research data to formally structure it for better, more reliable, and easier research.
https://sprout.seedcase-project.org/
MIT License
0 stars 0 forks source link

docs: :building_construction: function diagram for `create_properties_template()` #600

Closed lwjohnst86 closed 2 weeks ago

lwjohnst86 commented 3 weeks ago

Description

These changes add the diagram for creating the properties template of the official Data Package Spec. I think it's possible to download the full spec from one URL. But maybe this will need two functions, one for the package and one for the resources. Thoughts? Alternatively, I could add a URL or options arg to select which spec to download, the package or the resource.

Reviewer Focus

This PR needs an in-depth review.

martonvago commented 2 weeks ago

If this function will be used to update a locally saved / cached sample datapackage.json file (as opposed to being run every time that file viewed, for example), then I also think that it works as a single function. Because it prepares a properties file that includes package and resource properties, so any view... function can expose the part of the object it needs (without redownloading anything). But yeah, I'm also not sure if I understand the context 100%.

lwjohnst86 commented 2 weeks ago

@martonvago related to the conversation during the meeting about frictionless and getting the official schema, I can't find any function within the package that does that: https://framework.frictionlessdata.io/docs/framework/actions.html

The closest seems to be the Package class: https://framework.frictionlessdata.io/docs/framework/package.html but even then, it doesn't look like it provides the full template, only that it takes a data file and makes a package from it. Which isn't exactly what we want.

martonvago commented 2 weeks ago

@martonvago related to the conversation during the meeting about frictionless and getting the official schema, I can't find any function within the package that does that: https://framework.frictionlessdata.io/docs/framework/actions.html

The closest seems to be the Package class: https://framework.frictionlessdata.io/docs/framework/package.html but even then, it doesn't look like it provides the full template, only that it takes a data file and makes a package from it. Which isn't exactly what we want.

Ah okay! Yeah, I was thinking of Package maybe being able to do it somehow, but then not really