zipcodes 1.3.0__tar.gz → 2.0.1__tar.gz

zipcodes-2.0.1/Cargo.lock

@@ -0,0 +1,240 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "bzip2"
+version = "0.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f3a53fac24f34a81bc9954b5d6cfce0c21e18ec6959f44f56e8e90e4bb7c346c"
+dependencies = [
+ "libbz2-rs-sys",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "itoa"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
+
+[[package]]
+name = "libbz2-rs-sys"
+version = "0.2.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34b357333733e8260735ba5894eb928c02ecc69c78715f01a8019e7fa7f2db4c"
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "memchr"
+version = "2.8.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "88904434abc2901f197fe8cc55f0445e7ded921dba5911dad2e2b39b48e663c4"
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cd274650b21d4bfc26a0a47587962c1edb425f69287324355cd040c3ea66071c"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c5e2a7d2f0d013342f295c048ad19237add5154a55b1c5a254c0ec93d4109078"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca85c467da1bbc8d866eea5deff9cf29ea5f7785054a17da36e65bda9c05845b"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ac53762fd065daa3194dd09337a38bd793a188100fd1a9304c4ab312d901771"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ca3a1557399783172dc5bf39cfca835157732532cba56b71d2292161e53b362"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "serde"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
+dependencies = [
+ "serde_core",
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.150"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e8014e44b4736ed0538adeecded0fce2a272f22dc9578a7eb6b2d9993c74cfb9"
+dependencies = [
+ "itoa",
+ "memchr",
+ "serde",
+ "serde_core",
+ "zmij",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "thiserror"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "zipcodes"
+version = "2.0.1"
+dependencies = [
+ "bzip2",
+ "serde",
+ "serde_json",
+ "thiserror",
+]
+
+[[package]]
+name = "zipcodes-py"
+version = "2.0.1"
+dependencies = [
+ "pyo3",
+ "serde_json",
+ "zipcodes",
+]
+
+[[package]]
+name = "zmij"
+version = "1.0.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b8848ee67ecc8aedbaf3e4122217aff892639231befc6a1b58d29fff4c2cabaa"

zipcodes-2.0.1/Cargo.toml

@@ -0,0 +1,15 @@
+[workspace]
+members = ["crates/zipcodes", "crates/zipcodes-py"]
+resolver = "2"
+
+[workspace.package]
+version = "2.0.1"
+edition = "2021"
+rust-version = "1.82"
+authors = ["Sean Pianka <pianka@eml.cc>"]
+license = "MIT"
+repository = "https://github.com/seanpianka/zipcodes"
+homepage = "https://github.com/seanpianka/zipcodes"
+
+[profile.release]
+lto = true

zipcodes-2.0.1/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: zipcodes
+Version: 2.0.1
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+License-File: LICENSE.txt
+Summary: Query U.S. state zipcodes without SQLite.
+Keywords: zipcode,zip,code,us,state,query,filter,validate,sqlite
+Home-Page: https://github.com/seanpianka/zipcodes
+Author-email: Sean Pianka <pianka@eml.cc>
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/seanpianka/zipcodes
+Project-URL: Issues, https://github.com/seanpianka/zipcodes/issues
+
+# Zipcodes
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zipcodes)
+[![PyPI](https://img.shields.io/pypi/v/zipcodes)](https://pypi.org/project/zipcodes/)
+[![crates.io](https://img.shields.io/crates/v/zipcodes)](https://crates.io/crates/zipcodes)
+[![Downloads](https://static.pepy.tech/badge/zipcodes/month)](https://pepy.tech/project/zipcodes)
+[![Contributors](https://img.shields.io/github/contributors/seanpianka/zipcodes.svg)](https://github.com/seanpianka/zipcodes/graphs/contributors)
+
+Zipcodes is a simple library for querying U.S. zipcodes. No SQLite, no
+network, no runtime data files — the full dataset is embedded in the package.
+
+Since 2.0, the library is implemented in Rust and published from a single
+codebase as both the [`zipcodes` Python package](https://pypi.org/project/zipcodes/)
+and the [`zipcodes` Rust crate](https://crates.io/crates/zipcodes). The Python
+API is a drop-in replacement for 1.x — same functions, same dicts, same
+exceptions — just faster:
+
+| Operation | 1.x (pure Python) | 2.0 (Rust) |
+|---|---|---|
+| `import zipcodes` | ~330 ms (loads dataset) | ~5 ms (dataset loads lazily on first query, ~200 ms) |
+| `is_real("06903")` | ~4.2 ms | ~0.03 ms |
+| `matching("77429")` | ~4.2 ms | ~0.3 ms |
+| `similar_to("1018")` | ~7.2 ms | ~0.3 ms |
+| `filter_by(state="TX")` | ~9.7 ms | ~3.7 ms |
+
+```python
+>>> import zipcodes
+>>> assert zipcodes.is_real('77429')
+>>> assert len(zipcodes.similar_to('7742')) != 0
+>>> exact_zip = zipcodes.matching('77429')[0]
+>>> filtered_zips = zipcodes.filter_by(city="Cypress", state="TX")
+>>> assert exact_zip in filtered_zips
+>>> pprint.pprint(exact_zip)
+{'acceptable_cities': [],
+ 'active': True,
+ 'area_codes': ['281', '346', '713', '832'],
+ 'city': 'Cypress',
+ 'country': 'US',
+ 'county': 'Harris County',
+ 'lat': '29.9766',
+ 'long': '-95.6358',
+ 'state': 'TX',
+ 'timezone': 'America/Chicago',
+ 'unacceptable_cities': [],
+ 'world_region': 'NA',
+ 'zip_code': '77429',
+ 'zip_code_type': 'STANDARD'}
+```
+
+The zipcode data is refreshed automatically every month — see
+[Zipcode Data](#zipcode-data).
+
+## Installation
+
+### Python
+
+```console
+$ python -m pip install zipcodes
+```
+
+Zipcodes 2.x supports Python 3.9+ and ships prebuilt wheels for Linux
+(x86_64, aarch64, musl), macOS, and Windows. Installing from the source
+distribution requires a Rust toolchain. Python 2.6+/3.2+ users are
+automatically served the pure-Python 1.3.0 release by pip.
+
+### Rust
+
+```console
+$ cargo add zipcodes
+```
+
+### New in 2.0
+
+- Implemented in Rust; the dataset is compiled into the extension module and
+  decompressed lazily on first query, so `import zipcodes` is effectively free.
+- New functions: `contains`, `filter_by_state`, `filter_by_city`,
+  `filter_by_county`, `filter_by_timezone`, `filter_by_zip_code_type`,
+  `filter_by_coordinates`, and `haversine`.
+- `is_valid` now actually emits its `DeprecationWarning` (in 1.x it raised
+  `AttributeError`); use `is_real`.
+- PyInstaller users no longer need `--add-data` for `zips.json.bz2` — there is
+  no data file anymore.
+- Behavioral notes for upgraders: query results are fresh dicts (mutating a
+  result no longer mutates the shared database list), and
+  `filter_by(active=1)` no longer matches `active=True` (pass a bool).
+
+## Zipcode Data
+
+The embedded dataset (`crates/zipcodes/src/zips.json.bz2`) is assembled from
+three sources:
+
+- **[unitedstateszipcodes.org](https://www.unitedstateszipcodes.org)** — the
+  rich base data (city aliases, zip type, area codes, county, timezone),
+  committed in-repo as `scripts/data/zip_code_database.csv`. Its bot
+  protection prevents automated downloads, so this file is refreshed manually
+  on occasion.
+- **[GeoNames](https://www.geonames.org/)** (`download.geonames.org/export/zip/US.zip`) —
+  GPS coordinates, fetched fresh on every update. Licensed
+  [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
+- **USPS ZIP Locale Detail** ([postalpro.usps.com](https://postalpro.usps.com/ZIP_Locale_Detail)) —
+  the authoritative list of active delivery ZIPs, fetched fresh on every
+  update and used to add zipcodes missing from the base CSV
+  ([#23](https://github.com/seanpianka/Zipcodes/issues/23)). Public domain.
+
+A GitHub Actions workflow ([`update-data.yml`](.github/workflows/update-data.yml))
+rebuilds the dataset on the 1st of every month
+([#7](https://github.com/seanpianka/Zipcodes/issues/7)). If anything changed,
+it opens a pull request with a summary of added/removed/modified records;
+merging that PR tags a patch release, which publishes to PyPI and crates.io
+automatically.
+
+To rebuild the dataset manually:
+
+```shell script
+$ pip install xlrd
+$ curl -fsSL https://download.geonames.org/export/zip/US.zip -o /tmp/geonames_us.zip
+$ # download the .xls linked from https://postalpro.usps.com/ZIP_Locale_Detail
+$ python scripts/update_zipcode_dataset.py \
+    --base scripts/data/zip_code_database.csv \
+    --gps scripts/data/zip-codes-database-FREE.csv \
+    --geonames-zip /tmp/geonames_us.zip \
+    --usps-xls /tmp/usps_zip_locale.xls \
+    --output-bz2 crates/zipcodes/src/zips.json.bz2 \
+    --summary-output /tmp/change_summary.json
+```
+
+## Tests
+
+The tests are defined in a declarative, table-based format that generates test
+cases.
+
+```shell script
+$ cargo test                    # Rust unit tests
+$ python tests/__init__.py      # Python suite (or: pytest tests/)
+```
+
+## Examples
+
+```python
+>>> from pprint import pprint
+>>> import zipcodes
+
+>>> # Simple zip-code matching.
+>>> pprint(zipcodes.matching('77429'))
+[{'acceptable_cities': [],
+  'active': True,
+  'area_codes': ['281', '346', '713', '832'],
+  'city': 'Cypress',
+  'country': 'US',
+  'county': 'Harris County',
+  'lat': '29.9766',
+  'long': '-95.6358',
+  'state': 'TX',
+  'timezone': 'America/Chicago',
+  'unacceptable_cities': [],
+  'world_region': 'NA',
+  'zip_code': '77429',
+  'zip_code_type': 'STANDARD'}]
+
+
+>>> # Handles Zip+4 zip-codes nicely. :)
+>>> pprint(zipcodes.matching('77429-1145'))
+[{'acceptable_cities': [],
+  'active': True,
+  'area_codes': ['281', '346', '713', '832'],
+  'city': 'Cypress',
+  'country': 'US',
+  'county': 'Harris County',
+  'lat': '29.9766',
+  'long': '-95.6358',
+  'state': 'TX',
+  'timezone': 'America/Chicago',
+  'unacceptable_cities': [],
+  'world_region': 'NA',
+  'zip_code': '77429',
+  'zip_code_type': 'STANDARD'}]
+
+>>> # Will try to handle invalid zip-codes gracefully...
+>>> print(zipcodes.matching('06463'))
+[]
+
+>>> # Until it cannot.
+>>> zipcodes.matching('0646a')
+Traceback (most recent call last):
+  ...
+ValueError: Invalid characters, zipcode may only contain digits and "-".
+
+>>> zipcodes.matching('064690')
+Traceback (most recent call last):
+  ...
+ValueError: Invalid format, zipcode must be of the format: "#####" or "#####-####"
+
+>>> zipcodes.matching(None)
+Traceback (most recent call last):
+  ...
+TypeError: Invalid type, zipcode must be a string.
+
+>>> # Whether the zip-code exists within the database.
+>>> print(zipcodes.is_real('06463'))
+False
+
+>>> # How handy!
+>>> print(zipcodes.is_real('06469'))
+True
+
+>>> # Search for zipcodes that begin with a pattern.
+>>> pprint(zipcodes.similar_to('1018'))
+[{'acceptable_cities': [],
+  'active': False,
+  'area_codes': ['212'],
+  'city': 'New York',
+  'country': 'US',
+  'county': 'New York County',
+  'lat': '40.71',
+  'long': '-74',
+  'state': 'NY',
+  'timezone': 'America/New_York',
+  'unacceptable_cities': ['J C Penney'],
+  'world_region': 'NA',
+  'zip_code': '10184',
+  'zip_code_type': 'UNIQUE'},
+ {'acceptable_cities': [],
+  'active': True,
+  'area_codes': ['212'],
+  'city': 'New York',
+  'country': 'US',
+  'county': 'New York County',
+  'lat': '40.7808',
+  'long': '-73.9772',
+  'state': 'NY',
+  'timezone': 'America/New_York',
+  'unacceptable_cities': ['Manhattan', 'New York City', 'NY', 'Ny City', 'Nyc'],
+  'world_region': 'NA',
+  'zip_code': '10185',
+  'zip_code_type': 'PO BOX'}]
+
+>>> # Use filter_by to filter a list of zip-codes by specific attribute->value pairs.
+>>> pprint(zipcodes.filter_by(city="Old Saybrook"))
+[{'acceptable_cities': [],
+  'active': True,
+  'area_codes': ['860', '959'],
+  'city': 'Old Saybrook',
+  'country': 'US',
+  'county': 'Middlesex County',
+  'lat': '41.2913',
+  'long': '-72.385',
+  'state': 'CT',
+  'timezone': 'America/New_York',
+  'unacceptable_cities': ['Fenwick'],
+  'world_region': 'NA',
+  'zip_code': '06475',
+  'zip_code_type': 'STANDARD'}]
+
+>>> # Arbitrary nesting of similar_to and filter_by calls, allowing for great precision while filtering.
+>>> pprint([z['zip_code'] for z in zipcodes.similar_to('2', zips=zipcodes.filter_by(active=True, city='Windsor'))])
+['23487', '27983', '29856']
+
+>>> # Find zipcodes within a radius (miles) of a coordinate.
+>>> pprint([z['zip_code'] for z in zipcodes.filter_by_coordinates(41.3015, -72.3879, 5)])
+['06371', '06409', '06426', '06442', '06475', '06498']
+
+>>> # Have any other ideas? Make a pull request and start contributing today!
+>>> # Made with love by Sean Pianka
+```
+
+## Repository layout
+
+This repository builds both packages from one Rust core:
+
+- `crates/zipcodes` — the core library, published to
+  [crates.io](https://crates.io/crates/zipcodes).
+- `crates/zipcodes-py` — PyO3 bindings (not published to crates.io).
+- `python/zipcodes` — the thin Python compatibility layer; together with the
+  bindings it forms the [PyPI package](https://pypi.org/project/zipcodes/),
+  built with [maturin](https://github.com/PyO3/maturin).
+