# plpygis
`plpygis` is a pure Python module with no dependencies that can convert geometries between [Well-known binary](https://en.wikipedia.org/wiki/Well-known_binary) (WKB), Extended Well-known Binary (EWKB) and GeoJSON representations. `plpygis` is mainly intended for use in PostgreSQL [PL/Python](https://www.postgresql.org/docs/current/plpython.html) functions to augment [PostGIS](https://postgis.net/)'s native capabilities.
## Basic usage
`plpygis` implements several subclasses of the `Geometry` class, such as `Point`, `LineString`, `MultiPolygon` and so on:
```python
>>> from plpygis import Point
>>> p = Point((-124.005, 49.005), srid=4326)
>>> print(p.wkb)
0101000020e6100000b81e85eb51005fc0713d0ad7a3804840
>>> 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)`.
```pgsql
CREATE OR REPLACE FUNCTION add_elevation(geom geometry(POINT))
RETURNS geometry(POINTZ)
AS $$
from plpygis import Geometry
from requests import get
point = Geometry(geom)
response = get(f'https://api.open-meteo.com/v1/elevation?longitude={point.x}&latitude={point.y}')
if response.status_code == 200:
content = response.json()
point.z = content['elevation'][0]
return point
else:
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:
```pgsql
SELECT name, ST_AsText(add_elevation(geom)) FROM city;
```
## Documentation
Full `plpygis` documentation is available at <http://plpygis.readthedocs.io/>.
[](https://github.com/bosth/plpygis/actions?query=workflow%3A%22tests%22) [](http://plpygis.readthedocs.io/en/latest/?badge=latest)
Raw data
{
"_id": null,
"home_page": null,
"name": "plpygis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "gis, geospatial, postgis, postgresql, pl/python",
"author": null,
"author_email": "Benjamin Trigona-Harany <plpygis@jaxartes.net>",
"download_url": "https://files.pythonhosted.org/packages/97/15/497748d7cb76d26230f3ee74e27f1efa9915382e367b5a67b353f9cf9c7c/plpygis-0.4.2.tar.gz",
"platform": null,
"description": "# plpygis\n\n`plpygis` is a pure Python module with no dependencies that can convert geometries between [Well-known binary](https://en.wikipedia.org/wiki/Well-known_binary) (WKB), Extended Well-known Binary (EWKB) and GeoJSON representations. `plpygis` is mainly intended for use in PostgreSQL [PL/Python](https://www.postgresql.org/docs/current/plpython.html) functions to augment [PostGIS](https://postgis.net/)'s native capabilities.\n\n## Basic usage\n\n`plpygis` implements several subclasses of the `Geometry` class, such as `Point`, `LineString`, `MultiPolygon` and so on:\n\n```python\n>>> from plpygis import Point\n>>> p = Point((-124.005, 49.005), srid=4326)\n>>> print(p.wkb)\n0101000020e6100000b81e85eb51005fc0713d0ad7a3804840\n>>> print(p.geojson)\n{'type': 'Point', 'coordinates': [-124.005, 49.005]}\n```\n\n## Usage with PostGIS\n\n`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)`.\n\n```pgsql\nCREATE OR REPLACE FUNCTION add_elevation(geom geometry(POINT))\n RETURNS geometry(POINTZ)\nAS $$\n from plpygis import Geometry\n from requests import get\n point = Geometry(geom)\n\n response = get(f'https://api.open-meteo.com/v1/elevation?longitude={point.x}&latitude={point.y}')\n if response.status_code == 200:\n content = response.json()\n point.z = content['elevation'][0]\n return point\n else:\n return None\n$$ LANGUAGE plpython3u;\n```\n\nThe `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`.\n\nThe function above can be called as part of an SQL query:\n\n```pgsql\nSELECT name, ST_AsText(add_elevation(geom)) FROM city;\n```\n\n## Documentation\n\nFull `plpygis` documentation is available at <http://plpygis.readthedocs.io/>.\n\n[](https://github.com/bosth/plpygis/actions?query=workflow%3A%22tests%22) [](http://plpygis.readthedocs.io/en/latest/?badge=latest)\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Python tools for PostGIS",
"version": "0.4.2",
"project_urls": {
"Documentation": "https://plpygis.readthedocs.io/",
"Homepage": "https://github.com/bosth/plpygis",
"Issues": "https://github.com/bosth/plpygis/issues"
},
"split_keywords": [
"gis",
" geospatial",
" postgis",
" postgresql",
" pl/python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c796dfba731c1757959cc52f91db79736c702024887b2e56cf41e9820e817b6",
"md5": "47ff5e6f191211f27b2b35fc7670933b",
"sha256": "3f60047aab09f3591a622ca29fa12c43564c2ef0d6cfcbbb685b70eb97a5f1d8"
},
"downloads": -1,
"filename": "plpygis-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47ff5e6f191211f27b2b35fc7670933b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22685,
"upload_time": "2024-07-21T07:52:16",
"upload_time_iso_8601": "2024-07-21T07:52:16.421281Z",
"url": "https://files.pythonhosted.org/packages/4c/79/6dfba731c1757959cc52f91db79736c702024887b2e56cf41e9820e817b6/plpygis-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9715497748d7cb76d26230f3ee74e27f1efa9915382e367b5a67b353f9cf9c7c",
"md5": "5aabb027d340bc8bea2bd48453db199c",
"sha256": "010730797d06b7f0c739c861b18a77035b40fc91f049cfaa9970969b4539d094"
},
"downloads": -1,
"filename": "plpygis-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "5aabb027d340bc8bea2bd48453db199c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 28332,
"upload_time": "2024-07-21T07:52:18",
"upload_time_iso_8601": "2024-07-21T07:52:18.278464Z",
"url": "https://files.pythonhosted.org/packages/97/15/497748d7cb76d26230f3ee74e27f1efa9915382e367b5a67b353f9cf9c7c/plpygis-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-21 07:52:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bosth",
"github_project": "plpygis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Shapely",
"specs": [
[
">=",
"2.0.4[shapely_support]"
]
]
}
],
"lcname": "plpygis"
}
JSON
