diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..414ac1a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,44 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). The [project releases](https://github.com/okfn/licenses/releases) will adhere to [semantic versioning](http://semver.org/spec/v2.0.0.html) + +This approach was adopted after release 0.7. + +To see what's planned, see our [milestones](https://github.com/okfn/licenses/milestones) or unreleased changes. + +[Unreleased]: https://github.com/okfn/licenses/compare/0.7...HEAD +## [Unreleased] + +[0.7]: https://github.com/okfn/licenses/compare/0.6.1...0.7 +## [0.7] - 2012-03-18 + +[0.6.1]: https://github.com/okfn/licenses/compare/0.6...0.6.1 +## [0.6.1] - 2011-02-23 +### Changed +- Minor tweak to CC BY-SA license name + +[0.6]: https://github.com/okfn/licenses/compare/0.5...0.6 +## [0.6] - 2011-02-11 +### Changed +- Heavy refactoring and simplification +- Improve and add documentation + +## 0.5 - 2010-05-12 +No GitHub compare between 0.4 and 0.5 available as 0.4 was not tagged as a release in GitHub. +### Added +- Addition of Licenses SoS v2.0 capabilities + +## 0.4 - 2010-03-08 +Release not implemented in GitHub. +### Added +- Addition of Licenses SoS v1.0 capabilities (Specification of Service) + +### Changed +- This module is redesigned to be a web service + +## 0.3 - 2010-03-06 and older +Release 0.3 not implemented in GitHub. + +### Added +- Module is designed to be imported to provide its list of licenses diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..81063f9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +## Code of Conduct + +We are a worldwide network of people passionate about openness, and we use advocacy, technology and training to unlock information so everyone can benefit from open knowledge. + +Read about [our vision and values](https://okfn.org/about/vision-and-values/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..19f653f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# Contributing + +Firstly, thanks for being here. All types of contributions are valued and gratefully received. Please consider how you may be able to contribute: + +- [financial support](#contribute-financial-support) +- [ideas and feature requests](#contribute-ideas-and-feature-requests) +- [issues or bug reports](#contribute-issues) +- [documentation](#contribute-documentation) +- [code](#contribute-code) + +## Contribute Financial Support + +We are grateful to all [our funders][funders]. Would you like to [make a donation][donate]? + +## Contribute Ideas and Feature Requests + +Your idea for a feature addition may already exist on our [issues] backlog. If you find it, join the conversation. + +If the gist of your idea isn't there: +- [add an issue][issues] +- to discuss your idea privately, [contact us][contact_us] + +## Contribute Issues + +If you encounter a problem, please [add an issue][issues]. Make sure it hasn't already be reported. + +In order for us to best respond to the issue, we need as much information about the issue as you can provide. Please provide: + +- as much detail as possible in the issue template. +- a descriptive name for your issue. + +We may add or change labels on your issue to help us manage the issue backlog. + +## Contribute Documentation + +Documentation helps people use and contribute to the work we do. You may like to: + +- improve the [Readme.md][readme] +- add or improve other documentation in this repository +- write a Guide, Blog post or even Tweet + +## Contribute Code +This work is open source, and we are grateful to all our [contributors]. By participating in this project, you agree to abide by our [Code of Conduct][code_of_conduct]. + +Before you start coding, please reach out to us to discuss how you can help. + +If this is your first time contributing code, you will need to [create a fork of this repository](https://help.github.com/articles/fork-a-repo/). + +Follow the [readme instructions][readme] to get your development environment running locally. + +Ensure that all automated tests pass before starting work on your contribution. + +### Code Review Process + +All contributions to the codebase will be reviewed. To increase your chances of your code being accepted please be aware of the following: + +- Write [well formed commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +- Write tests for all changes (additions or refactors of existing code). +- We may use GitHub integrations to check your contribution. +- Once your Pull Request (PR) is published and passes the above checks a repository administrator will review your contribution. Where appropriate, comments will be provided and amendments suggested before your PR is merged into Master. + + +[code_of_conduct]: CODE_OF_CONDUCT.md +[contact_us]: https://okfn.org/contact/ +[contributors]: https://github.com/okfn/licenses/graphs/contributors +[donate]: https://okfn.org/donate/ +[funders]: https://okfn.org/team/funders/ +[issues]: https://github.com/okfn/licenses/issues +[readme]: README.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..b505d4e --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,25 @@ +> Please provide a general summary of the issue in the Issue Title above +> fill out the headings below as applicable to the issue you are reporting, +> deleting as appropriate but offering us as much detail as you can to help us resolve the issue + +### Expected Behaviour +> What should happen? + +### Desired Behaviour (for enhancement suggestions only) +> if relevant include images or hyperlinks to other resources that clarify the enhancement you're seeking + +### Current Behaviour (for problems) +> What currently happens that isn't expected behaviour? + +### Steps to Reproduce (for problems) +> Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant +1. +2. +3. +4. + +### Your Environment +> Include as many relevant details about the environment you experienced the bug in - this will help us resolve the bug more expediently + +* Environment name and version: +* Operating System and version: diff --git a/README.md b/README.md index e55232f..dfd3827 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/okfn/chat) + Machine readable list of open (http://opensource.org/, http://opendefinition.org/) licenses and web service - see . @@ -13,6 +15,8 @@ All data (and associated content) is placed in the Public Domain using the License](http://opendatacommons.org/licenses/pddl/1-0/). All code is licensed under the [MIT License](http://www.opensource.org/licenses/mit-license.php). +## contributions +Your contributions are very welcome. [Learn how you can help](./CONTRIBUTING.md) ## Layout @@ -34,39 +38,8 @@ To build files for deployment do: bin/deploy.py run -For deployment simply upload the current directory files to a relevant online -location. +For deployment simply upload the current directory files to a relevant online location. We currently use github pages (we previously used s3). -## Changelog - -### HEAD - -* Complete rewrite to be simpler (just data, no longer python library). - See - -### v0.6.1 2011-02-22 - -* Minor tweak to CC by-sa license name - -### v0.6 2011-02-11 - -* Heavy refactoring and simplification -* Improve and add documentation - -### v0.5 2010-05-11 - -* Addition of Licenses SoS v2.0 capabilities - - -### v0.4 2010-03-08 - -* This module is redesigned to be a web service -* Addition of Licenses SoS v1.0 capabilities (Specification of Service) - - -### v0.3 2010-03-06 and older - -* Module is designed to be imported to provide its list of licenses - +The changes in each [release](https://github.com/okfn/licenses/releases) are recorded in the [Change Log](./CHANGELOG.md). diff --git a/datapackage.json b/datapackage.json index bda027e..c41549d 100644 --- a/datapackage.json +++ b/datapackage.json @@ -1,83 +1,108 @@ { - "title": "Licenses", "name": "licenses", + "title": "Licenses", "description": "a list of open (http://opensource.org/, http://opendefinition.org/) licenses.", - "sources": [ - { - "name":"Open Definition Licenses Service", - "web": "http://licenses.opendefinition.org" - } - ], - "licenses": [ - { - "url": "http://www.opendefinition.org/licenses/odc-pddl", - "title": "Open Data Commons Public Domain Dedication and Licence 1.0", - "id": "ODC-PDDL-1.0" - } - ], - "resources": [ - { - "name": "licenses.csv", - "path": "licenses.csv", - "mediatype": "text/csv", - "bytes": 15051, - "schema": { - "fields": [ - { - "name": "id", - "type": "string" - }, - { - "name": "domain_content", - "type": "string", - "description": "Open Content License" - }, - { - "name": "domain_data", - "type": "string", - "description": "Open Data License" - }, - { - "name": "domain_software", - "type": "string", - "description": "Open Software License" - }, - { - "name": "family", - "type": "number" - }, - { - "name": "is_generic", - "type": "number" - }, - { - "name": "maintainer", - "type": "number" - }, - { - "name": "od_conformance", - "type": "string", - "description": "Conforming to the Open Definition" - }, - { - "name": "osd_conformance", - "type": "string", - "description": "Conforming to Open Source Definition" - }, - { - "name": "status", - "type": "string" - }, - { - "name": "title", - "type": "string" - }, - { - "name": "url", - "type": "string" + "profile": "tabular-data-package", + "sources": [{ + "title": "Open Definition Licenses Service", + "path": "http://licenses.opendefinition.org" + }], + "licenses": [{ + "name": "ODC-PDDL-1.0", + "path": "http://www.opendefinition.org/licenses/odc-pddl", + "title": "Open Data Commons Public Domain Dedication and Licence 1.0" + }], + "resources": [{ + "name": "licenses.csv", + "path": "licenses.csv", + "profile": "tabular-data-resource", + "format": "csv", + "mediatype": "text/csv", + "schema": { + "fields": [{ + "name": "id", + "type": "string", + "constraints": { + "required": true, + "unique": true + } + }, + { + "name": "domain_content", + "type": "boolean", + "description": "Open Content License", + "constraints": { + "required": true + } + }, + { + "name": "domain_data", + "type": "boolean", + "description": "Open Data License", + "constraints": { + "required": true + } + }, + { + "name": "domain_software", + "type": "boolean", + "description": "Open Software License", + "constraints": { + "required": true + } + }, + { + "name": "family", + "type": "string" + }, + { + "name": "is_generic", + "type": "boolean" + }, + { + "name": "maintainer", + "type": "string" + }, + { + "name": "od_conformance", + "type": "string", + "description": "Conforming to the Open Definition", + "constraints": { + "enum": ["approved", "not reviewed", "rejected"] + } + }, + { + "name": "osd_conformance", + "type": "string", + "description": "Conforming to Open Source Definition", + "constraints": { + "enum": ["approved", "not reviewed", "rejected"] + } + }, + { + "name": "status", + "type": "string", + "constraints": { + "enum": ["active", "retired", "superceded"] + } + }, + { + "name": "title", + "type": "string", + "constraints": { + "required": true, + "unique": true + } + }, + { + "name": "url", + "type": "string", + "format": "uri", + "constraints": { + "unique": true } - ] - } + } + ] } - ] + }] } diff --git a/licenses.csv b/licenses.csv index dd8b5a4..e14a56c 100644 --- a/licenses.csv +++ b/licenses.csv @@ -63,12 +63,12 @@ Naumen,FALSE,FALSE,TRUE,,,,not reviewed,approved,active,Naumen Public License,ht Nokia,FALSE,FALSE,TRUE,,,,not reviewed,approved,active,Nokia Open Source License,http://www.opensource.org/licenses/Nokia OCLC-2.0,FALSE,FALSE,TRUE,,,,not reviewed,approved,active,OCLC Research Public License 2.0,http://www.opensource.org/licenses/OCLC-2.0 ODC-BY-1.0,FALSE,TRUE,FALSE,,,Open Data Commons,approved,not reviewed,active,Open Data Commons Attribution License 1.0,http://www.opendefinition.org/licenses/odc-by -ODC-PDDL-1.0,FALSE,TRUE,FALSE,,,,approved,not reviewed,active,Open Data Commons Public Domain Dedication and Licence 1.0,http://www.opendefinition.org/licenses/odc-pddl -ODbL-1.0,FALSE,TRUE,FALSE,,,,approved,not reviewed,active,Open Data Commons Open Database License 1.0,http://www.opendefinition.org/licenses/odc-odbl +ODC-PDDL-1.0,FALSE,TRUE,FALSE,,,Open Data Commons,approved,not reviewed,active,Open Data Commons Public Domain Dedication and Licence 1.0,http://www.opendefinition.org/licenses/odc-pddl +ODbL-1.0,FALSE,TRUE,FALSE,,,Open Data Commons,approved,not reviewed,active,Open Data Commons Open Database License 1.0,http://www.opendefinition.org/licenses/odc-odbl OFL-1.1,FALSE,FALSE,TRUE,,,,not reviewed,approved,active,Open Font License 1.1,http://www.opensource.org/licenses/OFL-1.1 OGL-Canada-2.0,TRUE,TRUE,FALSE,,FALSE,Government of Canada,approved,not reviewed,active,Open Government License 2.0 (Canada),http://data.gc.ca/eng/open-government-licence-canada -OGL-UK-1.0,TRUE,TRUE,TRUE,,,,not reviewed,not reviewed,superseded,Open Government Licence 1.0 (United Kingdom),http://reference.data.gov.uk/id/open-government-licence -OGL-UK-2.0,TRUE,TRUE,TRUE,,FALSE,UK Government,approved,not reviewed,active,Open Government Licence 2.0 (United Kingdom),https://www.nationalarchives.gov.uk/doc/open-government-licence/version/2/ +OGL-UK-1.0,TRUE,TRUE,TRUE,,,,not reviewed,not reviewed,superceded,Open Government Licence 1.0 (United Kingdom),http://reference.data.gov.uk/id/open-government-licence +OGL-UK-2.0,TRUE,TRUE,TRUE,,FALSE,UK Government,approved,not reviewed,superceded,Open Government Licence 2.0 (United Kingdom),https://www.nationalarchives.gov.uk/doc/open-government-licence/version/2/ OGL-UK-3.0,TRUE,TRUE,TRUE,,FALSE,UK Government,approved,not reviewed,active,Open Government Licence 3.0 (United Kingdom),https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/ OGTSL,FALSE,FALSE,TRUE,,,,not reviewed,approved,active,Open Group Test Suite License,http://www.opensource.org/licenses/OGTSL OSL-3.0,TRUE,FALSE,TRUE,,,Lawrence Rosen,not reviewed,approved,active,Open Software License 3.0,http://www.opensource.org/licenses/OSL-3.0 @@ -93,7 +93,7 @@ Xnet,FALSE,FALSE,TRUE,,,,not reviewed,approved,active,X.Net License,http://www.o ZPL-2.0,FALSE,FALSE,TRUE,,,Zope Foundation,not reviewed,approved,active,Zope Public License 2.0,http://www.opensource.org/licenses/ZPL-2.0 Zlib,FALSE,FALSE,TRUE,,,,not reviewed,approved,active,zlib/libpng license,http://www.opensource.org/licenses/Zlib dli-model-use,FALSE,TRUE,FALSE,,,,not reviewed,not reviewed,retired,Statistics Canada: Data Liberation Initiative (DLI) - Model Data Use Licence,http://data.library.ubc.ca/datalib/geographic/DMTI/license.html -geogratis,FALSE,TRUE,FALSE,,,,,not reviewed,active,Geogratis,http://geogratis.gc.ca/geogratis/licenceGG +geogratis,FALSE,TRUE,FALSE,,,,not reviewed,not reviewed,retired,Geogratis,http://geogratis.gc.ca/geogratis/licenceGG hesa-withrights,TRUE,FALSE,FALSE,,,,approved,not reviewed,active,Higher Education Statistics Agency Copyright with data.gov.uk rights,http://www.hesa.ac.uk/index.php?option=com_content&task=view&id=2619&Itemid=209 localauth-withrights,TRUE,FALSE,FALSE,,,,approved,not reviewed,active,Local Authority Copyright with data.gov.uk rights, met-office-cp,FALSE,FALSE,FALSE,,,,not reviewed,not reviewed,active,Met Office UK Climate Projections Licence Agreement,http://www.metoffice.gov.uk/climatechange/science/monitoring/ukcp09/UKCIP08_license_agreement_130709.pdf @@ -108,3 +108,10 @@ ukclickusepsi,TRUE,FALSE,FALSE,,,,rejected,not reviewed,active,UK Click Use PSI, ukcrown,FALSE,FALSE,FALSE,,,,rejected,not reviewed,active,UK Crown Copyright, ukcrown-withrights,TRUE,FALSE,FALSE,,,,approved,not reviewed,active,UK Crown Copyright with data.gov.uk rights, ukpsi,TRUE,FALSE,FALSE,,,,rejected,not reviewed,active,UK PSI Public Sector Information,http://www.opendefinition.org/licenses/ukpsi +OGL-TW-1.0,FALSE,TRUE,FALSE,,FALSE,Republic of China (Taiwan),approved,not reviewed,active,Open Government Data License Taiwan 1.0,https://data.gov.tw/license +OGL-DE-BY-2.0,FALSE,TRUE,FALSE,,FALSE,German Government,approved,not reviewed,active,Data Licence Germany-attribution-version 2.0,https://www.govdata.de/dl-de/by-2-0 +OGL-DE-ZERO-2.0,FALSE,TRUE,FALSE,,FALSE,German Government,approved,not reviewed,active,Data Licence Germany-Zero-Version 2.0,https://www.govdata.de/dl-de/zero-2-0 +CC-BY-ND-4.0,TRUE,TRUE,FALSE,,,Creative Commons,rejected,not reviewed,active,Creative Commons Attribution No-Derivatives 4.0,https://creativecommons.org/licenses/by-nd/4.0/ +CC-BY-NC-ND-4.0,TRUE,TRUE,FALSE,,,Creative Commons,rejected,not reviewed,active,Creative Commons Attribution NonCommercial No-Derivatives 4.0,https://creativecommons.org/licenses/by-nc-nd/4.0/ +CC-BY-NC-SA-4.0,TRUE,TRUE,FALSE,,,Creative Commons,rejected,not reviewed,active,Creative Commons Attribution NonCommercial Share-Alike 4.0,https://creativecommons.org/licenses/by-nc-sa/4.0/ +LO-FR-2.0,FALSE,TRUE,FALSE,,FALSE,Etalab,not reviewed,not reviewed,active,Open License 2.0,https://www.etalab.gouv.fr/licence-ouverte-open-licence