nyc-geo-toolkit 0.1.6

Reusable NYC geography resources, normalization helpers, and boundary loaders for Python tools.

nyc-geo-toolkit

Reusable NYC geography resources, normalization helpers, and boundary loaders for Python tools.

Authored by Blaise Albis-Burdige.

What this package provides

nyc-geo-toolkit packages canonical NYC boundary layers and the stable helper API needed to discover, normalize, load, subset, and convert them.

It is designed to stay small, typed, and reusable across NYC data packages.

The package currently provides:

• packaged boundary layers for boroughs, community districts, council districts, NTAs, ZCTAs, and census tracts
• canonical normalization helpers for layer names and boundary values
• typed boundary models for boundary collections and features
• GeoJSON and optional DataFrame / GeoDataFrame helpers
• bbox clipping for typed boundary collections

Ecosystem

nyc-geo-toolkit is the shared geography core for the NYC package ecosystem. It already powers the geography layer in nyc311 and is intended to support additional consumer packages without forcing each project to duplicate boundary data or normalization rules.

Install

Base install:

pip install nyc-geo-toolkit

With pandas helpers:

pip install "nyc-geo-toolkit[dataframes]"

With geopandas + shapely helpers:

pip install "nyc-geo-toolkit[spatial]"

With all optional helpers:

pip install "nyc-geo-toolkit[all]"

Quick example

from nyc_geo_toolkit import list_boundary_layers, load_nyc_boundaries

print(list_boundary_layers())
queens = load_nyc_boundaries("borough", values="Queens")
print(queens.features[0].geography_value)

Examples

The repo now also ships self-contained consumer examples under examples/:

• examples/boundary-quickstart/
• examples/normalization-demo/

Public surface

The stable public API is the top-level nyc_geo_toolkit namespace.

Discovery and loading:

• list_boundary_layers()
• list_boundary_values()
• load_boundaries()
• load_nyc_boundaries()
• load_nyc_boundaries_geodataframe()
• load_nyc_census_tracts()
• load_nyc_council_districts()
• load_nyc_neighborhood_tabulation_areas()

Normalization:

• normalize_borough_name()
• normalize_boundary_layer()
• normalize_boundary_value()
• normalize_boundary_values()

Conversion and spatial helpers:

• boundaries_to_geojson()
• boundaries_to_dataframe()
• clip_boundaries_to_bbox()

Models and constants:

• BoundaryCollection
• BoundaryFeature
• BoundaryLayerSpec
• BOROUGH_*
• SUPPORTED_BOROUGHS
• SUPPORTED_BOUNDARY_GEOGRAPHIES

Private underscore-prefixed modules are implementation details and may change without notice.

Documentation

Docs: Home, Getting Started, API Reference, Architecture, Contributing, Releasing, Changelog

License

MIT.