About pygeoapi

Project overview

• A Geopython project
• Created by Tom Kralidis in 2018 on Valentine's Day with ❤️
• OSGeo Project

Project Overview

• Geospatial data Web API framework via OGC API
• REST/JSON/OpenAPI/Swagger
• OGC Compliant
• OSGeo Project
• International team (Canada, Netherlands, Greece, Italy, New Zealand, United States, Spain)
  • Numerous core contributors
  • 21000 upstream contributors (dependencies)

Data Publishing

Leave data as-is

• Fits to the data (not the inverse)
• Proxy/wrap remote legacy services:
  WFS, ESRI FS, WMS,...

New: leave projection as-is
(CRS support!)

Technical Overview

• Web framework agnostic (default Flask)
• YAML configuration
• OpenAPI document generation
• Plugin framework (data connectors, formats, ...)
• Easy deploy (pip, Docker, UbuntuGIS)
• Minimal dependencies

Feature Data Providers

Elasticsearch	PostGIS	CSV	Spatialite	GeoJSON...

Feature Data Providers - GDAL/OGR

• Via OGR-Python bindings
• Unleashes ~100 Vector Formats! (WFS v1/v2, GeoPackage, Shapefile, GeoJSON, PostGIS, ...)
• Paging, reprojection, spatial/attribute query
• Unlock existing WFS v1/v2s, even ESRI FS!

Other OGC APIs

in various stages of development

• Coverage - NetCDF, Cloud Optimized GeoTIFF, ...
• Tiles - minio, ZXY, ...
• Maps - MapServer/MapScript, WMS Facade, ...
• Records (Metadata) - Elasticsearch, TinyDB, ...
• Processing - Python workflow, TinyDB, ...

Implement your own Plugin

as Feature Data, Process, ... Provider

• Propose / develop as core plugin
• Develop in your own repository
• Plugin dev documentation

Adding CRS Support

OGC API - Features - Part 2:
Coordinate Reference Systems by Reference

Aspects

• metadata: CRS list and storageCRS
• parameter: CRS bounding box
• parameter: CRS
• HTTP response header: Content-CRS
• documentation

YAML Config for CRS

AddressesNL_28992:
  type: collection
  title: Dutch INSPIRE Addresses - RD
.
.
  providers:
	- type: feature
	  name: OGR
	  crs:
		- http://www.opengis.net/def/crs/OGC/1.3/CRS84
		- http://www.opengis.net/def/crs/EPSG/0/4326
		- http://www.opengis.net/def/crs/EPSG/0/3857
		- http://www.opengis.net/def/crs/EPSG/0/4258
		- http://www.opengis.net/def/crs/EPSG/0/28992
	  storage_crs: http://www.opengis.net/def/crs/EPSG/0/28992
	  data:
	    source_type: GPKG
	    source: data/ADNL_28992.gpkg
.
.
						

CRS Support - Implementation

• available for ALL Feature Providers
• Per Feature Provider
  • handle internally (OGR, PostGIS) OR
  • delegate to pygeoapi core (e.g. CSV)
    via Python Decorator @crs_transform
• CITE Test Compliance

Development Aspects

• Added to core via PR 1174
• Community cooperation - Mathieu Tachon!
• demo: Geonovum testbed server
• documentation

INSPIRE improvements

Aspects

• Collection link(s) to data license
• Collection link(s) to "description of encoding"
• Collection link(s) for bulk downloads

Development (1/2)

• Mostly about configuration:

Development (2/2)

• Created UrlPrefetcher to get content details of enclosure links (HEAD request)
• Note: response may not contain Content-Type or
  Content-Length headers
• Added to core via PR 1173
• Documentation

Adherence to (Dutch) API Design Rules

Aspects

• API-03: Apply standard HTTP methods
• API-16: Provide OpenAPI Specification
• API-20: Include major version number in URI
• API-48: Leave off trailing slashes from URIs
• API-51: OAS at a standard location as JSON
• API-56: Adhere to Semantic Versioning model
• API-57: Full version number in response header

Development (1/2)

• OAS doc proofed crucial: embedded some components
• API-20 / API-48:
• implement at router or app level?
• implemented for Flask, Starlette, and Django
• landing page rule conflict!
• API-56:
• semantic versioning for API software or schema?
• currently software versioning only

Development (2/2)

• Added a lot of unit tests
• ADR is fully configurable (inactive by default)
• Added to core via PR 1152
• Documentation

Dutch ADR validator