Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
Clarify the connection with PostgreSQL and provide an extra example.
  • Loading branch information
bosth authored Sep 7, 2021
1 parent 4b0a6e3 commit 697b3df
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
plpygis
=======

``plpygis`` is a Python tool that can convert a `PostGIS <https://postgis.net/>`_ ``geometry`` into an equivalent WKB, EWKB, GeoJSON or Shapely geometry. ``plpygis`` is intended for use in `PL/Python <https://www.postgresql.org/docs/current/plpython.html>`_ functions.
``plpygis`` is a Python tool that can convert a `PostGIS <https://postgis.net/>`_ ``geometry`` into an equivalent WKB, EWKB, GeoJSON or Shapely geometry. ``plpygis`` is intended for use in PostgreSQL `PL/Python <https://www.postgresql.org/docs/current/plpython.html>`_ functions.

Basic usage
===========
Expand All @@ -27,6 +27,12 @@ The ``Geometry`` class and its subclasses can be used to convert to and from Pos
return None
$$ LANGUAGE plpythonu;
This can then be called as part of an SQL query:

.. code-block:: postgres
SELECT largest_poly(geom) FROM countries;
Documentation
=============

Expand Down

0 comments on commit 697b3df

Please sign in to comment.