saunteringcat commited on
Commit
d55d10e
·
verified ·
1 Parent(s): dcb067b

Update README.md

Browse files

Update to include license information about data

Files changed (1) hide show
  1. README.md +11 -1
README.md CHANGED
@@ -2,7 +2,9 @@
2
  license: mit
3
  ---
4
 
5
- # Whereabouts
 
 
6
 
7
  Whereabouts is a geocoding package in Python that implements some clever record linkage algorithms in SQL using DuckDB. The package itself
8
  is available at [whereabouts](https://github.com/ajl2718/whereabouts) and can be installed via
@@ -11,6 +13,14 @@ is available at [whereabouts](https://github.com/ajl2718/whereabouts) and can be
11
  pip install whereabouts
12
  ```
13
 
 
 
 
 
 
 
 
 
14
  ## Installation of reference databases
15
  Once the package is installed you will need to install a geocoding database, which has been built from a country's or region's address data.
16
  This repo contains a collection of these databases for different countries and regions. Currently it has files for
 
2
  license: mit
3
  ---
4
 
5
+ # Whereabouts: Reference databases
6
+
7
+ This is a space containing reference databases to be used by [whereabouts](https://github.com/ajl2718/whereabouts).
8
 
9
  Whereabouts is a geocoding package in Python that implements some clever record linkage algorithms in SQL using DuckDB. The package itself
10
  is available at [whereabouts](https://github.com/ajl2718/whereabouts) and can be installed via
 
13
  pip install whereabouts
14
  ```
15
 
16
+ ## Important note about licenses
17
+ Note that while the code from this package is licensed under the MIT license, the pre-built databases use data from data providers
18
+ that may have restrictions for particular use cases:
19
+ - The Australian databases are built from the [Geocoded National Address File](https://https://data.gov.au/data/dataset/geocoded-national-address-file-g-naf) with conditions of use based on the [End User License Agreemment](https://data.gov.au/dataset/ds-dga-e1a365fc-52f5-4798-8f0c-ed1d33d43b6d/distribution/dist-dga-0102be65-3781-42d9-9458-fdaf7170efed/details?q=previous%20gnaf)
20
+ - The US databases are still work-in-progress but are based on data from [OpenAddresses](https://openaddresses.io/) and so any work with whereabouts based on US address data should adhere to the [OpenAddresses license](https://github.com/openaddresses/openaddresses/blob/master/LICENSE).
21
+
22
+ Please ensure that you are adhering to these licenses in your applications.
23
+
24
  ## Installation of reference databases
25
  Once the package is installed you will need to install a geocoding database, which has been built from a country's or region's address data.
26
  This repo contains a collection of these databases for different countries and regions. Currently it has files for