Skip to main content

Python tools for PostGIS

Project description


plpygis is a pure Python module with no dependencies that can convert geometries between Well-known binary (WKB), Extended Well-known Binary (EWKB) and GeoJSON representations. plpygis is mainly intended for use in PostgreSQL PL/Python functions to augment PostGIS's native capabilities.

Basic usage

plpygis implements several subclasses of the Geometry class, such as Point, LineString, MultiPolygon and so on:

>>> from plpygis import Point
>>> p = Point((-124.005, 49.005), srid=4326)
>>> print(p.wkb)
>>> print(p.geojson)
{'type': 'Point', 'coordinates': [-124.005, 49.005]}

Usage with PostGIS

plpygis is designed to provide an easy way to implement PL/Python functions that accept geometry arguments or return geometry results. The following example will take a PostGIS geometry(Point) and use an external service to create a geometry(PointZ).

CREATE OR REPLACE FUNCTION add_elevation(geom geometry(POINT))
  RETURNS geometry(POINTZ)
AS $$
  from plpygis import Geometry, Point
  from requests import get
  point = Geometry(geom)

  response = get(f'{point.x}&latitude={point.y}')
  if response.status_code == 200:
      content = response.json()
      point.z = content['elevation'][0]
      return point
      return None
$$ LANGUAGE plpython3u;

The Geometry() constructor will convert a PostGIS geometry that has been passed as a parameter to the PL/Python function into one of its plpygis subclasses. A Geometry that is returned from the PL/Python function will automatically be converted back to a PostGIS geometry.

The function above can be called as part of an SQL query:

SELECT name, ST_AsText(add_elevation(geom)) FROM city;


Full plpygis documentation is available at

Continuous Integration Documentation Status

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

plpygis-0.4.1.tar.gz (28.3 kB view hashes)

Uploaded Source

Built Distribution

plpygis-0.4.1-py3-none-any.whl (22.7 kB view hashes)

Uploaded Python 3

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