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

Source updates, usage tagging #110

Merged
merged 36 commits into from
May 23, 2018
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
07d7827
first pass at adding all flags to src jsons
stepps00 May 18, 2018
e16baf6
makefile run
stepps00 May 18, 2018
4c5f0cb
deprecated sources, add logic to docs.py
stepps00 May 18, 2018
fa5de9e
updated three sources, links, docs.py update
stepps00 May 18, 2018
a82fbcc
more docs.py logic, makefile run to update src via links
stepps00 May 19, 2018
bd28f55
formatting to add new line in README
stepps00 May 19, 2018
b62b225
src:via description to readme
stepps00 May 19, 2018
c3d0476
update template
stepps00 May 19, 2018
293e1cf
src:via work, json formatting
stepps00 May 21, 2018
f57f9fd
docs.py logic for writing src:via and deprecated date
stepps00 May 21, 2018
087f17b
README updates
stepps00 May 21, 2018
4a3c3e3
property prefix links to prop repo
stepps00 May 21, 2018
9c3ff4f
more usage tags for geometry
stepps00 May 21, 2018
6d623e6
makefile run
stepps00 May 21, 2018
f2f003f
update usage tags, logic in docs py
stepps00 May 21, 2018
db8e294
quotemark
stepps00 May 21, 2018
f65864f
makefile run
stepps00 May 21, 2018
6119686
update template file
stepps00 May 21, 2018
d58d008
another makefile run
stepps00 May 21, 2018
22c6a2b
QS updates, make all
stepps00 May 21, 2018
476f005
formatting in readme
stepps00 May 21, 2018
3de1238
deprecated two sources
stepps00 May 22, 2018
332210a
make file run
stepps00 May 22, 2018
22ee8c9
deprecated localwiki source file
stepps00 May 22, 2018
bf53b42
mapzen-derived, docs.py logic
stepps00 May 22, 2018
878ce4e
comments in docs.py, swap derived w associated
stepps00 May 22, 2018
e411ad8
meso json updates for all src:via:
stepps00 May 22, 2018
9241624
update mapzen.json
stepps00 May 22, 2018
a228c1e
make all run
stepps00 May 22, 2018
2c47feb
wapo link update, make all
stepps00 May 22, 2018
dca8d82
update frgov
stepps00 May 22, 2018
ebda4f2
yerbashapes description update and src:via property
stepps00 May 22, 2018
12630c5
make all, updated meso and mapzen, template, and readme
stepps00 May 22, 2018
3439603
write links in markdown in docs.py
stepps00 May 23, 2018
2193eda
statoids words
stepps00 May 23, 2018
83045cb
make all run
stepps00 May 23, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ While a source .json file in the `whosonfirst-sources` repository does not requi

* `"license_text":` A one to two sentence description of what the license allows (_string, optional property_).

* `"src:via"`: A list of sources used by a source. A list of key/value pairs that includes the source context, source name, link to the source website, and a note about the source (_list__, optional property_). See Quattroshapes for an example.

* `"usage_concordance":` Represents whether or not this source is used for concordance values (_integer, required property_). `1` value indicates use, `0` value indicates no use, `-1` value indicates unsure of use.

* `"usage_property":` Represents whether or not this source is used for property values (_integer, required property_). `1` value indicates use, `0` value indicates no use, `-1` value indicates unsure of use.
Expand All @@ -40,6 +42,10 @@ While a source .json file in the `whosonfirst-sources` repository does not requi

* `"description":` A one to two sentence description of the source (_string, optional property_).

* `"mz:is_current":` Represents whether of not a source is currently in use (_integer, optional property_). `0` signifies "not current".

* `"edtf:deprecated":` Indicates the date when a source was determined to be invalid, was never a "going concern" (_string, optional property_). _Format: YYYY-MM-DD (though these dates can be encoded with any valid EDTF syntax)_.

## See also

* https://github.com/whosonfirst
Expand Down
12 changes: 12 additions & 0 deletions bin/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@
if details.get('description'):
docs.write("_%s_ \n\n" % (details['description']))

if details.get('edtf:deprecated'):
if not details['edtf:deprecated'] == 'uuuu':
docs.write("* %s %s.\n" % ('This source was deprecated on', details['edtf:deprecated']))

for k in ('id', 'name', 'prefix'):

if details[k] == '':
Expand All @@ -75,6 +79,14 @@
else:
docs.write("* %s: `%s`\n" % ('license', details['license']))

if details.get('src:via'):
docs.write("\n This source includes data from the following organizations:\n")
for via in details['src:via']:
if via['source_note']:
docs.write(" \t* **%s**: [%s](%s) - %s\n" % (via["context"],via["source_name"],via["source_link"],via["source_note"]))
Copy link
Member

Choose a reason for hiding this comment

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

Can you add a test for a link and only add the markdown link decorations if there is a link, please?

Here and one down.

else:
docs.write(" \t* **%s**: [%s](%s)\n" % (via["context"],via["source_name"],via["source_link"]))

usage = []

if details.get('usage_concordance'):
Expand Down
1 change: 1 addition & 0 deletions data/sources-spec-20180518.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions data/sources-spec-20180521.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion data/sources-spec-latest.json

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion source_template.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@
"license": "",
"license_type": "",
"license_text": "",
"src:via": {"Whos On First":"https://whosonfirst.org/"},
Copy link
Member

Choose a reason for hiding this comment

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

Please update template for new list of "well known" objects format.

Copy link
Member Author

Choose a reason for hiding this comment

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

"mz:is_current": -1,
"edtf:deprecated": "YYY-MM-DD",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": ""
}
}
202 changes: 198 additions & 4 deletions sources/README.md

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions sources/acgov.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 874397693,
"fullname": "Alameda County Data Sharing Initiative",
"name": "acgov",
"prefix": "acgov",
"key": "",
"url": "https://data.acgov.org/",
"license": "https://data.acgov.org/terms-of-use",
"license_type": "Public Domain",
"license_text": "You understand and agree that Your use of the Data is at Your sole risk. The Data is made available on an 'as is' and 'as available' basis without any warranties of any kind, whether express or implied, including without limitation implied warranties of merchantability, fitness for a particular purpose, and non-infringement. Should there be an error, inaccuracy, or other defect in the Data, You assume the full cost of correcting any such error, inaccuracy or defect.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "Official GIS Data for Alameda County, CA."
"description": "Official GIS Data for Alameda County, CA.",
"fullname": "Alameda County Data Sharing Initiative",
"id": 874397693,
"key": "",
"license": "https://data.acgov.org/terms-of-use",
"license_text": "You understand and agree that Your use of the Data is at Your sole risk. The Data is made available on an 'as is' and 'as available' basis without any warranties of any kind, whether express or implied, including without limitation implied warranties of merchantability, fitness for a particular purpose, and non-infringement. Should there be an error, inaccuracy, or other defect in the Data, You assume the full cost of correcting any such error, inaccuracy or defect.",
"license_type": "Public Domain",
"name": "acgov",
"prefix": "acgov",
"url": "https://data.acgov.org/",
"usage_concordance": 0,
"usage_geometry": 0,
"usage_property": 0
}
26 changes: 13 additions & 13 deletions sources/acme.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108961115,
"fullname": "Acme Laboratories",
"name": "acme",
"prefix": "acme",
"key": "id",
"url": "https://acme.com/",
"license": "https://acme.com/license.html",
"license_type": "BSD (modified)",
"license_text": "Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "Purveyors of fine freeware since 1972. On the net since 1991."
"description": "Purveyors of fine freeware since 1972. On the net since 1991.",
"fullname": "Acme Laboratories",
"id": 1108961115,
"key": "id",
"license": "https://acme.com/license.html",
"license_text": "Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.",
"license_type": "BSD (modified)",
"name": "acme",
"prefix": "acme",
"url": "https://acme.com/",
"usage_concordance": 0,
"usage_geometry": 0,
"usage_property": 0
}
28 changes: 15 additions & 13 deletions sources/addr.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
{
"id": 1108832191,
"fullname": "addr",
"name": "addr",
"prefix": "addr",
"key": "id",
"url": "",
"license": "N/A",
"license_type": "N/A",
"license_text": "",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "Property prefix."
"description": "Property prefix. See [property description](https://github.com/whosonfirst/whosonfirst-properties/tree/master/properties/addr) for more information.",
"fullname": "addr",
"id": 1108832191,
"key": "id",
"license": "N/A",
"license_text": "",
"license_type": "N/A",
"name": "addr",
"prefix": "addr",
"url": "",
"usage_concordance": 0,
"usage_geometry": 0,
"usage_property": 1,
"edtf:deprecated": "2018-05-18",
"mz:is_current": 0
}
26 changes: 13 additions & 13 deletions sources/amsgis.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108802967,
"fullname": "Amsterdam Open Datakaart",
"name": "amsgis",
"prefix": "amsgis",
"key": "",
"url": "https://kaart.amsterdam.nl",
"license": "https://kaart.amsterdam.nl/datasets",
"license_type": "CC BY (assumed)",
"license_text": "N/A",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "Layers are viewable from the link in the url field as Buurten (microhoods), Buurtcombinaties (neighbourhoods), and Stadsdelen en Haven (boroughs). Open source information as well as downloadable datasets are available from the link in the license field."
"description": "Layers are viewable from the link in the url field as Buurten (microhoods), Buurtcombinaties (neighbourhoods), and Stadsdelen en Haven (boroughs). Open source information as well as downloadable datasets are available from the link in the license field.",
"fullname": "Amsterdam Open Datakaart",
"id": 1108802967,
"key": "",
"license": "https://kaart.amsterdam.nl/datasets",
"license_text": "N/A",
"license_type": "CC BY (assumed)",
"name": "amsgis",
"prefix": "amsgis",
"url": "https://kaart.amsterdam.nl",
"usage_concordance": 0,
"usage_geometry": 1,
"usage_property": 1
}
28 changes: 14 additions & 14 deletions sources/ar-caba.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108969549,
"fullname": "Ciudad Autónoma de Buenos Aires, Iniciativa de Datos Públicos y Transparencia",
"name": "arg-caba",
"prefix": "arg-caba",
"key": "",
"url": "https://data.buenosaires.gob.ar/dataset/barrios",
"license": "https://data.buenosaires.gob.ar/tyc",
"license_type": "CC BY",
"license_text": "La reutilización autorizada puede incluir la copia, difusión, modificación, adaptación, extracción, reordenamiento y combinación de la información contenida en el sitio ... Debe citarse la fuente de los documentos objeto de la reutilización.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "Open Data portal for the City of Buenos Aires, Argentina."
}
"description": "Open Data portal for the City of Buenos Aires, Argentina.",
"fullname": "Ciudad Aut\u00f3noma de Buenos Aires, Iniciativa de Datos P\u00fablicos y Transparencia",
"id": 1108969549,
"key": "",
"license": "https://data.buenosaires.gob.ar/tyc",
"license_text": "La reutilizaci\u00f3n autorizada puede incluir la copia, difusi\u00f3n, modificaci\u00f3n, adaptaci\u00f3n, extracci\u00f3n, reordenamiento y combinaci\u00f3n de la informaci\u00f3n contenida en el sitio ... Debe citarse la fuente de los documentos objeto de la reutilizaci\u00f3n.",
"license_type": "CC BY",
"name": "arg-caba",
"prefix": "arg-caba",
"url": "https://data.buenosaires.gob.ar/dataset/barrios",
"usage_concordance": 0,
"usage_geometry": 1,
"usage_property": 0
}
26 changes: 13 additions & 13 deletions sources/atgov.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 823312445,
"fullname": "data.gv.at",
"name": "atgov",
"prefix": "atgov",
"key": "",
"url": "https://www.data.gv.at",
"license": "http://creativecommons.org/licenses/by/3.0/at/",
"license_type": "CC BY 3.0",
"license_text": "You are free to Share, copy and redistribute the material in any medium or format. Adapt, remix, transform, and build upon the material for any purpose, even commercially. The licensor cannot revoke these freedoms as long as you follow the license terms.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": ""
"description": "",
"fullname": "data.gv.at",
"id": 823312445,
"key": "",
"license": "http://creativecommons.org/licenses/by/3.0/at/",
"license_text": "You are free to Share, copy and redistribute the material in any medium or format. Adapt, remix, transform, and build upon the material for any purpose, even commercially. The licensor cannot revoke these freedoms as long as you follow the license terms.",
"license_type": "CC BY 3.0",
"name": "atgov",
"prefix": "atgov",
"url": "https://www.data.gv.at",
"usage_concordance": 0,
"usage_geometry": 0,
"usage_property": 0
}
26 changes: 13 additions & 13 deletions sources/atldpcd.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108797031,
"fullname": "Atlanta Department of Planning and Community Development",
"name": "atldpcd",
"prefix": "atldpcd",
"key": "",
"url": "http://dpcd.coaplangis.opendata.arcgis.com/datasets/neighborhoods",
"license": "https://www.arcgis.com/home/item.html?id=716f417a1990446389ef7fd2c381d09f",
"license_type": "CC BY 4.0",
"license_text": "Share, copy and redistribute the material in any medium or format. Adapt, remix, transform, and build upon the material for any purpose, even commercially.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "Neighborhoods within the City of Atlanta."
"description": "Neighborhoods within the City of Atlanta.",
"fullname": "Atlanta Department of Planning and Community Development",
"id": 1108797031,
"key": "",
"license": "https://www.arcgis.com/home/item.html?id=716f417a1990446389ef7fd2c381d09f",
"license_text": "Share, copy and redistribute the material in any medium or format. Adapt, remix, transform, and build upon the material for any purpose, even commercially.",
"license_type": "CC BY 4.0",
"name": "atldpcd",
"prefix": "atldpcd",
"url": "http://dpcd.coaplangis.opendata.arcgis.com/datasets/neighborhoods",
"usage_concordance": 0,
"usage_geometry": 1,
"usage_property": 1
}
26 changes: 13 additions & 13 deletions sources/ausstat.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108693461,
"fullname": "Australian Bureau of Statistics",
"name": "ausstat",
"prefix": "ausstat",
"key": "",
"url": "http://www.abs.gov.au/AUSSTATS/abs@.nsf/DetailsPage/1270.0.55.003July%202011?OpenDocument",
"license": "http://www.abs.gov.au/websitedbs/D3310114.nsf/Home/%A9+Copyright?opendocument",
"license_type": "CC BY 2.5 AU",
"license_text": "Unless otherwise noted, all material on this website, except the ABS logo, the Commonwealth Coat of Arms, and any material protected by a trade mark, is licensed under a Creative Commons Attribution 2.5 Australia licence.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "The ABS is Australia's national statistical agency, providing trusted official statistics on a wide range of economic, social, population and environmental matters of importance to Australia."
"description": "The ABS is Australia's national statistical agency, providing trusted official statistics on a wide range of economic, social, population and environmental matters of importance to Australia.",
"fullname": "Australian Bureau of Statistics",
"id": 1108693461,
"key": "",
"license": "http://www.abs.gov.au/websitedbs/D3310114.nsf/Home/%A9+Copyright?opendocument",
"license_text": "Unless otherwise noted, all material on this website, except the ABS logo, the Commonwealth Coat of Arms, and any material protected by a trade mark, is licensed under a Creative Commons Attribution 2.5 Australia licence.",
"license_type": "CC BY 2.5 AU",
"name": "ausstat",
"prefix": "ausstat",
"url": "http://www.abs.gov.au/AUSSTATS/abs@.nsf/DetailsPage/1270.0.55.003July%202011?OpenDocument",
"usage_concordance": 0,
"usage_geometry": 1,
"usage_property": 0
}
26 changes: 13 additions & 13 deletions sources/austriaod.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108839435,
"fullname": "Austria Open Data",
"name": "Austria Open Data",
"prefix": "austriaod",
"key": "id",
"url": "https://www.data.gv.at/katalog/dataset/c33d36b0-f184-4f2a-89cc-839ca7fcf88a",
"license": "http://creativecommons.org/licenses/by/3.0/at/",
"license_type": "CC BY 3.0",
"license_text": "The data in our catalog are freely available under CC BY 3.0 or CC0 license. The catalog can be sorted according to topic areas. The exact data guidelines can be found in the individual data sets.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": ""
"description": "",
"fullname": "Austria Open Data",
"id": 1108839435,
"key": "id",
"license": "http://creativecommons.org/licenses/by/3.0/at/",
"license_text": "The data in our catalog are freely available under CC BY 3.0 or CC0 license. The catalog can be sorted according to topic areas. The exact data guidelines can be found in the individual data sets.",
"license_type": "CC BY 3.0",
"name": "Austria Open Data",
"prefix": "austriaod",
"url": "https://www.data.gv.at/katalog/dataset/c33d36b0-f184-4f2a-89cc-839ca7fcf88a",
"usage_concordance": 0,
"usage_geometry": 0,
"usage_property": 1
}
26 changes: 13 additions & 13 deletions sources/azavea.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108721357,
"fullname": "Azavea, Inc.",
"name": "azavea",
"prefix": "azavea",
"key": "",
"url": "https://www.opendataphilly.org/dataset/philadelphia-neighborhoods/resource/06e8d380-821f-44ce-8718-a0f2f7902318",
"license": "https://www.opendataphilly.org/dataset/philadelphia-neighborhoods",
"license_type": "CC BY 3.0 US",
"license_text": "You are free to: Share, copy and redistribute the material in any medium or format. Adapt, remix, transform, and build upon the material for any purpose, even commercially.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "Azavea is a civic technology firm based in Philadelphia. Azavea applies geospatial technology for civic and social impact."
"description": "Azavea is a civic technology firm based in Philadelphia. Azavea applies geospatial technology for civic and social impact.",
"fullname": "Azavea, Inc.",
"id": 1108721357,
"key": "",
"license": "https://www.opendataphilly.org/dataset/philadelphia-neighborhoods",
"license_text": "You are free to: Share, copy and redistribute the material in any medium or format. Adapt, remix, transform, and build upon the material for any purpose, even commercially.",
"license_type": "CC BY 3.0 US",
"name": "azavea",
"prefix": "azavea",
"url": "https://www.opendataphilly.org/dataset/philadelphia-neighborhoods/resource/06e8d380-821f-44ce-8718-a0f2f7902318",
"usage_concordance": 0,
"usage_geometry": 1,
"usage_property": 1
}
26 changes: 13 additions & 13 deletions sources/baltomoit.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": 1108794385,
"fullname": "Baltimore Mayor's Office of Information Technology",
"name": "baltomoit",
"prefix": "baltomoit",
"key": "",
"url": "https://data.baltimorecity.gov/Geographic/Baltimore-Study-Area/cdrh-gpzc",
"license": "https://data.baltimorecity.gov/Geographic/Baltimore-Study-Area/cdrh-gpzc/about",
"license_type": "Attribution 3.0 Unported",
"license_text": "THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ('CCPL' OR 'LICENSE'). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW.",
"usage_concordance":-1,
"usage_property":-1,
"usage_geometry":-1,
"description": "City of Baltimore Open Data Portal. This website is operated by the Mayor and City Council of Baltimore (the 'City') and the data is provided as a service to the public."
"description": "City of Baltimore Open Data Portal. This website is operated by the Mayor and City Council of Baltimore (the 'City') and the data is provided as a service to the public.",
"fullname": "Baltimore Mayor's Office of Information Technology",
"id": 1108794385,
"key": "",
"license": "https://data.baltimorecity.gov/Geographic/Baltimore-Study-Area/cdrh-gpzc/about",
"license_text": "THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ('CCPL' OR 'LICENSE'). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW.",
"license_type": "Attribution 3.0 Unported",
"name": "baltomoit",
"prefix": "baltomoit",
"url": "https://data.baltimorecity.gov/Geographic/Baltimore-Study-Area/cdrh-gpzc",
"usage_concordance": 0,
"usage_geometry": 1,
"usage_property": 1
}
Loading