├── pyproject.toml ├── tests ├── fixtures │ ├── batch.csv │ ├── address-locations.yaml │ ├── coordinates.yaml │ ├── address-geographies.yaml │ ├── address-batch.yaml │ ├── test_benchmark_vintage.yaml │ └── onelineaddress.yaml ├── __init__.py └── test_censusgeocode.py ├── setup.py ├── Makefile ├── src └── censusgeocode │ ├── __init__.py │ ├── __main__.py │ └── censusgeocode.py ├── .github └── workflows │ ├── test.yml │ └── publish.yml ├── .gitignore ├── setup.cfg ├── HISTORY ├── README.md └── LICENSE /pyproject.toml: -------------------------------------------------------------------------------- 1 | # This file is part of censusgeocode. 2 | # https://github.com/fitnr/censusgeocode 3 | [build-system] 4 | requires = ["setuptools>=60.5.0", "wheel"] 5 | build-backend = 'setuptools.build_meta' 6 | -------------------------------------------------------------------------------- /tests/fixtures/batch.csv: -------------------------------------------------------------------------------- 1 | 1,4600 Silver Hill Rd,Suitland,MD,20746 2 | 2,79 Wistful Vista,Peoria,IL,61604 3 | 3,3 Gramercy Park West,New York,NY,10003 4 | 3B,3 Gramercy Park West,New York,NY, 5 | 3C,3 Gramercy Park West,,,10003 6 | 4A,2711 4th St NW,Albuquerque,NM,87107 7 | 4B,346 W 600 S,Salt Lake City,Utah,84101 8 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # This file is part of censusgeocode. 4 | # https://github.com/fitnr/censusgeocode 5 | 6 | # Licensed under the General Public License (version 3) 7 | # http://opensource.org/licenses/LGPL-3.0 8 | # Copyright (c) 2015-7, Neil Freeman 9 | 10 | from . import test_censusgeocode 11 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | # This file is part of censusgeocode. 5 | # https://github.com/fitnr/censusgeocode 6 | 7 | # Licensed under the General Public License (version 3) 8 | # http://opensource.org/licenses/LGPL-3.0 9 | # Copyright (c) 2015-9, Neil Freeman 10 | 11 | from setuptools import setup 12 | 13 | setup() 14 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # This file is part of censusgeocode. 2 | # https://github.com/fitnr/censusgeocode 3 | 4 | # Licensed under the General Public License (version 3) 5 | # http://opensource.org/licenses/LGPL-3.0 6 | # Copyright (c) 2015-9, Neil Freeman 7 | 8 | .PHONY: install build upload clean deploy test 9 | 10 | install: ; pip install . 11 | 12 | test: ; python -m unittest tests/test_*.py 13 | 14 | deploy: build 15 | twine upload dist/* 16 | 17 | build: | clean 18 | python -m build 19 | 20 | clean:; rm -rf dist build 21 | -------------------------------------------------------------------------------- /src/censusgeocode/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # This file is part of censusgeocode. 4 | # https://github.com/fitnr/censusgeocode 5 | 6 | # Licensed under the General Public License (version 3) 7 | # http://opensource.org/licenses/LGPL-3.0 8 | # Copyright (c) 2015-9, Neil Freeman 9 | 10 | from .censusgeocode import CensusGeocode 11 | 12 | __version__ = '0.5.2' 13 | 14 | cg = CensusGeocode() 15 | 16 | coordinates = cg.coordinates 17 | address = cg.address 18 | onelineaddress = cg.onelineaddress 19 | addressbatch = cg.addressbatch 20 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | # This file is part of censusgeocode. 2 | # https://github.com/fitnr/censusgeocode 3 | 4 | # Licensed under the General Public License (version 3) 5 | # http://opensource.org/licenses/LGPL-3.0 6 | # Copyright (c) 2015-7, Neil Freeman 7 | 8 | name: Test package 9 | 10 | on: 11 | push: 12 | pull_request: 13 | branches: [master] 14 | 15 | jobs: 16 | test: 17 | runs-on: ubuntu-latest 18 | strategy: 19 | matrix: 20 | python: ["3.7", "3.8", "3.9", "3.10", "3.11.9"] 21 | 22 | steps: 23 | - uses: actions/checkout@v2 24 | 25 | - name: Set up Python 26 | uses: actions/setup-python@v2 27 | with: 28 | python-version: ${{ matrix.python }} 29 | cache: 'pip' 30 | cache-dependency-path: setup.cfg 31 | 32 | - name: Install package 33 | run: | 34 | python -m pip install -U pip 35 | pip install '.[tests]' 36 | 37 | - run: make test 38 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | # This file is part of censusgeocode. 2 | # https://github.com/fitnr/censusgeocode 3 | 4 | # Licensed under the General Public License (version 3) 5 | # http://opensource.org/licenses/LGPL-3.0 6 | # Copyright (c) 2015-7, Neil Freeman 7 | name: Publish to PyPi 8 | 9 | on: 10 | release: 11 | types: [created] 12 | 13 | jobs: 14 | deploy: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - uses: actions/checkout@v2 18 | 19 | - name: Set up Python 20 | uses: actions/setup-python@v2 21 | with: 22 | python-version: "3.10" 23 | cache: 'pip' 24 | cache-dependency-path: setup.cfg 25 | 26 | - name: Install build requirements 27 | run: | 28 | python -m pip install -U pip 29 | pip install build 30 | 31 | - run: make build 32 | 33 | - name: Publish package 34 | uses: pypa/gh-action-pypi-publish@release/v1 35 | with: 36 | user: __token__ 37 | password: ${{ secrets.PYPI_API_TOKEN }} 38 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # This file is part of censusgeocode. 2 | # https://github.com/fitnr/censusgeocode 3 | 4 | # Licensed under the General Public License (version 3) 5 | # http://opensource.org/licenses/LGPL-3.0 6 | # Copyright (c) 2015-7, Neil Freeman 7 | 8 | # Byte-compiled / optimized / DLL files 9 | __pycache__/ 10 | *.py[cod] 11 | 12 | # C extensions 13 | *.so 14 | 15 | # Distribution / packaging 16 | .Python 17 | env/ 18 | bin/ 19 | build/ 20 | develop-eggs/ 21 | dist/ 22 | eggs/ 23 | lib/ 24 | lib64/ 25 | parts/ 26 | sdist/ 27 | var/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | .eggs 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | 45 | # Translations 46 | *.mo 47 | 48 | # Mr Developer 49 | .mr.developer.cfg 50 | .project 51 | .pydevproject 52 | 53 | # Rope 54 | .ropeproject 55 | 56 | # Django stuff: 57 | *.log 58 | *.pot 59 | 60 | # Sphinx documentation 61 | docs/_build/ 62 | 63 | readme.rst 64 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | [metadata] 3 | license_files = LICENSE.txt 4 | name = censusgeocode 5 | version = attr: censusgeocode.__version__ 6 | description = Thin Python wrapper for the US Census Geocoder 7 | long_description = file: README.md 8 | long_description_content_type = text/markdown 9 | keywords= census, geocode, api 10 | author = Neil Freeman 11 | author_email = contact@fakeisthenewreal.org 12 | url = https://github.com/fitnr/censusgeocode 13 | license = GNU General Public License v3 (GPLv3) 14 | classifiers = 15 | Development Status :: 4 - Beta 16 | Intended Audience :: Developers 17 | License :: OSI Approved :: GNU General Public License v3 (GPLv3) 18 | Natural Language :: English 19 | Programming Language :: Python :: 3.7 20 | Programming Language :: Python :: 3.8 21 | Programming Language :: Python :: 3.9 22 | Programming Language :: Python :: 3.10 23 | Operating System :: OS Independent 24 | 25 | [options] 26 | package_dir = 27 | =src 28 | packages = find: 29 | install_requires = 30 | requests[security]>=2.27.0,<3 31 | requests-toolbelt>=0.9.0 # removed version restriction to be less than 1 32 | python_requires = >= 3.6, <4 33 | 34 | [options.extras_require] 35 | tests = vcrpy>=4.1.1,<5 36 | 37 | [options.packages.find] 38 | where = src 39 | 40 | [options.entry_points] 41 | console_scripts = 42 | censusgeocode = censusgeocode.__main__:main 43 | -------------------------------------------------------------------------------- /HISTORY: -------------------------------------------------------------------------------- 1 | 0.5.2 2 | ----- 3 | * Accept either "zip" or "zipcode" as an argument in `CensusGeocode.address` (#24). 4 | * Add warning to `CensusGeocode.batch()` when trying send more than 10,000 records 5 | * Move packaging metadata to setup.cfg and pyproject.toml 6 | * Use github actions for automated tests 7 | 8 | 0.5.1 9 | ----- 10 | * Fix empty default values (#23) 11 | 12 | 0.5.0 13 | ----- 14 | * Removed hard-coded benchmarks and vintages, which were out of date. Refer to Census Geocoder documentation for a list of active benchmarks and vintages. 15 | 16 | 0.4.4 17 | ----- 18 | * Handle misformatted batch responses from the Census 19 | * Add more options for command line tool 20 | * Codify support for Python 3.7, 3.8. Drop support for Python 3.4 21 | 22 | 0.4.3 23 | ----- 24 | * Fixed bug in parsing addressbatch results in some versions of Python (thanks @summonholmes) 25 | 26 | 0.4.2 27 | ----- 28 | * Fix reversed coordinate order in batch addresses 29 | 30 | 0.4.1 31 | ----- 32 | * Add static methods to module 33 | * Update vintages and benchmarks. 34 | 35 | 0.4.0 36 | ----- 37 | * Add support for address batch functionality, including to command line tool 38 | 39 | 0.3.0 40 | ----- 41 | * Better error reporting when API is down. 42 | * Use `requests[security]` to fix SSL 3 errors, bump required `requests` version. 43 | * Combine Py 2 and Py 3 codebases. 44 | * Add timeout parameter to `CensusGeocode.fetch` (thanks @mxr) 45 | 46 | 0.2.3 47 | ----- 48 | * Always yield a `ValueError` when Census API is broken. 49 | * Internal refactor to simplify keyword arguments. 50 | 51 | 0.2.2 52 | ----- 53 | * Improve deployment and fix readme 54 | 55 | 0.2.1 56 | ----- 57 | * Add command line tool 58 | -------------------------------------------------------------------------------- /tests/fixtures/address-locations.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: null 4 | headers: 5 | Accept: ['*/*'] 6 | Accept-Encoding: ['gzip, deflate'] 7 | Connection: [keep-alive] 8 | User-Agent: [python-requests/2.12.4] 9 | method: GET 10 | uri: https://geocoding.geo.census.gov/geocoder/locations/address?city=Washington&zip=20500&format=json&state=DC&street=1600+Pennsylvania+Avenue+NW&vintage=Current_Current&benchmark=Public_AR_Current 11 | response: 12 | body: {string: !!python/unicode '{"result":{"input":{"address":{"state":"DC","street":"1600 13 | Pennsylvania Avenue NW","city":"Washington","zip":"20500"},"benchmark":{"id":"4","isDefault":false,"benchmarkName":"Public_AR_Current","benchmarkDescription":"Public 14 | Address Ranges - Current Benchmark"}},"addressMatches":[{"matchedAddress":"1600 15 | PENNSYLVANIA AVE NW, WASHINGTON, DC, 20502","coordinates":{"x":-77.03535,"y":38.898754},"tigerLine":{"tigerLineId":"76225813","side":"L"},"addressComponents":{"fromAddress":"1600","toAddress":"1698","preQualifier":"","preDirection":"","preType":"","streetName":"PENNSYLVANIA","suffixType":"AVE","suffixDirection":"NW","suffixQualifier":"","state":"DC","city":"WASHINGTON","zip":"20502"}}]}}'} 16 | headers: 17 | cache-control: [private, 'no-cache, no-store, max-age=0'] 18 | content-language: [en-US] 19 | content-type: [application/json] 20 | date: ['Tue, 31 Oct 2017 17:52:24 GMT'] 21 | expires: ['Thu, 01 Jan 1970 00:00:00 GMT'] 22 | pragma: [no-cache] 23 | strict-transport-security: [max-age=31536000] 24 | vary: [Origin] 25 | x-frame-options: [Deny] 26 | status: {code: 200, message: OK} 27 | version: 1 28 | -------------------------------------------------------------------------------- /tests/fixtures/coordinates.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: null 4 | headers: 5 | Accept: ['*/*'] 6 | Accept-Encoding: ['gzip, deflate'] 7 | Connection: [keep-alive] 8 | User-Agent: [python-requests/2.18.4] 9 | method: GET 10 | uri: https://geocoding.geo.census.gov/geocoder/geographies/coordinates?format=json&y=43&x=-74&vintage=Current_Current&benchmark=Public_AR_Current 11 | response: 12 | body: {string: '{"result":{"input":{"location":{"x":-74.0,"y":43.0},"vintage":{"id":"4","vintageName":"Current_Current","isDefault":true,"vintageDescription":"Current 13 | Vintage - Current Benchmark"},"benchmark":{"id":"4","isDefault":false,"benchmarkName":"Public_AR_Current","benchmarkDescription":"Public 14 | Address Ranges - Current Benchmark"}},"geographies":{"Counties":[{"OID":27590724407683,"STATE":"36","FUNCSTAT":"A","AREAWATER":87571838,"NAME":"Saratoga 15 | County","LSADC":"06","CENTLON":"-073.8636885","BASENAME":"Saratoga","INTPTLAT":"+43.1061353","COUNTYCC":"H1","MTFCC":"G4020","COUNTY":"091","GEOID":"36091","CENTLAT":"+43.1071327","INTPTLON":"-073.8553872","AREALAND":2097880370,"COUNTYNS":"00974143","OBJECTID":167}],"Census 16 | Tracts":[{"OID":20790725018479,"STATE":"36","FUNCSTAT":"S","NAME":"Census 17 | Tract 615","AREAWATER":3056729,"LSADC":"CT","CENTLON":"-074.0308806","BASENAME":"615","INTPTLAT":"+43.0321923","MTFCC":"G5020","COUNTY":"091","GEOID":"36091061500","CENTLAT":"+43.0293385","INTPTLON":"-074.0320790","AREALAND":113504704,"OBJECTID":6756,"TRACT":"061500"}],"2010 18 | Census Blocks":[{"BLKGRP":"2","OID":210403977442765,"FUNCSTAT":"S","STATE":"36","AREAWATER":43363,"NAME":"Block 19 | 2076","SUFFIX":"","LSADC":"BK","CENTLON":"-073.9972945","LWBLKTYP":"B","BASENAME":"2076","BLOCK":"2076","INTPTLAT":"+43.0050138","MTFCC":"G5040","COUNTY":"091","GEOID":"360910615002076","CENTLAT":"+43.0049410","INTPTLON":"-073.9972405","AREALAND":2071885,"OBJECTID":8494926,"TRACT":"061500"}],"States":[{"OID":27490100833860,"STATE":"36","FUNCSTAT":"A","NAME":"New 20 | York","AREAWATER":19247151848,"LSADC":"00","CENTLON":"-075.5942811","STUSAB":"NY","BASENAME":"New 21 | York","INTPTLAT":"+42.9133974","DIVISION":"2","MTFCC":"G4000","STATENS":"01779796","GEOID":"36","CENTLAT":"+42.9197932","INTPTLON":"-075.5962723","REGION":"1","AREALAND":122048992746,"OBJECTID":39}]}}}'} 22 | headers: 23 | Cache-Control: [private, 'no-cache, no-store, max-age=0'] 24 | Content-Language: [en-US] 25 | Content-Type: [application/json] 26 | Date: ['Fri, 10 Nov 2017 18:15:11 GMT'] 27 | Expires: ['Wed, 31 Dec 1969 23:59:59 GMT'] 28 | Pragma: [no-cache] 29 | Strict-Transport-Security: [max-age=31536000] 30 | Vary: [Origin] 31 | X-Frame-Options: [Deny] 32 | status: {code: 200, message: OK} 33 | version: 1 34 | -------------------------------------------------------------------------------- /tests/fixtures/address-geographies.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: null 4 | headers: 5 | Accept: ['*/*'] 6 | Accept-Encoding: ['gzip, deflate'] 7 | Connection: [keep-alive] 8 | User-Agent: [python-requests/2.18.4] 9 | method: GET 10 | uri: https://geocoding.geo.census.gov/geocoder/geographies/address?city=Washington&zip=20500&format=json&state=DC&street=1600+Pennsylvania+Avenue+NW&vintage=Current_Current&benchmark=Public_AR_Current 11 | response: 12 | body: {string: !!python/unicode '{"result":{"input":{"address":{"street":"1600 13 | Pennsylvania Avenue NW","zip":"20500","city":"Washington","state":"DC"},"benchmark":{"benchmarkDescription":"Public 14 | Address Ranges - Current Benchmark","isDefault":false,"benchmarkName":"Public_AR_Current","id":"4"},"vintage":{"vintageDescription":"Current 15 | Vintage - Current Benchmark","isDefault":true,"vintageName":"Current_Current","id":"4"}},"addressMatches":[{"tigerLine":{"tigerLineId":"76225813","side":"L"},"geographies":{"Counties":[{"OID":27590331264532,"STATE":"11","FUNCSTAT":"F","AREAWATER":18675956,"NAME":"District 16 | of Columbia","LSADC":"00","CENTLON":"-077.0162863","BASENAME":"District of 17 | Columbia","INTPTLAT":"+38.9041031","COUNTYCC":"H6","MTFCC":"G4020","COUNTY":"001","GEOID":"11001","CENTLAT":"+38.9047577","INTPTLON":"-077.0172290","AREALAND":158351639,"COUNTYNS":"01702382","OBJECTID":632}],"Census 18 | Tracts":[{"OID":20790331304119,"STATE":"11","FUNCSTAT":"S","NAME":"Census 19 | Tract 62.02","AREAWATER":4970897,"LSADC":"CT","CENTLON":"-077.0352173","BASENAME":"62.02","INTPTLAT":"+38.8809933","MTFCC":"G5020","COUNTY":"001","GEOID":"11001006202","CENTLAT":"+38.8801546","INTPTLON":"-077.0363219","AREALAND":6539774,"OBJECTID":25956,"TRACT":"006202"}],"2010 20 | Census Blocks":[{"BLKGRP":"1","OID":210403964788146,"FUNCSTAT":"S","STATE":"11","AREAWATER":0,"NAME":"Block 21 | 1031","SUFFIX":"","LSADC":"BK","CENTLON":"-077.0365336","LWBLKTYP":"L","BASENAME":"1031","BLOCK":"1031","INTPTLAT":"+38.8971157","MTFCC":"G5040","COUNTY":"001","GEOID":"110010062021031","CENTLAT":"+38.8971157","INTPTLON":"-077.0365336","AREALAND":91475,"OBJECTID":953677,"TRACT":"006202"}],"States":[{"OID":27490331294090,"STATE":"11","FUNCSTAT":"A","NAME":"District 22 | of Columbia","AREAWATER":18675956,"LSADC":"00","CENTLON":"-077.0162863","STUSAB":"DC","BASENAME":"District 23 | of Columbia","INTPTLAT":"+38.9041031","DIVISION":"5","MTFCC":"G4000","STATENS":"01702382","GEOID":"11","CENTLAT":"+38.9047577","INTPTLON":"-077.0172290","REGION":"3","AREALAND":158351639,"OBJECTID":54}]},"matchedAddress":"1600 24 | PENNSYLVANIA AVE NW, WASHINGTON, DC, 20502","coordinates":{"x":-77.03535,"y":38.898754},"addressComponents":{"zip":"20502","city":"WASHINGTON","state":"DC","preDirection":"","preType":"","streetName":"PENNSYLVANIA","suffixType":"AVE","suffixDirection":"NW","suffixQualifier":"","fromAddress":"1600","toAddress":"1698","preQualifier":""}}]}}'} 25 | headers: 26 | cache-control: [private, 'no-cache, no-store, max-age=0'] 27 | content-language: [en-US] 28 | content-type: [application/json] 29 | date: ['Tue, 31 Oct 2017 17:33:55 GMT'] 30 | expires: ['Wed, 31 Dec 1969 23:59:59 GMT'] 31 | pragma: [no-cache] 32 | strict-transport-security: [max-age=31536000] 33 | vary: [Origin] 34 | x-frame-options: [Deny] 35 | status: {code: 200, message: OK} 36 | version: 1 37 | -------------------------------------------------------------------------------- /src/censusgeocode/__main__.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2015-7 Neil Freeman 2 | 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | """Command-line interface for censusgeocode""" 16 | import argparse 17 | import csv 18 | import io 19 | import sys 20 | 21 | from . import __version__ 22 | from .censusgeocode import DEFAULT_BENCHMARK, DEFAULT_VINTAGE, CensusGeocode 23 | 24 | 25 | def main(): 26 | """Command-line interface for censusgeocode""" 27 | parser = argparse.ArgumentParser("censusgeocode", description="Command-line interface for the Census Geocoding API") 28 | 29 | parser.add_argument("-v", "--version", action="version", version="%(prog)s v" + __version__) 30 | parser.add_argument("address", type=str, nargs="?", default=None) 31 | parser.add_argument( 32 | "--csv", 33 | type=str, 34 | help=( 35 | "comma-delimited file of addresses. No header. Must have the following columns: id, street address, city, state, zip. " 36 | "The id must be a unique. Read from stdin with -" 37 | ), 38 | ) 39 | parser.add_argument( 40 | "--rettype", 41 | choices=["locations", "geographies"], 42 | default="locations", 43 | help=( 44 | "Query type. Geographies will return state, county, tract, and block code in addition to TIGER/Line info and " 45 | "latitude and longitude. For use with --csv" 46 | ), 47 | ) 48 | parser.add_argument( 49 | "--benchmark", 50 | default=DEFAULT_BENCHMARK, 51 | help="Version of the locator to query. See Census documentation for options.", 52 | ) 53 | parser.add_argument( 54 | "--vintage", 55 | default=DEFAULT_VINTAGE, 56 | help="Geography version query. See Census documentation for options.", 57 | ) 58 | parser.add_argument( 59 | "--timeout", 60 | metavar="SECONDS", 61 | type=int, 62 | default=12, 63 | help="Request timeout [default: 12]", 64 | ) 65 | 66 | args = parser.parse_args() 67 | cg = CensusGeocode(benchmark=args.benchmark, vintage=args.vintage) 68 | 69 | if args.address: 70 | result = cg.onelineaddress(args.address, returntype=args.rettype, timeout=args.timeout) 71 | 72 | try: 73 | print("{},{}".format(result[0]["coordinates"]["x"], result[0]["coordinates"]["y"])) 74 | 75 | except IndexError: 76 | print("Address not found: {}".format(args.address), file=sys.stderr) 77 | sys.exit(1) 78 | 79 | elif args.csv: 80 | if args.csv == "-": 81 | # No streaming here - consume the entirety of stdin. 82 | infile = io.StringIO() 83 | csv.writer(infile).writerows(csv.reader(sys.stdin)) 84 | infile.seek(0) 85 | 86 | else: 87 | infile = args.csv 88 | 89 | result = cg.addressbatch(infile, returntype=args.rettype, timeout=args.timeout) 90 | 91 | fieldnames = cg.batchfields[args.rettype] + ["lat", "lon"] 92 | fieldnames.pop(fieldnames.index("coordinate")) 93 | writer = csv.DictWriter(sys.stdout, fieldnames=fieldnames) 94 | writer.writeheader() 95 | writer.writerows(result) 96 | 97 | else: 98 | print("Address or csv file required", file=sys.stderr) 99 | sys.exit(1) 100 | 101 | 102 | if __name__ == "__main__": 103 | main() 104 | -------------------------------------------------------------------------------- /tests/fixtures/address-batch.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: !!python/object/new:_io.BytesIO 4 | state: !!python/tuple 5 | - !!binary | 6 | LS01NzZjOWMxMmVjMmM0ODZiOWNkOTk0ZWQyYjllZTYzMQ0KQ29udGVudC1EaXNwb3NpdGlvbjog 7 | Zm9ybS1kYXRhOyBuYW1lPSJhZGRyZXNzRmlsZSI7IGZpbGVuYW1lPSJiYXRjaC5jc3YiDQpDb250 8 | ZW50LVR5cGU6IHRleHQvcGxhaW4NCg0KMSw0NjAwIFNpbHZlciBIaWxsIFJkLFNVSVRMQU5ELE1E 9 | LDIwNzQ2CjIsNzkgV2lzdGZ1bCBWaXN0YSxXaXN0ZnVsIFZpc3RhLElMLAozLDMgR3JhbWVyY3kg 10 | UGFyayBXZXN0LE5ldyBZb3JrLE5ZLDEwMDAzCg0KLS01NzZjOWMxMmVjMmM0ODZiOWNkOTk0ZWQy 11 | YjllZTYzMQ0KQ29udGVudC1EaXNwb3NpdGlvbjogZm9ybS1kYXRhOyBuYW1lPSJiZW5jaG1hcmsi 12 | DQoNClB1YmxpY19BUl9DdXJyZW50DQotLTU3NmM5YzEyZWMyYzQ4NmI5Y2Q5OTRlZDJiOWVlNjMx 13 | DQpDb250ZW50LURpc3Bvc2l0aW9uOiBmb3JtLWRhdGE7IG5hbWU9InZpbnRhZ2UiDQoNCkN1cnJl 14 | bnRfQ3VycmVudA0KLS01NzZjOWMxMmVjMmM0ODZiOWNkOTk0ZWQyYjllZTYzMS0tDQo= 15 | - 0 16 | - null 17 | headers: 18 | Accept: ['*/*'] 19 | Accept-Encoding: ['gzip, deflate'] 20 | Connection: [keep-alive] 21 | Content-Length: ['506'] 22 | Content-Type: [multipart/form-data; boundary=576c9c12ec2c486b9cd994ed2b9ee631] 23 | User-Agent: [python-requests/2.18.4] 24 | method: POST 25 | uri: https://geocoding.geo.census.gov/geocoder/locations/addressbatch 26 | response: 27 | body: {string: '"3","3 Gramercy Park West, New York, NY, 10003","Match","Exact","3 28 | GRAMERCY PARK W, NEW YORK, NY, 10003","-73.98658,40.738323","59653655","R" 29 | 30 | "2","79 Wistful Vista, Wistful Vista, IL, ","No_Match" 31 | 32 | "1","4600 Silver Hill Rd, SUITLAND, MD, 20746","No_Match" 33 | 34 | '} 35 | headers: 36 | Cache-Control: [private] 37 | Content-Disposition: [attachment; filename=GeocodeResults.csv] 38 | Content-Length: ['255'] 39 | Content-Type: [text/plain] 40 | Date: ['Fri, 10 Nov 2017 18:13:26 GMT'] 41 | Set-Cookie: [JSESSIONID=SQ2nIvRj-q5PkMFSIVGlCEM3mho0AsbuywRpQQzT-amZk7maqJs5!-1243150265; 42 | path=/; secure; HttpOnly] 43 | Strict-Transport-Security: [max-age=31536000] 44 | Vary: [Origin] 45 | X-Frame-Options: [Deny] 46 | status: {code: 200, message: OK} 47 | - request: 48 | body: !!python/object/new:_io.BytesIO 49 | state: !!python/tuple 50 | - !!binary | 51 | LS0yYzEyZDI1ZjEyMGY0ZDA4ODNlZmVmMDAwZjUxN2IxZg0KQ29udGVudC1EaXNwb3NpdGlvbjog 52 | Zm9ybS1kYXRhOyBuYW1lPSJhZGRyZXNzRmlsZSI7IGZpbGVuYW1lPSJiYXRjaC5jc3YiDQpDb250 53 | ZW50LVR5cGU6IHRleHQvcGxhaW4NCg0KMSw0NjAwIFNpbHZlciBIaWxsIFJkLFNVSVRMQU5ELE1E 54 | LDIwNzQ2CjIsNzkgV2lzdGZ1bCBWaXN0YSxXaXN0ZnVsIFZpc3RhLElMLAozLDMgR3JhbWVyY3kg 55 | UGFyayBXZXN0LE5ldyBZb3JrLE5ZLDEwMDAzCg0KLS0yYzEyZDI1ZjEyMGY0ZDA4ODNlZmVmMDAw 56 | ZjUxN2IxZg0KQ29udGVudC1EaXNwb3NpdGlvbjogZm9ybS1kYXRhOyBuYW1lPSJiZW5jaG1hcmsi 57 | DQoNClB1YmxpY19BUl9DdXJyZW50DQotLTJjMTJkMjVmMTIwZjRkMDg4M2VmZWYwMDBmNTE3YjFm 58 | DQpDb250ZW50LURpc3Bvc2l0aW9uOiBmb3JtLWRhdGE7IG5hbWU9InZpbnRhZ2UiDQoNCkN1cnJl 59 | bnRfQ3VycmVudA0KLS0yYzEyZDI1ZjEyMGY0ZDA4ODNlZmVmMDAwZjUxN2IxZi0tDQo= 60 | - 0 61 | - null 62 | headers: 63 | Accept: ['*/*'] 64 | Accept-Encoding: ['gzip, deflate'] 65 | Connection: [keep-alive] 66 | Content-Length: ['506'] 67 | Content-Type: [multipart/form-data; boundary=2c12d25f120f4d0883efef000f517b1f] 68 | User-Agent: [python-requests/2.18.4] 69 | method: POST 70 | uri: https://geocoding.geo.census.gov/geocoder/geographies/addressbatch 71 | response: 72 | body: {string: '"3","3 Gramercy Park West, New York, NY, 10003","Match","Exact","3 73 | GRAMERCY PARK W, NEW YORK, NY, 10003","-73.98658,40.738323","59653655","R","36","061","005000","1002" 74 | 75 | "2","79 Wistful Vista, Wistful Vista, IL, ","No_Match" 76 | 77 | "1","4600 Silver Hill Rd, SUITLAND, MD, 20746","No_Match" 78 | 79 | '} 80 | headers: 81 | Cache-Control: [private] 82 | Content-Disposition: [attachment; filename=GeocodeResults.csv] 83 | Content-Length: ['282'] 84 | Content-Type: [text/plain] 85 | Date: ['Fri, 10 Nov 2017 18:13:27 GMT'] 86 | Set-Cookie: [JSESSIONID=giKnIvaVJfjtB_KkqiNADRZQfDFTKcI8opBFMnOrXFiw0T6SsNif!2023320970; 87 | path=/; secure; HttpOnly] 88 | Strict-Transport-Security: [max-age=31536000] 89 | Vary: [Origin] 90 | X-Frame-Options: [Deny] 91 | status: {code: 200, message: OK} 92 | version: 1 93 | -------------------------------------------------------------------------------- /tests/test_censusgeocode.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | """Tests for censusgeocode""" 3 | # This file is part of censusgeocode. 4 | # https://github.com/fitnr/censusgeocode 5 | 6 | # Licensed under the General Public License (version 3) 7 | # http://opensource.org/licenses/LGPL-3.0 8 | # Copyright (c) 2015-7, Neil Freeman 9 | 10 | import unittest 11 | import vcr 12 | import warnings 13 | 14 | from censusgeocode import CensusGeocode 15 | from censusgeocode.censusgeocode import AddressResult, GeographyResult 16 | 17 | 18 | class CensusGeoCodeTestCase(unittest.TestCase): 19 | 20 | cg = None 21 | 22 | def setUp(self): 23 | self.cg = CensusGeocode() 24 | 25 | @vcr.use_cassette('tests/fixtures/coordinates.yaml') 26 | def test_returns_geo(self): 27 | results = self.cg.coordinates(-74, 43, returntype='geographies') 28 | assert isinstance(results, GeographyResult) 29 | assert results.input 30 | 31 | @vcr.use_cassette('tests/fixtures/coordinates.yaml') 32 | def test_coords(self): 33 | results = self.cg.coordinates(-74, 43) 34 | assert results['Counties'][0]['BASENAME'] == 'Saratoga' 35 | assert results['Counties'][0]['GEOID'] == '36091' 36 | assert results['Census Tracts'][0]['BASENAME'] == "615" 37 | 38 | def test_url(self): 39 | r = self.cg._geturl('coordinates', 'geographies') 40 | assert r == 'https://geocoding.geo.census.gov/geocoder/geographies/coordinates' 41 | 42 | @vcr.use_cassette('tests/fixtures/address-geographies.yaml') 43 | def test_address_zipcode(self): 44 | results = self.cg.address('1600 Pennsylvania Avenue NW', city='Washington', state='DC', zipcode='20500') 45 | assert results[0] 46 | assert results[0]['geographies']['Counties'][0]['BASENAME'] == 'District of Columbia' 47 | 48 | @vcr.use_cassette('tests/fixtures/address-geographies.yaml') 49 | def test_address_zip(self): 50 | results = self.cg.address('1600 Pennsylvania Avenue NW', city='Washington', state='DC', zip='20500') 51 | assert results[0] 52 | assert results[0]['geographies']['Counties'][0]['BASENAME'] == 'District of Columbia' 53 | 54 | @vcr.use_cassette('tests/fixtures/onelineaddress.yaml') 55 | def test_onelineaddress(self): 56 | results = self.cg.onelineaddress('1600 Pennsylvania Avenue NW, Washington, DC, 20500', layers='all') 57 | assert results[0] 58 | try: 59 | assert results[0]['geographies']['Counties'][0]['BASENAME'] == 'District of Columbia' 60 | except AssertionError: 61 | print(results[0]['geographies']['Counties'][0]) 62 | raise 63 | 64 | assert 'Metropolitan Divisions' in results[0]['geographies'].keys() 65 | assert 'Alaska Native Village Statistical Areas' in results[0]['geographies'].keys() 66 | 67 | @vcr.use_cassette('tests/fixtures/address-locations.yaml') 68 | def test_address_return_type(self): 69 | results = self.cg.address('1600 Pennsylvania Avenue NW', city='Washington', state='DC', zipcode='20500', returntype='locations') 70 | 71 | assert results[0]['matchedAddress'].upper() == '1600 PENNSYLVANIA AVE NW, WASHINGTON, DC, 20502' 72 | assert results[0]['addressComponents']['streetName'] == 'PENNSYLVANIA' 73 | 74 | @vcr.use_cassette('tests/fixtures/test_benchmark_vintage.yaml') 75 | def test_benchmark_vintage(self): 76 | """Initializing CensuGeocode with benchmark and vintage keywords works""" 77 | bmark, vint = 'Public_AR_Census2020', 'Census2020_Current' 78 | 79 | cg = CensusGeocode(benchmark=bmark, vintage=vint) 80 | result = cg.address('1600 Pennsylvania Avenue NW', city='Washington', state='DC', zipcode='20500', returntype='geographies') 81 | 82 | self.assertEqual(result.input['benchmark']['benchmarkName'], bmark) 83 | self.assertEqual(result.input['vintage']['vintageName'], vint) 84 | self.assertEqual(result[0]['geographies']['Census Tracts'][0]['GEOID'], '11001006202') 85 | 86 | @vcr.use_cassette('tests/fixtures/address-batch.yaml') 87 | def test_addressbatch(self): 88 | """batch() function works""" 89 | result = self.cg.addressbatch('tests/fixtures/batch.csv', returntype='locations') 90 | assert isinstance(result, list) 91 | resultdict = {int(r['id']): r for r in result} 92 | assert resultdict[3]['parsed'] == '3 GRAMERCY PARK W, NEW YORK, NY, 10003' 93 | assert resultdict[2]['match'] is False 94 | 95 | result = self.cg.addressbatch('tests/fixtures/batch.csv', returntype='geographies') 96 | assert isinstance(result, list) 97 | resultdict = {int(r['id']): r for r in result} 98 | assert resultdict[3]['tigerlineid'] == '59653655' 99 | assert resultdict[3]['statefp'] == '36' 100 | assert resultdict[2]['match'] is False 101 | 102 | def test_warning10k(self): 103 | """Sending more than 10,000 records to batch raises a warning""" 104 | warnings.simplefilter("error") 105 | data = ({} for _ in range(10001)) 106 | result = [] 107 | with self.assertRaises(UserWarning, msg="Get a warning when sending more than 10k rows to batch()"): 108 | result = self.cg.addressbatch(data) 109 | self.assertEqual(result, [], "Result is empty") 110 | -------------------------------------------------------------------------------- /tests/fixtures/test_benchmark_vintage.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: null 4 | headers: 5 | Accept: ['*/*'] 6 | Accept-Encoding: ['gzip, deflate'] 7 | Connection: [keep-alive] 8 | User-Agent: [python-requests/2.18.4] 9 | method: GET 10 | uri: https://geocoding.geo.census.gov/geocoder/geographies/address?vintage=Census2020_Current&street=1600+Pennsylvania+Avenue+NW&state=DC&zip=20500&format=json&benchmark=Public_AR_Census2020&city=Washington 11 | response: 12 | body: {string: '{"result":{"input":{"address":{"state":"DC","street":"1600 Pennsylvania 13 | Avenue NW","zip":"20500","city":"Washington"},"benchmark":{"id":"9","isDefault":false,"benchmarkName":"Public_AR_Census2020","benchmarkDescription":"Public 14 | Address Ranges - Census 2010 Benchmark"},"vintage":{"id":"910","isDefault":true,"vintageName":"Census2020_Current","vintageDescription":"Census2010 15 | Vintage - Census2010 Benchmark"}},"addressMatches":[{"geographies":{"Census 16 | Blocks":[{"BLKGRP":"1","UR":"","OID":210403964787808,"FUNCSTAT":"S","STATE":"11","AREAWATER":0,"NAME":"Block 17 | 1036","SUFFIX":"","LSADC":"BK","CENTLON":"-077.0387315","HU100":0,"LWBLKTYP":"L","BLOCK":"1036","BASENAME":"1036","INTPTLAT":"+38.8975764","POP100":0,"MTFCC":"G5040","COUNTY":"001","GEOID":"110010062021036","CENTLAT":"+38.8975764","INTPTLON":"-077.0387315","AREALAND":33422,"OBJECTID":1734550,"TRACT":"006202"}],"Counties":[{"UR":"","OID":27590331264532,"STATE":"11","FUNCSTAT":"F","AREAWATER":18884970,"NAME":"District 18 | of Columbia","LSADC":"00","HU100":296719,"CENTLON":"-077.0162725","BASENAME":"District 19 | of Columbia","INTPTLAT":"+38.9041485","COUNTYCC":"H6","POP100":601723,"MTFCC":"G4020","COUNTY":"001","GEOID":"11001","CENTLAT":"+38.9047564","INTPTLON":"-077.0170942","AREALAND":158114680,"COUNTYNS":"01702382","OBJECTID":1879}],"Census 20 | Tracts":[{"UR":"","OID":20790331304119,"STATE":"11","FUNCSTAT":"S","AREAWATER":4835490,"NAME":"Census 21 | Tract 62.02","LSADC":"CT","CENTLON":"-077.0353820","HU100":8,"BASENAME":"62.02","INTPTLAT":"+38.8810025","POP100":33,"MTFCC":"G5020","COUNTY":"001","GEOID":"11001006202","CENTLAT":"+38.8805263","INTPTLON":"-077.0363001","AREALAND":6583173,"OBJECTID":13964,"TRACT":"006202"}],"States":[{"OID":27490331294090,"UR":"","STATE":"11","FUNCSTAT":"A","NAME":"District 22 | of Columbia","AREAWATER":18884970,"LSADC":"00","HU100":296719,"CENTLON":"-077.0162725","STUSAB":"DC","BASENAME":"District 23 | of Columbia","INTPTLAT":"+38.9041485","POP100":601723,"DIVISION":"5","MTFCC":"G4000","STATENS":"01702382","GEOID":"11","CENTLAT":"+38.9047564","INTPTLON":"-077.0170942","REGION":"3","AREALAND":158114680,"OBJECTID":47}]},"matchedAddress":"1600 24 | Pennsylvania Ave NW, WASHINGTON, DC, 20037","coordinates":{"x":-77.038025,"y":38.898735},"tigerLine":{"tigerLineId":"76225806","side":"L"},"addressComponents":{"fromAddress":"1600","toAddress":"1698","preQualifier":"","preDirection":"","preType":"","streetName":"Pennsylvania","suffixType":"Ave","suffixDirection":"NW","suffixQualifier":"","state":"DC","zip":"20037","city":"WASHINGTON"}},{"geographies":{"Census 25 | Blocks":[{"BLKGRP":"1","UR":"","OID":210403964788146,"FUNCSTAT":"S","STATE":"11","AREAWATER":0,"NAME":"Block 26 | 1031","SUFFIX":"","LSADC":"BK","CENTLON":"-077.0365312","HU100":1,"LWBLKTYP":"L","BLOCK":"1031","BASENAME":"1031","INTPTLAT":"+38.8971175","POP100":5,"MTFCC":"G5040","COUNTY":"001","GEOID":"110010062021031","CENTLAT":"+38.8971175","INTPTLON":"-077.0365312","AREALAND":91321,"OBJECTID":1731109,"TRACT":"006202"}],"Counties":[{"UR":"","OID":27590331264532,"STATE":"11","FUNCSTAT":"F","AREAWATER":18884970,"NAME":"District 27 | of Columbia","LSADC":"00","HU100":296719,"CENTLON":"-077.0162725","BASENAME":"District 28 | of Columbia","INTPTLAT":"+38.9041485","COUNTYCC":"H6","POP100":601723,"MTFCC":"G4020","COUNTY":"001","GEOID":"11001","CENTLAT":"+38.9047564","INTPTLON":"-077.0170942","AREALAND":158114680,"COUNTYNS":"01702382","OBJECTID":1879}],"Census 29 | Tracts":[{"UR":"","OID":20790331304119,"STATE":"11","FUNCSTAT":"S","AREAWATER":4835490,"NAME":"Census 30 | Tract 62.02","LSADC":"CT","CENTLON":"-077.0353820","HU100":8,"BASENAME":"62.02","INTPTLAT":"+38.8810025","POP100":33,"MTFCC":"G5020","COUNTY":"001","GEOID":"11001006202","CENTLAT":"+38.8805263","INTPTLON":"-077.0363001","AREALAND":6583173,"OBJECTID":13964,"TRACT":"006202"}],"States":[{"OID":27490331294090,"UR":"","STATE":"11","FUNCSTAT":"A","NAME":"District 31 | of Columbia","AREAWATER":18884970,"LSADC":"00","HU100":296719,"CENTLON":"-077.0162725","STUSAB":"DC","BASENAME":"District 32 | of Columbia","INTPTLAT":"+38.9041485","POP100":601723,"DIVISION":"5","MTFCC":"G4000","STATENS":"01702382","GEOID":"11","CENTLAT":"+38.9047564","INTPTLON":"-077.0170942","REGION":"3","AREALAND":158114680,"OBJECTID":47}]},"matchedAddress":"1600 33 | Pennsylvania Ave NW, WASHINGTON, DC, 20502","coordinates":{"x":-77.036385,"y":38.898735},"tigerLine":{"tigerLineId":"76225813","side":"L"},"addressComponents":{"fromAddress":"1522","toAddress":"1698","preQualifier":"","preDirection":"","preType":"","streetName":"Pennsylvania","suffixType":"Ave","suffixDirection":"NW","suffixQualifier":"","state":"DC","zip":"20502","city":"WASHINGTON"}}]}}'} 34 | headers: 35 | Cache-Control: [private, 'no-cache, no-store, max-age=0'] 36 | Content-Language: [en-US] 37 | Content-Type: [application/json] 38 | Date: ['Fri, 10 Nov 2017 20:24:29 GMT'] 39 | Expires: ['Thu, 01 Jan 1970 00:00:00 GMT'] 40 | Pragma: [no-cache] 41 | Strict-Transport-Security: [max-age=31536000] 42 | Vary: [Origin] 43 | X-Frame-Options: [Deny] 44 | status: {code: 200, message: OK} 45 | version: 1 46 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Census Geocode 2 | -------------- 3 | 4 | Census Geocode is a light weight Python wrapper for the US Census [Geocoder API](http://geocoding.geo.census.gov/geocoder/), compatible with Python 3. It comes packaged with a simple command line tool for geocoding an address to a longitude and latitude, or a batch file into a parsed address and coordinates. 5 | 6 | It's strongly recommended to review the [Census Geocoder docs](https://www.census.gov/programs-surveys/geography/technical-documentation/complete-technical-documentation/census-geocoder.html) before using this module. 7 | 8 | Basic example: 9 | 10 | ```python 11 | import censusgeocode as cg 12 | 13 | cg.coordinates(x=-76, y=41) 14 | cg.onelineaddress('1600 Pennsylvania Avenue, Washington, DC') 15 | cg.address('1600 Pennsylvania Avenue', city='Washington', state='DC', zip='20006') 16 | cg.addressbatch('data/addresses.csv') 17 | ``` 18 | 19 | Use the returntype keyword to specify 'locations' or 'geographies'. 'Locations' yields structured information about the address, and 'geographies' yields information about the Census geographies. Geographies is the default. 20 | ```python 21 | cg.onelineaddress('1600 Pennsylvania Avenue, Washington, DC', returntype='locations') 22 | ``` 23 | 24 | Queries return a CensusResult object, which is basically a Python list with an extra 'input' property, which the Census returns to tell you how they interpreted your request. 25 | 26 | ```python 27 | >>> result = cg.coordinates(x=-76, y=41) 28 | >>> result.input 29 | { 30 | u'vintage': { 31 | u'vintageName': u'Current_Current', 32 | u'id': u'4', 33 | u'vintageDescription': u'Current Vintage - Current Benchmark', 34 | u'isDefault': True 35 | }, 36 | u'benchmark': { 37 | u'benchmarkName': u'Public_AR_Current', 38 | u'id': u'4', 39 | u'isDefault': False, 40 | u'benchmarkDescription': u'Public Address Ranges - Current Benchmark' 41 | }, 42 | u'location': { 43 | u'y': 41.0, 44 | u'x': -76.0 45 | } 46 | } 47 | >>> result 48 | [{ 49 | '2010 Census Blocks': [{ 50 | 'AREALAND': 1409023, 51 | 'AREAWATER': 0, 52 | 'BASENAME': '1045', 53 | 'BLKGRP': '1', 54 | 'BLOCK': '1045', 55 | 'CENTLAT': '+40.9957436', 56 | 'CENTLON': '-076.0089338', 57 | 'COUNTY': '079', 58 | 'FUNCSTAT': 'S', 59 | 'GEOID': '420792166001045', 60 | 'INTPTLAT': '+40.9957436', 61 | 'INTPTLON': '-076.0089338', 62 | 'LSADC': 'BK', 63 | 'LWBLKTYP': 'L', 64 | 'MTFCC': 'G5040', 65 | 'NAME': 'Block 1045', 66 | 'OBJECTID': 9940449, 67 | 'OID': 210404020212114, 68 | 'STATE': '42', 69 | 'SUFFIX': '', 70 | 'TRACT': '216600' 71 | }], 72 | 'Census Tracts': [{ 73 | # snip 74 | 'NAME': 'Census Tract 2166', 75 | 'OBJECTID': 61245, 76 | 'OID': 20790277158250, 77 | 'STATE': '42', 78 | 'TRACT': '216600' 79 | }], 80 | 'Counties': [{ 81 | # snip 82 | 'NAME': 'Luzerne County', 83 | 'OBJECTID': 866, 84 | 'OID': 27590277115518, 85 | 'STATE': '42' 86 | }], 87 | 'States': [{ 88 | # snip 89 | 'NAME': 'Pennsylvania', 90 | 'REGION': '1', 91 | 'STATE': '42', 92 | 'STATENS': '01779798', 93 | 'STUSAB': 'PA' 94 | }] 95 | }] 96 | ``` 97 | 98 | ### Advanced 99 | 100 | By default, the geocoder uses the "Current" vintage and benchmarks. To use another vintage or benchmark, use the `CensusGeocode` class: 101 | ````python 102 | from censusgeocode import CensusGeocode 103 | cg = CensusGeocode(benchmark='Public_AR_Current', vintage='Census2020_Current') 104 | cg.onelineaddress(foobar) 105 | ```` 106 | 107 | The Census may update the available benchmarks and vintages. Review the Census Geocoder docs for the currently available [benchmarks](https://geocoding.geo.census.gov/geocoder/benchmarks) and [vintages](https://geocoding.geo.census.gov/geocoder/vintages?form). 108 | 109 | ## Command line tool 110 | 111 | The `censusgeocode` tool has two settings. 112 | 113 | At the simplest, it takes one argument, an address, and returns a comma-delimited longitude, latitude pair. 114 | ````bash 115 | censusgeocode '100 Fifth Avenue, New York, NY' 116 | -73.992195,40.73797 117 | 118 | censusgeocode '1600 Pennsylvania Avenue, Washington DC' 119 | -77.03535,38.898754 120 | ```` 121 | 122 | The Census geocoder is reasonably good at recognizing non-standard addresses. 123 | ````bash 124 | censusgeocode 'Hollywood & Vine, LA, CA' 125 | -118.32668,34.101624 126 | ```` 127 | 128 | It can also use the Census Geocoder's batch function to process an entire file. The file must be comma-delimited, have no header, and include the following columns: 129 | ```` 130 | unique id, street address, state, city, zip code 131 | ```` 132 | 133 | The geocoder can read from a file: 134 | ```` 135 | censusgeocode --csv tests/fixtures/batch.csv 136 | ```` 137 | ([example file](https://github.com/fitnr/censusgeocode/blob/master/tests/fixtures/batch.csv)) 138 | 139 | Or from stdin, using `-` as the filename: 140 | ```` 141 | head tests/fixtures/batch.csv | censusgeocode --csv - 142 | ```` 143 | 144 | According to the Census docs, the batch geocoder is limited to 10,000 rows. 145 | 146 | The output will be a CSV file (with a header) and the columns: 147 | * id 148 | * address 149 | * match 150 | * matchtype 151 | * parsed 152 | * tigerlineid 153 | * side 154 | * lat 155 | * lon 156 | 157 | If your data doesn't have a unique id, try adding line numbers with the Unix command line utility `nl`: 158 | ``` 159 | nl -s , input.csv | censusgeocode --csv - > output.csv 160 | ``` 161 | 162 | ## License 163 | 164 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 165 | 166 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 167 | 168 | You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. 169 | -------------------------------------------------------------------------------- /tests/fixtures/onelineaddress.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: null 4 | headers: 5 | Accept: ['*/*'] 6 | Accept-Encoding: ['gzip, deflate'] 7 | Connection: [keep-alive] 8 | User-Agent: [python-requests/2.12.4] 9 | method: GET 10 | uri: https://geocoding.geo.census.gov/geocoder/geographies/onelineaddress?layers=all&format=json&address=1600+Pennsylvania+Avenue+NW%2C+Washington%2C+DC%2C+20500&vintage=Current_Current&benchmark=Public_AR_Current 11 | response: 12 | body: {string: !!python/unicode '{"result":{"input":{"address":{"address":"1600 13 | Pennsylvania Avenue NW, Washington, DC, 20500"},"benchmark":{"benchmarkDescription":"Public 14 | Address Ranges - Current Benchmark","isDefault":false,"benchmarkName":"Public_AR_Current","id":"4"},"vintage":{"vintageDescription":"Current 15 | Vintage - Current Benchmark","isDefault":true,"vintageName":"Current_Current","id":"4"}},"addressMatches":[{"tigerLine":{"tigerLineId":"76225813","side":"L"},"geographies":{"Oklahoma 16 | Tribal Statistical Areas":[],"2010 Census Urbanized Areas":[{"UA":"92242","OID":27040158105937,"MTFCC":"G3500","FUNCSTAT":"S","AREAWATER":69323392,"NAME":"Washington, 17 | DC--VA--MD Urbanized Area","LSADC":"75","CENTLON":"-077.1895657","GEOID":"92242","CENTLAT":"+38.8969178","INTPTLON":"-077.1897402","AREALAND":3424072912,"BASENAME":"Washington, 18 | DC--VA--MD","INTPTLAT":"+38.8973945","OBJECTID":3036}],"Combined Statistical 19 | Areas":[{"OID":261904755925754,"FUNCSTAT":"S","NAME":"Washington-Baltimore-Arlington, 20 | DC-MD-VA-WV-PA CSA","AREAWATER":5208979324,"LSADC":"M0","CENTLON":"-077.1891619","BASENAME":"Washington-Baltimore-Arlington, 21 | DC-MD-VA-WV-PA","INTPTLAT":"+38.9943635","MTFCC":"G3100","CSA":"548","GEOID":"548","CENTLAT":"+38.9929959","INTPTLON":"-077.1890457","AREALAND":32712037570,"OBJECTID":45}],"Census 22 | Block Groups":[{"BLKGRP":"1","OID":20890331002852,"STATE":"11","FUNCSTAT":"S","AREAWATER":4970897,"NAME":"Block 23 | Group 1","LSADC":"BG","CENTLON":"-077.0352173","BASENAME":"1","INTPTLAT":"+38.8809933","MTFCC":"G5030","COUNTY":"001","GEOID":"110010062021","CENTLAT":"+38.8801546","INTPTLON":"-077.0363219","AREALAND":6539774,"OBJECTID":7630,"TRACT":"006202"}],"Elementary 24 | School Districts":[],"Metropolitan Divisions":[{"OID":263904755925788,"MTFCC":"G3120","FUNCSTAT":"S","AREAWATER":1070684553,"NAME":"Washington-Arlington-Alexandria, 25 | DC-VA-MD-WV Metro Division","CBSA":"47900","CSA":"548","LSADC":"M3","METDIV":"47894","CENTLON":"-077.4761875","GEOID":"4790047894","CENTLAT":"+38.7070832","INTPTLON":"-077.4752783","AREALAND":13192340035,"BASENAME":"Washington-Arlington-Alexandria, 26 | DC-VA-MD-WV","INTPTLAT":"+38.7110726","OBJECTID":29}],"Federal American Indian 27 | Reservations":[],"Census Tracts":[{"OID":20790331304119,"STATE":"11","FUNCSTAT":"S","NAME":"Census 28 | Tract 62.02","AREAWATER":4970897,"LSADC":"CT","CENTLON":"-077.0352173","BASENAME":"62.02","INTPTLAT":"+38.8809933","MTFCC":"G5020","COUNTY":"001","GEOID":"11001006202","CENTLAT":"+38.8801546","INTPTLON":"-077.0363219","AREALAND":6539774,"OBJECTID":25956,"TRACT":"006202"}],"115th 29 | Congressional Districts":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 30 | Failed to return"}],"Census Divisions":[{"status":"Layer query encountered 31 | an error: java.lang.RuntimeException: Failed to return"}],"Census Designated 32 | Places":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 33 | Failed to return"}],"Consolidated Cities":[{"status":"Layer query encountered 34 | an error: java.lang.RuntimeException: Failed to return"}],"Tribal Block Groups":[{"status":"Layer 35 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"2010 36 | Census Public Use Microdata Areas":[{"status":"Layer query encountered an 37 | error: java.lang.RuntimeException: Failed to return"}],"Micropolitan New England 38 | City and Town Areas":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 39 | Failed to return"}],"Census Regions":[{"status":"Layer query encountered an 40 | error: java.lang.RuntimeException: Failed to return"}],"Metropolitan New England 41 | City and Town Areas":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 42 | Failed to return"}],"Estates":[{"status":"Layer query encountered an error: 43 | java.lang.RuntimeException: Failed to return"}],"Hawaiian Home Lands":[{"status":"Layer 44 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"Incorporated 45 | Places":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 46 | Failed to return"}],"Micropolitan Statistical Areas":[{"status":"Layer query 47 | encountered an error: java.lang.RuntimeException: Failed to return"}],"Counties":[{"OID":27590331264532,"STATE":"11","FUNCSTAT":"F","AREAWATER":18675956,"NAME":"District 48 | of Columbia","LSADC":"00","CENTLON":"-077.0162863","BASENAME":"District of 49 | Columbia","INTPTLAT":"+38.9041031","COUNTYCC":"H6","MTFCC":"G4020","COUNTY":"001","GEOID":"11001","CENTLAT":"+38.9047577","INTPTLON":"-077.0172290","AREALAND":158351639,"COUNTYNS":"01702382","OBJECTID":632}],"Secondary 50 | School Districts":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 51 | Failed to return"}],"Alaska Native Regional Corporations":[{"status":"Layer 52 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"Tribal 53 | Census Tracts":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 54 | Failed to return"}],"Combined New England City and Town Areas":[{"status":"Layer 55 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"States":[{"OID":27490331294090,"STATE":"11","FUNCSTAT":"A","NAME":"District 56 | of Columbia","AREAWATER":18675956,"LSADC":"00","CENTLON":"-077.0162863","STUSAB":"DC","BASENAME":"District 57 | of Columbia","INTPTLAT":"+38.9041031","DIVISION":"5","MTFCC":"G4000","STATENS":"01702382","GEOID":"11","CENTLAT":"+38.9047577","INTPTLON":"-077.0172290","REGION":"3","AREALAND":158351639,"OBJECTID":54}],"2010 58 | Census ZIP Code Tabulation Areas":[{"status":"Layer query encountered an error: 59 | java.lang.RuntimeException: Failed to return"}],"2010 Census Urban Clusters":[{"status":"Layer 60 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"Tribal 61 | Subdivisions":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 62 | Failed to return"}],"New England City and Town Area Divisions":[{"status":"Layer 63 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"Subbarrios":[{"status":"Layer 64 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"2016 65 | State Legislative Districts - Upper":[{"status":"Layer query encountered an 66 | error: java.lang.RuntimeException: Failed to return"}],"Metropolitan Statistical 67 | Areas":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 68 | Failed to return"}],"2016 State Legislative Districts - Lower":[{"status":"Layer 69 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"State 70 | American Indian Reservations":[{"status":"Layer query encountered an error: 71 | java.lang.RuntimeException: Failed to return"}],"Tribal Designated Statistical 72 | Areas":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 73 | Failed to return"}],"State Designated Tribal Statistical Areas":[{"status":"Layer 74 | query encountered an error: java.lang.RuntimeException: Failed to return"}],"2010 75 | Census Blocks":[{"BLKGRP":"1","OID":210403964788146,"FUNCSTAT":"S","STATE":"11","AREAWATER":0,"NAME":"Block 76 | 1031","SUFFIX":"","LSADC":"BK","CENTLON":"-077.0365336","LWBLKTYP":"L","BASENAME":"1031","BLOCK":"1031","INTPTLAT":"+38.8971157","MTFCC":"G5040","COUNTY":"001","GEOID":"110010062021031","CENTLAT":"+38.8971157","INTPTLON":"-077.0365336","AREALAND":91475,"OBJECTID":953677,"TRACT":"006202"}],"Unified 77 | School Districts":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 78 | Failed to return"}],"County Subdivisions":[{"status":"Layer query encountered 79 | an error: java.lang.RuntimeException: Failed to return"}],"Alaska Native Village 80 | Statistical Areas":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 81 | Failed to return"}],"Off-Reservation Trust Lands":[{"status":"Layer query 82 | encountered an error: java.lang.RuntimeException: Failed to return"}],"American 83 | Indian Joint-Use Areas":[{"status":"Layer query encountered an error: java.lang.RuntimeException: 84 | Failed to return"}]},"matchedAddress":"1600 PENNSYLVANIA AVE NW, WASHINGTON, 85 | DC, 20502","coordinates":{"x":-77.03535,"y":38.898754},"addressComponents":{"zip":"20502","city":"WASHINGTON","state":"DC","preDirection":"","preType":"","streetName":"PENNSYLVANIA","suffixType":"AVE","suffixDirection":"NW","suffixQualifier":"","fromAddress":"1600","toAddress":"1698","preQualifier":""}}]}}'} 86 | headers: 87 | cache-control: [private, 'no-cache, no-store, max-age=0'] 88 | content-language: [en-US] 89 | content-type: [application/json] 90 | date: ['Tue, 31 Oct 2017 17:52:24 GMT'] 91 | expires: ['Wed, 31 Dec 1969 23:59:59 GMT'] 92 | pragma: [no-cache] 93 | strict-transport-security: [max-age=31536000] 94 | vary: [Origin] 95 | x-frame-options: [Deny] 96 | status: {code: 200, message: OK} 97 | version: 1 98 | -------------------------------------------------------------------------------- /src/censusgeocode/censusgeocode.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2015-9 Neil Freeman 2 | 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | """ 16 | Census Geocoder wrapper 17 | For details on the API, see: 18 | http://geocoding.geo.census.gov/geocoder/Geocoding_Services_API.pdf 19 | """ 20 | import csv 21 | import io 22 | import warnings 23 | 24 | import requests 25 | from requests.exceptions import RequestException 26 | from requests_toolbelt.multipart.encoder import MultipartEncoder 27 | 28 | 29 | DEFAULT_BENCHMARK = "Public_AR_Current" 30 | DEFAULT_VINTAGE = "Current_Current" 31 | 32 | 33 | class CensusGeocode: 34 | """Fetch results from the Census Geocoder""" 35 | 36 | _url = "https://geocoding.geo.census.gov/geocoder/{returntype}/{searchtype}" 37 | returntypes = ["geographies", "locations"] 38 | 39 | batchfields = { 40 | "locations": [ 41 | "id", 42 | "address", 43 | "match", 44 | "matchtype", 45 | "parsed", 46 | "coordinate", 47 | "tigerlineid", 48 | "side", 49 | ], 50 | "geographies": [ 51 | "id", 52 | "address", 53 | "match", 54 | "matchtype", 55 | "parsed", 56 | "coordinate", 57 | "tigerlineid", 58 | "side", 59 | "statefp", 60 | "countyfp", 61 | "tract", 62 | "block", 63 | ], 64 | } 65 | 66 | def __init__(self, benchmark=None, vintage=None): 67 | """ 68 | Arguments: 69 | benchmark (str): A name that references the version of the locator to use. 70 | See https://geocoding.geo.census.gov/geocoder/benchmarks 71 | vintage (str): The geography part of the desired vintage. 72 | See: https://geocoding.geo.census.gov/geocoder/vintages?form 73 | 74 | >>> CensusGeocode(benchmark='Public_AR_Current', vintage='Current_Current') 75 | """ 76 | self._benchmark = benchmark or DEFAULT_BENCHMARK 77 | self._vintage = vintage or DEFAULT_VINTAGE 78 | 79 | def _geturl(self, searchtype, returntype=None): 80 | """Construct an URL for the geocoder.""" 81 | returntype = returntype or self.returntypes[0] 82 | return self._url.format(returntype=returntype, searchtype=searchtype) 83 | 84 | def _fetch(self, searchtype, fields, **kwargs): 85 | """Fetch a response from the Geocoding API.""" 86 | fields["vintage"] = self.vintage 87 | fields["benchmark"] = self.benchmark 88 | 89 | fields["format"] = "json" 90 | 91 | if "layers" in kwargs: 92 | fields["layers"] = kwargs["layers"] 93 | 94 | returntype = kwargs.get("returntype", "geographies") 95 | url = self._geturl(searchtype, returntype) 96 | 97 | try: 98 | with requests.get(url, params=fields, timeout=kwargs.get("timeout")) as r: 99 | content = r.json() 100 | if "addressMatches" in content.get("result", {}): 101 | return AddressResult(content) 102 | 103 | if "geographies" in content.get("result", {}): 104 | return GeographyResult(content) 105 | 106 | raise ValueError() 107 | 108 | except (ValueError, KeyError): 109 | raise ValueError("Unable to parse response from Census") 110 | 111 | except RequestException as err: 112 | raise err 113 | 114 | def coordinates(self, x, y, **kwargs): 115 | """Geocode a (lon, lat) coordinate.""" 116 | kwargs["returntype"] = "geographies" 117 | fields = {"x": x, "y": y} 118 | 119 | return self._fetch("coordinates", fields, **kwargs) 120 | 121 | def address(self, street, city=None, state=None, **kwargs): 122 | """Geocode an address.""" 123 | fields = { 124 | "street": street, 125 | "city": city, 126 | "state": state, 127 | "zip": kwargs.get('zip') or kwargs.get('zipcode'), 128 | } 129 | 130 | return self._fetch("address", fields, **kwargs) 131 | 132 | def onelineaddress(self, address, **kwargs): 133 | """Geocode an an address passed as one string. 134 | e.g. "4600 Silver Hill Rd, Suitland, MD 20746" 135 | """ 136 | fields = { 137 | "address": address, 138 | } 139 | 140 | return self._fetch("onelineaddress", fields, **kwargs) 141 | 142 | def set_benchmark(self, benchmark): 143 | """Set the Census Geocoding API benchmark the class will use. 144 | See: https://geocoding.geo.census.gov/geocoder/vintages?form""" 145 | self._benchmark = benchmark 146 | 147 | @property 148 | def benchmark(self): 149 | """Give the Census Geocoding API benchmark the class is using. 150 | See: https://geocoding.geo.census.gov/geocoder/benchmarks""" 151 | return getattr(self, "_benchmark") 152 | 153 | def set_vintage(self, vintage): 154 | """Set the Census Geocoding API vintage the class will use. 155 | See: https://geocoding.geo.census.gov/geocoder/vintages?form""" 156 | self._vintage = vintage 157 | 158 | @property 159 | def vintage(self): 160 | """Give the Census Geocoding API vintage the class is using. 161 | See: https://geocoding.geo.census.gov/geocoder/vintages?form""" 162 | return getattr(self, "_vintage") 163 | 164 | def _parse_batch_result(self, data, returntype): 165 | """Parse the batch address results returned from the Census Geocoding API""" 166 | try: 167 | fieldnames = self.batchfields[returntype] 168 | except KeyError as err: 169 | raise ValueError("unknown returntype: {}".format(returntype)) from err 170 | 171 | def parse(row): 172 | row["lat"], row["lon"] = None, None 173 | 174 | if row["coordinate"]: 175 | try: 176 | row["lon"], row["lat"] = tuple(float(a) for a in row["coordinate"].split(",")) 177 | except: 178 | pass 179 | 180 | del row["coordinate"] 181 | row["match"] = row["match"] == "Match" 182 | return row 183 | 184 | # return as list of dicts 185 | with io.StringIO(data) as f: 186 | reader = csv.DictReader(f, fieldnames=fieldnames) 187 | return [parse(row) for row in reader] 188 | 189 | def _post_batch(self, data=None, f=None, **kwargs): 190 | """Send batch address file to the Census Geocoding API""" 191 | returntype = kwargs.get("returntype", "geographies") 192 | url = self._geturl("addressbatch", returntype) 193 | 194 | if data: 195 | # For Python 3, compile data into a StringIO 196 | f = io.StringIO() 197 | writer = csv.DictWriter(f, fieldnames=["id", "street", "city", "state", "zip"]) 198 | for i, row in enumerate(data, 1): 199 | row.setdefault("id", i) 200 | writer.writerow(row) 201 | if i == 10001: 202 | warnings.warn("Sending more than 10,000 records, the upper limit for the Census Geocoder. Request will likely fail") 203 | 204 | f.seek(0) 205 | 206 | elif f is None: 207 | raise ValueError("Need either data or a file for CensusGeocode.addressbatch") 208 | 209 | try: 210 | form = MultipartEncoder( 211 | fields={ 212 | "vintage": self.vintage, 213 | "benchmark": self.benchmark, 214 | "addressFile": ("batch.csv", f, "text/plain"), 215 | } 216 | ) 217 | headers = {"Content-Type": form.content_type} 218 | 219 | with requests.post(url, data=form, timeout=kwargs.get("timeout"), headers=headers) as r: 220 | # return as list of dicts 221 | return self._parse_batch_result(r.text, returntype) 222 | 223 | except RequestException as err: 224 | raise err 225 | 226 | finally: 227 | f.close() 228 | 229 | def addressbatch(self, data, **kwargs): 230 | """ 231 | Send either a CSV file or data to the addressbatch API. 232 | 233 | According to the Census, "there is currently an upper limit of 10,000 records per batch file." 234 | 235 | If a file, can either be a file-like with a `read()` method, or a `str` that's a path to the 236 | file. Either way, it must have no header and have fields id,street,city,state,zip 237 | 238 | If data, should be an iterable of dicts with the above fields (although ID is optional). 239 | """ 240 | # Does data quack like a file handle? 241 | if hasattr(data, "read"): 242 | return self._post_batch(f=data, **kwargs) 243 | 244 | # If it is a string, assume it's a filename 245 | if isinstance(data, str): 246 | with open(data, "rb") as f: 247 | return self._post_batch(f=f, **kwargs) 248 | 249 | # Otherwise, assume an iterable of dicts 250 | return self._post_batch(data=data, **kwargs) 251 | 252 | 253 | class GeographyResult(dict): 254 | 255 | """Wrapper for geography objects returned by the Census Geocoding API""" 256 | 257 | def __init__(self, data): 258 | self.input = data["result"].get("input", {}) 259 | super().__init__(data["result"]["geographies"]) 260 | 261 | # create float coordinate tuples 262 | for geolist in self.values(): 263 | for geo in geolist: 264 | try: 265 | geo["CENT"] = float(geo["CENTLON"]), float(geo["CENTLAT"]) 266 | except ValueError: 267 | geo["CENT"] = () 268 | 269 | try: 270 | geo["INTPT"] = float(geo["INTPTLON"]), float(geo["INTPTLAT"]) 271 | except ValueError: 272 | geo["INTPT"] = () 273 | 274 | 275 | class AddressResult(list): 276 | 277 | """Wrapper for address objects returned by the Census Geocoding API""" 278 | 279 | def __init__(self, data): 280 | self.input = data["result"].get("input", {}) 281 | super().__init__(data["result"]["addressMatches"]) 282 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | --------------------------------------------------------------------------------