goodtables.io icon indicating copy to clipboard operation
goodtables.io copied to clipboard

Badges for each data package in a GitHub repository

Open Stephen-Gates opened this issue 7 years ago • 3 comments

I'm making a repository containing many data packages in separate directories. I would like to validate each package individually and award badges to each data package and show it in the data package README.md.

When I add the repo to goodtables.io, it correctly detects that there are two data packages but only awards one badge: goodtables.io

Is there a way to have one repo, many data packages, each with there own badge?

It would be really helpful for the reboot of https://github.com/frictionlessdata/example-data-packages

Stephen-Gates avatar Jan 16 '18 02:01 Stephen-Gates

That's an interesting suggestion. Maybe we could allow something like badge.svg?path=my_data/datapackage.json to get a badge specific to some file.

It should be relatively simple for individual files, but I'm not sure how complicated it would be for datapackages, what UI changes it would require, and how useful it is for our users in general. Do you know of anyone publishing multiple datasets in a single repository, apart from these sample datapackage sets?

vitorbaptista avatar Feb 22 '18 18:02 vitorbaptista

Many of these repositories have multiple datasets - I haven't looked at them all https://discuss.okfn.org/t/anyone-have-links-to-data-in-github-repositories/6369

Stephen-Gates avatar Feb 22 '18 20:02 Stephen-Gates

For each of the files defined in goodtables.yml create a badge referenced by url, e.g.

  • Source: GitHub
  • User: frictionlessdata
  • Repo: example-data-packages
  • Data: stored in my_data/mydata.csv

Get badge from: https://goodtables.io/badge/github/frictionlessdata/example-data-packages/badge.svg?path=my_data/mydata.csv

For each of the datapackages defined in goodtables.yml create a badge. Using same repo as above,

  • Data Package: stored in my_packaged_data/datapackage.json

Get badge from: https://goodtables.io/badge/github/frictionlessdata/example-data-packages/badge.svg?path=my_packaged_data/datapackage.json

User Interface change would be providing a link to a badge per file or datapackage instead of at the end of the job results

goodtables source: https://goodtables.io/github/Stephen-Gates/service-locations/jobs/60

Stephen-Gates avatar Feb 23 '18 00:02 Stephen-Gates