search

niveditc / open-referral-validation

Validation tool for OpenReferral
http://niveditc.github.io/open-referral-validation/
3 stars 0 forks source link

Updating validation tool to match v1.0 of the spec #2

Open niveditc opened 9 years ago

niveditc commented 9 years ago

The current tool is based on the version of the specification from May 2014 and the specification has been significantly updated since then.

The spec for v0.9 is here and v1.0 will be ready soon. The tool should be updated to match v1.0.

pmackay commented 9 years ago

Hi @niveditc I'd like to help with this but really dont have time currently. May I suggest it might be worth considering an alternate approach to building a validation tool however? The https://github.com/codeforamerica/OpenReferral/blob/master/datapackage.json file defines a machine format for defining the format of the CSV files. Ideally a validation tool would be based on using this file to parse OR data packages. Tools like https://github.com/theodi/csvlint.rb are designed to help with this.

cc @greggish

greggish commented 9 years ago

Personally can't be helpful here but let me know if i should track down others for advice...

I'm looking forward to get this moving, @niveditc !

niveditc commented 9 years ago

Hi @pmackay! Glad to hear that you'd like to help with this, and I'm looking forward to working with you whenever you can spare the time :) I agree that you're correct about using the datapackage.json file to parse the CSV files. I'm not too comfortable with Ruby (never used it before) so I might not be able to use that particular tool – however I will hunt for something similar for JavaScript, or might end up writing something myself. Let me know your thoughts!

@greggish, I'm really excited to get working on this as well. Do let us know when v1.0 is ready!

niveditc commented 9 years ago

v1.0 is out, so work on this can begin soon – https://github.com/codeforamerica/OpenReferral/blob/master/Human%20Services%20Data%20Specification%20%20v1.0.md

greggish commented 9 years ago

Hey @niveditc would love to check in on this, we've got @haileypate doing some work on the spec, and y'all may have valuable insight for each other.

niveditc commented 9 years ago

@greggish – I've been a little tied up with work lately, but I'm hoping to get started on this soon, hopefully by the end of this week.

haileypate commented 9 years ago

Hi Nivedita!

This tool is so great! I love the simplicity and the way you present the feedback. Would love to talk with you more on this if you have time. I'll be around this Friday if you wanna ping me.

One small idea -- how about adding the applicable spec version number to the app's landing page? Just in case someone misses the Github notes =)

Great job. This tool will help a lot of folks!

cc @greggish

PS I do agree with @pmackay above... Open Referral will need a validator to handle package-level input. However, my gut tells me a lot of potential OR users are going to avoid JSON and the whole package thing. I suspect one of the first popular HSDS hacks we'll see is people ignoring the package stuff and just sharing whatever CSV files suit their fancy. Especially Excel-based people in small orgs. @niveditc, I see your tool offering great help to that type of user. And likely others. Cheers =)

niveditc commented 9 years ago

@haileypate, I'm definitely up for discussing this, and I'm free to talk almost all day Friday.

Adding the version number is a great idea! This tool was made for the spec as of May 2014. @greggish, am I correct in calling this v0.1? I looked through the commit log and it looks like v0.2 was being developed in September 2014.

Hailey, it's great to know that users are likely to use this tool to validate individual CSV files in addition to the entire package-based model. Maybe something to look at is a way to support both of those approaches in the tool.

greggish commented 9 years ago

I think that is correct - v0.1 Looking forward to v1.0! Do you feel like you have what you need?

@niveditc if you can, please do join us during this week's Assembly to talk about this: https://plus.google.com/events/cdum8pu45mkappe1gfl834c1eb8

niveditc commented 9 years ago

Have been working on updating the validation tool to v1.0 and this should be ready soon! The current version live at http://niveditc.github.io/open-referral-validation/. At the moment, as per Hailey's suggestion, I'm having this check individual CSV files rather than the whole package. We can add in another mode to verify an entire package once this part is ready.

@greggish @spara @haileypate — could you point me to some CSV files that satisfy v1.0 of the spec so I can test the tool?

haileypate commented 9 years ago

eep, I haven't been monitoring my github inbox! many apologies! I do not know of any CSV files that satisfy V1.0 at this time. It would be great if we could find some real world resources to use them with though.