Skip to main content

A Python library for enforcing polygon ring winding order in GeoJSON

Project description

geojson-rewind

Run tests codecov PyPI Version License Python Compatibility Code style: black

A Python library for enforcing polygon ring winding order in GeoJSON

The GeoJSON spec mandates the right hand rule:

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

This helps you generate compliant Polygon and MultiPolygon geometries.

Note: Co-ordinates in the input data are assumed to be WGS84 with (lon, lat) ordering, as per RFC 7946. Input with co-ordinates using any other CRS may lead to unexpected results.

Installation

pip install geojson-rewind

Usage

As a Library

Enforce RFC 7946 ring winding order (input/output is a GeoJSON string):

>>> from geojson_rewind import rewind

>>> input = """{
...      "geometry": {   "coordinates": [   [   [100, 0],
...                                             [100, 1],
...                                             [101, 1],
...                                             [101, 0],
...                                             [100, 0]]],
...                      "type": "Polygon"},
...      "properties": {"foo": "bar"},
...      "type": "Feature"}"""

>>> output = rewind(input)

>>> output
'{"geometry": {"coordinates": [[[100, 0], [101, 0], [101, 1], [100, 1], [100, 0]]], "type": "Polygon"}, "properties": {"foo": "bar"}, "type": "Feature"}'

>>> type(output)
<class 'str'>

Enforce RFC 7946 ring winding order (input/output is a python dict):

>>> from geojson_rewind import rewind

>>> input = {
...     'geometry': {   'coordinates': [   [   [100, 0],
...                                            [100, 1],
...                                            [101, 1],
...                                            [101, 0],
...                                            [100, 0]]],
...                     'type': 'Polygon'},
...     'properties': {'foo': 'bar'},
...     'type': 'Feature'}

>>> output = rewind(input)

>>> output
{'geometry': {'coordinates': [[[100, 0], [101, 0], [101, 1], [100, 1], [100, 0]]], 'type': 'Polygon'}, 'properties': {'foo': 'bar'}, 'type': 'Feature'}

>>> type(output)
<class 'dict'>

On the Console

# Enforce ring winding order on a GeoJSON file
$ rewind in.geojson > out.geojson

# fetch GeoJSON from the web and enforce ring winding order
$ curl "https://myserver.com/in.geojson" | rewind

Acknowledgements

geojson-rewind is a python port of Mapbox's javascript geojson-rewind package. Credit to Tom MacWright and contributors.

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

geojson-rewind-1.0.2.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

geojson_rewind-1.0.2-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file geojson-rewind-1.0.2.tar.gz.

File metadata

  • Download URL: geojson-rewind-1.0.2.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.10 Linux/5.4.0-88-generic

File hashes

Hashes for geojson-rewind-1.0.2.tar.gz
Algorithm Hash digest
SHA256 3ba2c88b99855c6b8201834a476e7041fb04b377d4e5c1f3fb293daeac00f717
MD5 a633cba0d9a4869fd3ee06f7a22cc1d4
BLAKE2b-256 52b96d1e527edf489e05b7a92f8c2302af176a6aa1b610cebbe5bdb48732a612

See more details on using hashes here.

File details

Details for the file geojson_rewind-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: geojson_rewind-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.10 Linux/5.4.0-88-generic

File hashes

Hashes for geojson_rewind-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9465cba370bad373c00e9b015e6bb138ef656e7192f9318eee58eff5d64f5e59
MD5 49049ebc705a55733ad0c47790ac42f6
BLAKE2b-256 16213e4758158d4f3f8fe8c0c96481e5d6a872acacbb64ccf2d1bc336a3cff12

See more details on using hashes here.

Supported by

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