Skip to content
Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

whosonfirst-sources

Where things come from in Who's On First.

Click here to see a full list of Who's On First sources.

Installation

sudo pip install -r requirements.txt .

Adding a new source

  1. Create a new source .json file using the template file.
  2. Fill out all required properties and optional properties, if available.
  3. Run the Makefile using the make all command.

Python 3 Health Warning

The scripts in this repo's ./bin directory require and assume Python 3.

If your default Python is still 2.7.x (as many people's still are), this will cause these scripts to complain in a pained manner. Setting the PYTHON environment variable as part of running the Makefile will make the scripts happy and run, something like this ...

PYTHON=`which python3` make all

If your default Python is 3.x then you can safely ignore this.

Source Properties

While a source .json file in the whosonfirst-sources repository does not require all properties listed below, the more information we are able to gather about a source, the better. When adding a new source, please provide as much current, available information about that specific source as possible.

  • "id": A unique numeric integer identifier, typically derived from Brooklyn Integers (integer, required property).

  • "fullname": The full name of the source (string, required property).

  • "name": The user-derived, abbrviated name of a given source (string, required property).

  • "prefix": The user-derived, prefix a given source. This value is typically two to ten characters in length (string, required property).

  • "key": A list of data properties used from the source. Optional and typically left empty (string, optional property).

  • "url": An http link to the source, preferably the homepage (string, optional property).

  • "license": A link to the license or terms of service page, if available, for the source (string, optional property).

  • "license_type": The license or equivalent license type for the source's data (string, optional property).

  • "license_text": A one to two sentence description of what the license allows (string, optional property).

  • "license_text_eng": A one to two sentence description of what the license allows, in English. Used when the license_text is non-English (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 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.

  • "usage_geometry": Represents whether or not this source is used for geometries (integer, required property). 1 value indicates use, 0 value indicates no use, -1 value indicates unsure of use.

  • "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).

  • "edtf:inception": Indicates the date when a source was added to Who's On First. (string, required property). Format: YYYY-MM-DD (though these dates can be encoded with any valid EDTF syntax).

See also

About

Where things come from in Who's On First.

Resources

License

Releases

No releases published
You can’t perform that action at this time.