Tom Kralidis
67 lines
2.8 KiB
ReStructuredText
67 lines
2.8 KiB
ReStructuredText
.. _introduction:
|
|
|
|
Introduction
|
|
============
|
|
|
|
`pygeoapi`_ is a Python server implementation of the OGC API suite of standards. The project emerged as part of the next generation `OGC API`_ efforts in 2018 and provides the capability for organizations to deploy a RESTful OGC API endpoint using OpenAPI, GeoJSON, and HTML. pygeoapi is `open source <https://opensource.org>`_ and released under an MIT :ref:`license`.
|
|
|
|
Features
|
|
--------
|
|
|
|
* out of the box modern OGC API server
|
|
* certified OGC Compliant and Reference Implementation
|
|
* OGC API - Features
|
|
* OGC API - Environmental Data Retrieval
|
|
* additionally implements
|
|
* OGC API - Coverages
|
|
* OGC API - Maps
|
|
* OGC API - Tiles
|
|
* OGC API - Processes
|
|
* OGC API - Records
|
|
* SpatioTemporal Asset Library
|
|
* out of the box data provider plugins for rasterio, GDAL/OGR, Elasticsearch, PostgreSQL/PostGIS
|
|
* easy to use OpenAPI / Swagger documentation for developers
|
|
* supports JSON, GeoJSON, HTML and CSV output
|
|
* supports data filtering by spatial, temporal or attribute queries
|
|
* easy to install: install a full implementation via ``pip`` or ``git``
|
|
* simple YAML configuration
|
|
* easy to deploy: via UbuntuGIS or the official Docker image
|
|
* flexible: built on a robust plugin framework to build custom data connections, formats and processes
|
|
* supports any Python web framework (included are Flask [default], Starlette)
|
|
* supports asynchronous processing and job management (OGC API - Processes)
|
|
|
|
Standards Support
|
|
-----------------
|
|
|
|
Standards are at the core of pygeoapi. Below is the project's standards support matrix.
|
|
|
|
* Implementing: implements standard (good)
|
|
* Compliant: conforms to OGC compliance requirements (great)
|
|
* Reference Implementation: provides a reference for the standard (awesome!)
|
|
|
|
.. csv-table::
|
|
:header: "Standard", "Support"
|
|
:align: left
|
|
:widths: 20, 20
|
|
|
|
`OGC API - Features`_,Reference Implementation
|
|
`OGC API - Coverages`_,Implementing
|
|
`OGC API - Maps`_,Implementing
|
|
`OGC API - Tiles`_,Implementing
|
|
`OGC API - Processes`_,Implementing
|
|
`OGC API - Records`_,Implementing
|
|
`OGC API - Environmental Data Retrieval`_,Reference Implementation
|
|
`SpatioTemporal Asset Catalog`_,Implementing
|
|
|
|
|
|
.. _`pygeoapi`: https://pygeoapi.io
|
|
.. _`OGC API`: https://ogcapi.ogc.org
|
|
.. _`OGC API - Features`: https://www.ogc.org/standards/ogcapi-features
|
|
.. _`OGC API - Coverages`: https://github.com/opengeospatial/ogcapi-coverages
|
|
.. _`OGC API - Maps`: https://github.com/opengeospatial/ogcapi-maps
|
|
.. _`OGC API - Tiles`: https://github.com/opengeospatial/ogcapi-tiles
|
|
.. _`OGC API - Processes`: https://github.com/opengeospatial/ogcapi-processes
|
|
.. _`OGC API - Records`: https://github.com/opengeospatial/ogcapi-records
|
|
.. _`OGC API - Environmental Data Retrieval`: https://github.com/opengeospatial/ogcapi-environmental-data-retrieval
|
|
.. _`SpatioTemporal Asset Catalog`: https://stacspec.org
|