Metadata-Version: 2.1
Name: county-adjacency
Version: 0.1.3
Summary: This package provides adjacency information for US counties (or their equivalent).
Home-page: https://github.com/chaddotson/county_adjacency
Author: Chad Dotson
License: MIT
Project-URL: Source, https://github.com/chaddotson/county_adjacency
Project-URL: Tracker, https://github.com/chaddotson/county_adjacency/issues
Keywords: geography,geo,counties,us
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: python-Levenshtein (==0.12.0)
Provides-Extra: dev
Requires-Dist: black (==20.8b1) ; extra == 'dev'
Requires-Dist: coverage (>=5.0) ; extra == 'dev'
Requires-Dist: flake8 (>=3.8.0) ; extra == 'dev'
Requires-Dist: flake8-docstrings (>=1.5.0) ; extra == 'dev'
Requires-Dist: flake8-rst-docstrings (>=0.0.14) ; extra == 'dev'
Requires-Dist: requests (==2.25.0) ; extra == 'dev'
Requires-Dist: pytest (>=6.1) ; extra == 'dev'

County Adjacency
================

.. image:: https://github.com/chaddotson/county_adjacency/workflows/main/badge.svg
    :target: https://github.com/chaddotson/county_adjacency/actions?query=workflow%3Amain

.. image:: https://img.shields.io/pypi/v/county-adjacency.svg
    :target: https://pypi.org/project/county-adjacency/

.. image:: https://img.shields.io/pypi/pyversions/county-adjacency.svg
    :target: https://pypi.org/project/county-adjacency/

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

This package provides adjacency information for US counties (or their equivalent). This data is derived
from the US Census `website`.

.. _website: https://www.census.gov/geographies/reference-files/2010/geo/county-adjacency.html

Example
-------
.. code-block:: python

    from county_adjacency import get_neighboring_areas, CountyNotFoundError, supported_areas

    try:
        print(get_neighboring_areas("San Francisco County, CA"))
    except CountyNotFoundError as error:
        print(error)

    ('Contra Costa County, CA', 'Marin County, CA', 'San Mateo County, CA')


    supported_areas()

    ('Autauga County, AL', 'Baldwin County, AL', ... , 'St. John Island, VI', 'St. Thomas Island, VI')


