Skip to main content

A Python library that both a client that downloads various shapefiles and GEOJSON files from the web and processes these geometry files. Users can also process locally hosted shapefiles and GEOJSON files. Also works for those on VPN/PROXY connections.

Project description

shapeography

Alt text Alt text

DOI

(C) Eric J. Drewitz 2026

An open-source Python package that manages shapefiles/GEOJSON files and simplifies the process of working with GIS data in Python.

How To Install

Copy and paste either command into your terminal or anaconda prompt:

Install via Anaconda

conda install shapeography

Install via pip

pip install shapeography

How To Update To The Latest Version

Copy and paste either command into your terminal or anaconda prompt:

Update via Anaconda

This is for users who initially installed WxData through Anaconda

conda update shapeography

Update via pip

This is for users who initially installed WxData through pip

pip install --upgrade shapeography

Jupyter Lab Examples

  1. Downloading and Plotting the National Weather Service Public Forecast Zones
  2. Downloading and Plotting the NOAA/NWS Climate Prediction Center 6-10 Day Probabilistic Precipitation Outlook

Client Module

Documentation

The client module hosts the client function get_shapefiles() that downloads shapefiles/GEOJSON file from a user-defined URL address into a folder locally on your PC.

The user must specify the path and filename and the file is saved to {path}/{filename}.

This client is also helpful for those using shapeography in automated scripts. If the user keeps the optional argument refresh=True - The directory hosting the shapefiles/GEOJSON file will be refreshed as the old files will be deleted and new files downloaded. This can be helpful in automation due to periodic shapefile updates on the server-side as it ensures that the user will always have the most recent and up to date shapefiles/GEOJSON file.

This client supports users on a VPN/PROXY connection.

**Proxy Example**

proxies=None ---> proxies={
                       'http':'address:port',
                       'https':'address:port'
                    } 

shapeography.client.get_shapefiles(url, path, filename, proxies=proxies)

Unzip Module

Documentation

The unzip module hosts the function that unzips the shapefiles/GEOJSON file if the file(s) need to be unzipped.

In nearly all cases, shapefile components are within a zipfile server-side so needing to unzip is very common.

The function extract_files() unzips the shapefiles/GEOJSON into a user-specified extraction folder that is automatically generated.

Supports the following file extentions: .zip, .gz, .tar, .tar.gz

Geometry Module

Documentation

The geometry module hosts functions that extract data from these shapefiles/GEOJSON file and make it significantly easier to work with this data in Python.

The current functions are:

  1. cartopy_shapefeature() - Returns a cartopy.shapefeature from the data inside the shapefile/GEOJSON.
  2. get_geometries() - Returns a gpd.GeoDataFrame of the geometry data of the shapefile/GEOJSON in the coordinate reference system (CRS) specified by the user. (Default CRS = 'EPSG:4326' --> ccrs.PlateCarree())
  3. geodataframe() - Returns gpd.GeoDataFrame hosting all the data in the shapefile/GEOJSON in the coordinate reference system (CRS) specified by the user. (Default CRS = 'EPSG:4326' --> ccrs.PlateCarree())

Citations

  1. cartopy: Phil Elson, Elliott Sales de Andrade, Greg Lucas, Ryan May, Richard Hattersley, Ed Campbell, Andrew Dawson, Bill Little, Stephane Raynaud, scmc72, Alan D. Snow, Ruth Comer, Kevin Donkers, Byron Blay, Peter Killick, Nat Wilson, Patrick Peglar, lgolston, lbdreyer, … Chris Havlin. (2023). SciTools/cartopy: v0.22.0 (v0.22.0). Zenodo. https://doi.org/10.5281/zenodo.8216315
  2. geopandas: Kelsey Jordahl, Joris Van den Bossche, Martin Fleischmann, Jacob Wasserman, James McBride, Jeffrey Gerard, … François Leblanc. (2020, July 15). geopandas/geopandas: v0.8.1 (Version v0.8.1). Zenodo. http://doi.org/10.5281/zenodo.3946761
  3. requests: K. Reitz, "Requests: HTTP for Humans". Available: https://requests.readthedocs.io/.

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

shapeography-1.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

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

shapeography-1.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file shapeography-1.0.tar.gz.

File metadata

  • Download URL: shapeography-1.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for shapeography-1.0.tar.gz
Algorithm Hash digest
SHA256 5acc8b3c3fe4f80f0f11aa568965fa8dc8236348cdec18b4bbedac516b5b328f
MD5 eb600e3606ae8c0b9994eaa263223bc2
BLAKE2b-256 7704ce929e18708b8d872c82943dbf43edec5f95296f5280215687d586a9b28b

See more details on using hashes here.

File details

Details for the file shapeography-1.0-py3-none-any.whl.

File metadata

  • Download URL: shapeography-1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for shapeography-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f1a4db2ebb858f54124433a03edad92adf76178540f8f07a620306ba28f1085
MD5 63d52f0e656a5dc79f5fc84ec8887d6d
BLAKE2b-256 ae981523df36f7726838b5afd143cb61238212bf3de76a5187c95fafdb119bb6

See more details on using hashes here.

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