Metadata-Version: 2.0
Name: zip-code-radius
Version: 0.0.1
Summary: Generate minimum sets of zip codes, based on a radius, that can be used in a series of searches to cover the entire USA
Home-page: https://github.com/simon-wenmouth/zip-code-radius
Author: Simon Wenmouth
Author-email: UNKNOWN
License: http://www.apache.org/licenses/LICENSE-2.0
Keywords: zip code,radius,minimum search set
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: requests

zip-code-radius
===============

:info: Generate minimum sets of zip codes, based on a radius, that
       can be used in a series of searches to cover the entire USA

Features
********

* downloads an up-to-date reference set of US postal codes from 
  a repository hosted on ``github.com``

Installation
------------

.. code-block:: shell

    pip install zip-code-radius

Usage
-----

.. code-block:: python

    import sys

    from zip_code_radius import solver

    radius = float(sys.argv[1])

    results = solver.solve(radius)

    print "radius: %d, zip-codes: %d" % (radius, len(results))

Notes
-----

``zip-code-radius`` stores the US postal code data at your os temp dir (e.g. /tmp/).


