Skip to content

Registry/Catalog of Community Data Packages #52

Closed

Description

@rufuspollock

We want to allow people to register the data packages they've created in a "community" catalog portion of the site.

Url structure like: /community/{username}/{dp-name}

Options for Implementatoin

Github proxy option (see below)

_Note this option is what is currently (partially) implemented (see comments below for more info)_

  • data package at github.com/{username}/{repo} shows up at data.okfn.org/community/{username}/{repo}
  • data.okfn.org/community has some info! (no longer relevant as moved to /data)
  • data.okfn.org/community/{username} gives a nice listing now Nice Owner/User page in data section #111

Full option

  • login approach decided (github/twitter/...)
  • where do we store info (s3, db, ...)?
  • What do you register (path do a datapackage.json ...)

Other related things

Creation of data packages (for you)

For example:

  • Provide a link to a published gdoc page and a data package is created for you (where is it stored? github, s3, database?) and webpage is created

Activity

  1. rufuspollock commented on Jul 28, 2013

    @rufuspollock
    ContributorAuthor

    Thought: why not just run off github directly at present i.e. just search a given users repos for one's with a datapackage.json in the root?

    Idea: you have github.com/xyz/my-data-package => data.okfn.org/??/xyz/my-data-package (re ?? see below)

    No need to register anything, no need to do anything!

    • (+) extremely simple to implement. stuff works immediately without any extra steps (and works for me!)
    • (-) no way to register data packages not in github (note you don't have to have data in github just the datapackage.json)
    • (-) no explicit publish step (even half-finished stuff shows up)

    Aside: what about gist support?

    Url structure (separate)

    • /{username}/{dp-name}
      • (+) simple, mimics other systems
      • (-) possible clash with other urls
      • (-) not clear that /data/ is privileged in some way
    • /community/{username}/...
    • /hub/{username}/...

    hub is shorter but less clear than community. simplest is first option. I think value of privileging data is sufficient atm.

  2. added a commit that references this issue on Jul 28, 2013
  3. rufuspollock commented on Aug 2, 2013

    @rufuspollock
    ContributorAuthor
  4. d2m commented on Aug 2, 2013

    @d2m

    @rgrp very cool indeed!

    anyway, something is wrong. looking at http://data.okfn.org/community/rgrp/wheat-us

    i see right hand a link "Home page:" github.com/datasets/wheat-us
    which is clearly wrong

    the link under the button "Data Package Info" points to
    http://data.okfn.org/community/rgrp/wheat-us/datapackage.json

    which reports
    "Cannot GET /community/rgrp/wheat-us/datapackage.json"

    hth, michael

  5. rufuspollock commented on Aug 2, 2013

    @rufuspollock
    ContributorAuthor

    @d2m thanks for the quick spots - these are known bugs and they are getting fixed :-)

  6. added 2 commits that reference this issue on Aug 3, 2013
  7. rufuspollock commented on Aug 9, 2013

    @rufuspollock
    ContributorAuthor

    @d2m both the issues you mention should now be fixed!

  8. rufuspollock commented on Aug 20, 2013

    @rufuspollock
    ContributorAuthor

    I think it is becoming clear we also need to allow creation / registration of data packages cf #66. Thoughts:

    • Create: e.g. I have a gdocs spreadsheet and want to register it => need to create datapackage.json and store it somewhere
      • Suggest: we login via github and push this to e.g. a gist or a repo (need to decide)
    • Register: have a data package not on github

    Still not clear how this fits in the namespace we have if using github proxy through. Perhaps we need to move from that and store stuff somewhere ourselves (e.g. s3 flat file would be possible)

  9. rufuspollock commented on Sep 7, 2013

    @rufuspollock
    ContributorAuthor

    Bump to top priority.

  10. rufuspollock commented on Oct 5, 2013

    @rufuspollock
    ContributorAuthor

    @davidmiller + @rossjones @psychemedia interested in your thoughts here. Various options as I see it atm:

    • should i run this direct off your existing github repos / gists
    • people log in and explicitly create new "entries" in the registry (note 2 cases: a) already have a datapackage and just want to link it b) have data and want datapackage stuff created for me)
      • these get stored in repos or gists - perhaps with a master repo listing all the relevant repos (does not have to get github - we could store to s3, our own db etc but prefer something people can edit from outside ...)

    User story:

    • I have a google spreadsheet I want to publish as a proper data file as quickly and easily as i can so that a) I can add info like license b) others can find it c) I have somewhere nice to point people to
      • We'll give them data.okfn.org/{their-username}/{their-chosen-data-package-name}
    • I have an existing datapackage i want to register so that others can find it and use it
  11. rufuspollock commented on Oct 24, 2013

    @rufuspollock
    ContributorAuthor

    @mihi-tr I'd be interested in your thoughts here. What workflow would you like?

  12. mihi-tr commented on Oct 27, 2013

    @mihi-tr

    I do like the github route. One problem: the datasets will be indexed on demand only. (as I understand it). There is no clear route to get a new dataset published there. (e.g. a full list of community built data packages).

    One way to do this could be to cache datasets that are requested and show them as a list of datasets. (what happens if the datasets 404?)

    What speaks against going down the Github route: You'd need a github repo for everything - no possibility to publish datasets easily otherwise...

  13. rufuspollock commented on Oct 27, 2013

    @rufuspollock
    ContributorAuthor

    @mihi-tr you've highlighted the 2 major issues:

    • No way to easily create listing for a given user (it could be created on demand but we'd need be careful about github api limits)
      • Also no way to create a list of users (though we could piggyback on github search api - though don't know any way to search for all repos which contain a file with a given name ... - viz datapackage.json)
    • No way to publish except into github

    Neither of these seem show-stoppers and seem a reasonable way to go ...

  14. mihi-tr commented on Oct 28, 2013

    @mihi-tr

    @rgrp One thing I'd love to see in the future is data portals (CKAN) and other sources publish data packages - if we limit ourselves to github we'll include those to be included in a general catalog. But maybe I'm wrong there and this is not the aim for the community repo.

  15. pietercolpaert commented on Oct 28, 2013

    @pietercolpaert

    ODI is also doing a lot of work in this direction. Does this sync with theirs? /cc @Floppy

  16. Floppy commented on Nov 4, 2013

    @Floppy

    We're doing some stuff, but not in the specific area. Whatever we do next though, we'll be sure to look at what's already out there. Regarding the listing creation thing, a lot of source code ecosystem apps will add a listing for some code when the github repo is entered by the user, so it's a sort of on-demand thing normally.

  17. rufuspollock commented on Nov 5, 2013

    @rufuspollock
    ContributorAuthor

    @Floppy would you consider contributing here - contributions would be welcome :-) !

  18. Floppy commented on Nov 5, 2013

    @Floppy

    If I get the opportunity, I certainly will :)

  19. added 5 commits that reference this issue on May 18, 2014
  20. rufuspollock commented on Jun 7, 2014

    @rufuspollock
    ContributorAuthor

    Only remaining thing now is to have /data/{username} work sensibly.

  21. rufuspollock commented on Jun 7, 2014

    @rufuspollock
    ContributorAuthor

    FIXED. I'm closing as fixed. the User page is rudimentary and proper one is now #111

  22. moved this to Done in Open Knowledgeon Dec 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions