Skip to main content

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

Project description

nyc-geo-toolkit

Actions Status Documentation Status PyPI version PyPI platforms

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 small helper API needed to discover, normalize, load, subset, and convert them.

The initial release focuses on:

  • 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

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 load_nyc_boundaries, list_boundary_layers

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

Public surface

The stable public API centers on:

  • 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()
  • normalize_boundary_layer()
  • normalize_boundary_value()
  • normalize_boundary_values()
  • boundaries_to_geojson()
  • boundaries_to_dataframe()
  • clip_boundaries_to_bbox()

Documentation

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

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nyc_geo_toolkit-0.1.2.tar.gz (8.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nyc_geo_toolkit-0.1.2-py3-none-any.whl (8.5 MB view details)

Uploaded Python 3

File details

Details for the file nyc_geo_toolkit-0.1.2.tar.gz.

File metadata

  • Download URL: nyc_geo_toolkit-0.1.2.tar.gz
  • Upload date:
  • Size: 8.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nyc_geo_toolkit-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5d831967b7642b05233c5ae256200011bb348e3c08f660aadf1d0afde8b99f39
MD5 4bd8e8b674f9400d013fe0b29e37a5cb
BLAKE2b-256 981e3b8dd5131ed5d38ba1391677923e299db49ccf6570af9e3011a657cbc479

See more details on using hashes here.

Provenance

The following attestation bundles were made for nyc_geo_toolkit-0.1.2.tar.gz:

Publisher: cd.yml on random-walks/nyc-geo-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nyc_geo_toolkit-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for nyc_geo_toolkit-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 13523e7e1ec5d0ab65ff64e4e17781ed822d3fb88c7618c06a54ba95b39e7026
MD5 14a172cbb9e0ebeb13c52555eea20481
BLAKE2b-256 1ec66ae4db376235bbddffb52d48387aa41fcdc9e5f2a9b8f7fd358ba8f5fd06

See more details on using hashes here.

Provenance

The following attestation bundles were made for nyc_geo_toolkit-0.1.2-py3-none-any.whl:

Publisher: cd.yml on random-walks/nyc-geo-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page