geo2zip 0.1.7

Geo2Zip is a Python package that provides a fast and efficient way to find the closest US ZIP code for a given latitude and longitude.

Geo2Zip

Geo2Zip is a Python package that provides a fast and efficient way to find the closest ZIP/Postal code for a given latitude and longitude. It uses a small built-in KDTree for nearest-neighbor lookup, avoiding heavyweight spatial dependencies.

The package includes Canada and US ZIP/postal codes and their geolocation as out-of-the-boxdatasets.

Current version: 0.1.7

Features

• Quickly find the closest ZIP code for a given latitude and longitude.
• Efficient spatial indexing using a built-in KDTree.
• Easy-to-use command-line interface.

Installation

Prerequisites

• Python 3.7 or higher
• pip

Install the package

1. Clone the repository:

   git clone https://github.com/jlopex/geo2zip.git
   cd geo2zip
   

2. Install the package and its dependencies:

   pip install -e .
   

3. Install development dependencies (for testing):

   pip install -e .[dev]
   

Usage

Command Line Interface

You can use the geo2zip command to find the closest ZIP code for a given latitude and longitude.

geo2zip <latitude> <longitude>

Example:

geo2zip 37.7749 -122.4194

This command will output the closest ZIP code to the provided coordinates.

As a Python Library

You can also use the Geo2Zip class directly with your own dataset in your Python code doing:

from geo2zip import Geo2Zip

# Initialize with the path to your data file
geo2zip = Geo2Zip('path/to/geo_zip/data/your.csv')

# Find the closest ZIP code
latitude = 37.7749
longitude = -122.4194
closest_zip = geo2zip.find_closest_zip(latitude, longitude)
print(f"The closest ZIP code to ({latitude}, {longitude}) is {closest_zip}")

Data

The dataset used for US ZIP codes and their coordinates is extracted from the 2023 US Gazetteer Files. The CSV file is included in the package at geo2zip/data/us.csv.

The dataset used for Canada postal codes and their coordinates is taken from here. The CSV file is included in the package at geo2zip/data/ca.csv.

Testing

Simple and stupid Tests are written using pytest. To run the tests, execute the following command:

pytest tests/