Implement package/resource/schema.to_markdown
See original GitHub issueOverview
https://framework.frictionlessdata.io/docs/guides/describing-data
In Frictionless Framework a user can instantiate a Schema, Resource, and Package objects. All of them are Metadata objects which is a Python dictionary with some additional functionality.
For example, all these classes have metadata.to_yaml
that converts the metadata that a package/resource/schema has to a YAML string or file.
Users are interested in having package/resource/schema.to_markdown
function that will convert metadata to a MD string or file. It might be useful for composing readmes on github etc. See https://github.com/frictionlessdata/project/discussions/665
Plan
- Review an existing external lib for reference (not sure we can re-use this code)
- Decide on the way of composing markdown text: using some markdown composer, Jinja template or native Python strings (the latter might be messy) ping @roll to sync
- Decide on what should be a Markdown output. For example, this one for a Table Schema - https://github.com/geoffreyaldebert/table-schema-to-markdown/blob/master/tests/files/expected_repertoire.md. And this one - https://datahub.io/core/co2-ppm - is a package presentation (of course we can’t have interactive parts) ping @roll to sync
- Prototype all the functions
- Implement all the functions adding docstrings
- Write functional tests
Issue Analytics
- State:
- Created 2 years ago
- Reactions:6
- Comments:15 (8 by maintainers)
Top Results From Across the Web
Implement package/resource/schema.to_markdown · Issue #837
In Frictionless Framework a user can instantiate a Schema, Resource, and Package objects. All of them are Metadata objects which is a Python ......
Read more >json-schema-to-markdown - npm package - Snyk
This module turns a JSON Schema into a human-readable markdown file. This module does not implement anywhere near the full RFC specs. If...
Read more >nuspec File Reference for NuGet - Microsoft Learn
The .nuspec file contains package metadata used when building a package and to provide information to package consumers.
Read more >json-schema-docs - Go Packages
A simple JSON Schema to Markdown generator. This generator doesn't attempt to support the full JSON Schema specification. Instead, it's designed ...
Read more >Contribution Points | Visual Studio Code Extension API
You can use any of the validation JSON Schema properties to describe other constraints ... in the package.json to your custom editor implementation...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Thanks for the suggestion – I’ve added a feature request for it
And of course, thanks to @ezwelty 👍