Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update licences #57

Merged
merged 23 commits into from
Nov 5, 2017
Merged

Update licences #57

merged 23 commits into from
Nov 5, 2017

Conversation

Stephen-Gates
Copy link
Contributor

@Stephen-Gates Stephen-Gates commented Jul 18, 2017

Started work on updating licenses.csv.

Added Community files

  • feedback welcome on code of conduct, contributing and issue template
  • hopefully this is generic enough to use in other repos.

Separated out (unmaintained) Changelog from Readme

  • suggest making a release of changes since 0.7
  • do you want to keep a changelog? If so is this updated with PR or afterwards?

Other questions:

Change README to link to CHANGELOG
Making releases seemed to be an inconsisent practice
Add Code of coduct, Contributing, Issue Template
Update wording on Change log
@@ -0,0 +1,69 @@
# Contributing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Purely personal opinion: I'm not a big fan of using .github directory for files that aren't GitHub-specific. In this PR, CONTRIBUTING.md and CODE_OF_CONDUCT.md aren't, while ISSUE_TEMPLATE.md is. Put another way, the the first two should be read by someone just browsing, while the last is of no use unless one is filing an issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The files can go in .github according to GitHub but elsewhere they recommend otherwise. Happy to move.

@mlinksva
Copy link
Contributor

will source new licences from https://github.com/okfn/opendefinition/tree/gh-pages/licenses
not sure if that source has values for all columns in csv
does scrape.py do this?

Entirely possible that opendefinition.org/licenses/ has changed so that scrape.py won't work.

FWIW the approach I was going to take, or investigate whether it'd work, would be to make a Jekyll collection of licenses on opendefinition.org so that it would be machine-readable at the source. See https://github.com/github/choosealicense.com/tree/gh-pages/_licenses for an example of that concept, even with licenses as the topic. 😄

@Stephen-Gates
Copy link
Contributor Author

As discussed I can do some basic things (like fix a CSV) but not code (unless we're talking COBOL and Mainframes 25 years ago). So if the scraper is broken, I'm eyeballing the changes so I'll close this PR.

I was trying to progress this to support another project so it could draw from a list of authoritative open licences to make Frictionless Data using Data Packages that require an open licence according to the specification.

If this list of open licences is not going to be maintained, then I'll create a (smaller) drop down list in my App of "preferred" open licences. I'll avoid external dependencies that way.

@rufuspollock
Copy link
Member

@Stephen-Gates i don't think we need to scrape in the first instance - we can just maintain the CSV list here. (Even if there is some duplication with the opendefinition list atm - ultimately we obviously want one place that is authoritative).

@mlinksva amazing work on the opendefinition licenses directory.

Summary: I think we want this repo (for now) as a simple data package that people can reuse in other projects. That means it wants to be lightweight, submodulable and standalone ...

This explains why we wouldn't want to use opendefinition as it has a bunch of other stuff in it.

Does that clarify things?

@Stephen-Gates we therefore do want to to maintain this repo - but it shouldn't need (much) automation and we don't need to scrape - we can just update the licenses.csv.

@Stephen-Gates
Copy link
Contributor Author

Stephen-Gates commented Jul 19, 2017

@rufuspollock sure. The scripts categorised the licences into groups. The OD web site shows other groups. Do you want columns for that?

@rufuspollock
Copy link
Member

I'd start with what we have here for now and think about the main od website differences later once this first piece of work is done.

@Stephen-Gates Stephen-Gates reopened this Oct 24, 2017
@Stephen-Gates
Copy link
Contributor Author

restarting work on this

@Stephen-Gates Stephen-Gates changed the title WIP - Update licences Update licences Oct 24, 2017
@Stephen-Gates
Copy link
Contributor Author

Stephen-Gates commented Oct 24, 2017

@mlinksva @rufuspollock this is ready for review.

Very tempted to delete the family column in licenses.csv - thoughts?

Edit: forgot we chatted about that in #54

@mlinksva
Copy link
Contributor

Looks like an improvement overall.

@Stephen-Gates
Copy link
Contributor Author

Is the CSV the master and the JSON generated? I assume deploy.py is run after PR accepted and not as part of PR?

@mlinksva
Copy link
Contributor

Just skimming deploy.py, CSV is unused. The script generates jsonp. Probably worth running and adding a commit to this with any updates generated.

@Stephen-Gates
Copy link
Contributor Author

Another suggested change, can OGL-UK-2.0 be marked as superseded by OGL-UK-3.0?

@mlinksva
Copy link
Contributor

I guess it can be marked as superseded, as is OGL-UK-1.0. There's no mechanism to denote by what, is there?

@Stephen-Gates
Copy link
Contributor Author

Not that I'm aware of for OGL-UK-2.0, being superseded by OGL-UK-3.0 is obvious.
It is less clear that GeoGratis was superseded by OGL-Canada-2.0.

Perhaps a bit of a re-think is needed as there is some good information captured by http://opendefinition.org/licenses/ and http://opendefinition.org/licenses/nonconformant/ that isn't captured in the csv or json. E.g.

  • why the licence doesn't conform
  • the licence was discontinued
  • level of use
  • superseded by
  • (in)compatibility with other licences

goodtables.io validation should fail
@Stephen-Gates
Copy link
Contributor Author

@mlinksva reverted to WIP.

By adding status of "superseded" to OGL-UK-2.0, I should have got an error in GoodTables.io due to the enum constraint.

"superseded" is in the csv for two entries, one on purpose, one by mistake.

This lead me to what is the correct spelling of "superceded" <- GitHub's autocorrect is telling me, "not this".

Are you happy to leave is as "superceded"?

I'll explore the GoodTables.io issue and then correct the schema/data

@mlinksva
Copy link
Contributor

Makes sense to use the more common spelling, unless something that we can't change is depending on supercede.

@Stephen-Gates
Copy link
Contributor Author

still one error - should fail in goodtables
@Stephen-Gates
Copy link
Contributor Author

Can I suggest that an owner of this repo set up an account in GoodTables.io to check licenses.csv against the datapackage.json and place a badge in the readme.

goodtables.io

That would resolve #58, progress #45 and complement this PR

@Stephen-Gates
Copy link
Contributor Author

After reading Leigh Dodds post, The state of open licensing, 2017 edition I wonder if the following licences should be added to licenses.csv as not reviewed?

@mlinksva @rufuspollock

@Stephen-Gates
Copy link
Contributor Author

@roll has fixed the schema validation on GoodTables.io (see Job History).

This PR is now good to go unless you'd like the open licences mentioned above included.

I would still like Continuous Data Integration set up as suggested.

@rufuspollock
Copy link
Member

After reading Leigh Dodds post, The state of open licensing, 2017 edition I wonder if the following licences should be added to licenses.csv as not reviewed?

Yes, but that is a separate PR / issue so let's do it after this gets merged.

@rufuspollock
Copy link
Member

rufuspollock commented Nov 5, 2017

@mlinksva is this good to go in your opininon? If so let's get it merged 👍 😄

And huge well done and thanks to @Stephen-Gates for his awesome contribution here. 💯 🥇

@mlinksva mlinksva merged commit 6008d0c into okfn:master Nov 5, 2017
@Stephen-Gates Stephen-Gates deleted the update-licences branch November 5, 2017 20:15
@rufuspollock
Copy link
Member

@mlinksva 👍 👏

@Stephen-Gates 👏 👏 🥇 💯 🎱

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants