Source updates, usage tagging

README.md

@@ -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 the [template file](source_template.json) 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.
@@ -40,6 +42,12 @@ 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".
+
+* `"mz:associated":` Represents a source associated with works at Mapzen (_integer, optional property_). `1` signifies "Mapzen associated".
+
+* `"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

bin/docs.py

@@ -42,6 +42,8 @@
 
     docs.write("_This file was generated by the `bin/docs.py` script on %s_\n\n" % ymd)
 
+    docs.write("_All sources listed below are currently used to populate Who's On First records or will be added to Who's On First records in the near future._")
+
     for n in names:
 
         id = lookup[n]
@@ -52,6 +54,15 @@
         if details.get('description'):
             docs.write("_%s_ \n\n" % (details['description']))
 
+        #call out mz associated sources (wof, transitland, etc)
+        if details.get('mz_associated'):
+            docs.write("_This is a Mapzen associated source._ \n\n")
+
+        #call out deprecated sources and their deprecated date
+        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] == '':
@@ -70,13 +81,31 @@
         if details.get('remarks'):
             docs.write("* %s: _%s_\n" % ('remarks', details['remarks']))
 
+        #link to the license page for each source if page is available
         if details.get('license') and details.get('license').startswith("http"):
             docs.write("* %s: _%s_\n" % ('license', details['license']))
         else:
             docs.write("* %s: `%s`\n" % ('license', details['license']))
 
+        #list out all "via" sources with links to each source's source...
+        if details.get('src:via'):
+            docs.write("\n  This source includes `CC-BY compatible` data from the following organizations:\n")
+            for via in details['src:via']:
+                if not via['source_link'] == "":
+                    if via['source_note']:
+                        docs.write("  \t* **%s**: [%s](%s) - %s\n" % (via["context"],via["source_name"],via["source_link"],via["source_note"]))
+                    else:
+                        docs.write("  \t* **%s**: [%s](%s)\n" % (via["context"],via["source_name"],via["source_link"]))
+
+                else:
+                    if via['source_note']:
+                        docs.write("  \t* **%s**: %s - %s\n" % (via["context"],via["source_name"],via["source_note"]))
+                    else:
+                        docs.write("  \t* **%s**: %s\n" % (via["context"],via["source_name"]))
+
         usage = []
-
+
+        #catch any usage flag and append it as markdown to a usage: prop, if found
         if details.get('usage_concordance'):
             if details['usage_concordance'] == 1:
                 usage.append("`concordance`")

source_template.json

@@ -1,5 +1,5 @@
 {
-	"id":-1,
+	"id": -1,
 	"fullname": "",
 	"name": "",
 	"prefix": "",
@@ -8,8 +8,17 @@
 	"license": "",
 	"license_type": "",
 	"license_text": "",
-	"usage_concordance":-1,
-	"usage_property":-1,
-	"usage_geometry":-1,
+	"src:via": [{
+		"context": "Canada",
+		"source_link": "http://statcan.gc.ca/",
+		"source_name": "Statistics Canada",
+		"source_note": "Canadian open data portal."
+	}],
+	"mz:associated":-1
+	"mz:is_current": -1,
+	"edtf:deprecated": "YYY-MM-DD",
+	"usage_concordance": -1,
+	"usage_property": -1,
+	"usage_geometry": -1,
 	"description": ""
 }