pygeoapi 0.12.0 documentation

Author

the pygeoapi team

Contact

pygeoapi at lists.osgeo.org

Release

0.12.0

Date

2022-02-07

Table of Contents

• Introduction
  • Features
  • Standards Support
• How pygeoapi works
• Install
  • Requirements and dependencies
  • For developers and the truly impatient
  • pip
  • Docker
  • Conda
  • UbuntuGIS
  • FreeBSD
  • Summary
• Configuration
  • Reference
    • server
    • logging
    • metadata
    • resources
  • Validating the configuration
  • Using environment variables
  • Linked Data
  • Summary
• Administration
  • Creating the OpenAPI document
  • Validating the OpenAPI document
  • Setting system environment variables
  • Summary
• Running
  • pygeoapi serve
    • Flask WSGI
    • Starlette ASGI
  • Running in production
    • Apache and mod_wsgi
    • Gunicorn
    • Gunicorn and Flask
    • Gunicorn and Starlette
  • Summary
• Docker
  • The basics
  • Overriding the default configuration
  • Deploying on a sub-path
  • Summary
• Taking a tour of pygeoapi
  • Overview
  • Landing page
  • Collections
  • Collection information
  • Vector data
    • Collection queryables
    • Collection items
    • Collection item
  • Raster data
    • Collection coverage domainset
    • Collection coverage rangetype
    • Collection coverage data
  • Tiles
    • URI templates
    • Generic metadata
  • Metadata Records
  • Processes
  • Environmental data retrieval
  • SpatioTemporal Assets
  • API Documentation
  • Conformance
• OpenAPI
  • Using OpenAPI via Swagger
  • Using OpenAPI via ReDoc
  • Summary
• Data publishing
  • Providers overview
    • Publishing vector data to OGC API - Features
      • Providers
      • Connection examples
      • Data access examples
    • Publishing raster data to OGC API - Coverages
      • Providers
      • Connection examples
      • Data access examples
    • Publishing map tiles to OGC API - Tiles
      • Providers
      • Connection examples
      • Data access examples
    • Publishing processes via OGC API - Processes
      • Configuration
      • Asynchronous support
      • Putting it all together
      • Processing examples
    • Publishing metadata to OGC API - Records
      • Providers
      • Connection examples
      • Metadata search examples
    • Publishing data to OGC API - Environmental Data Retrieval
      • Providers
      • Connection examples
      • Data access examples
    • Publishing files to a SpatioTemporal Asset Catalog
      • Connection examples
      • pygeometa metadata control files
      • Publishing ESRI Shapefiles
      • Data access examples
• Customizing pygeoapi: plugins
  • Overview
  • Example: custom pygeoapi vector data provider
    • Python code
    • Connecting to pygeoapi
  • Example: custom pygeoapi raster data provider
    • Python code
  • Example: custom pygeoapi formatter
    • Python code
  • Processing plugins
  • Featured plugins
• HTML Templating
  • Featured templates
• CQL support
  • Limitations
  • Formats
  • Providers
    • Queries
    • Examples
• Multilingual support
  • End user guide
    • Notes
  • Maintainer guide
    • Notes
    • Add translations for configurable text values
  • Translator guide
  • Developer guide
    • Notes
• Development
  • Codebase
  • Testing
  • CQL extension lifecycle
    • Limitations
    • Schema
    • Model generation
    • How to merge
  • Working with Spatialite on OSX
    • Using pyenv
• OGC Compliance
  • CITE instance
  • Setting up your own CITE testing instance
• Contributing
• Support
  • Community
• Further Reading
• License
  • Code
  • Documentation
• API documentation
  • API
  • flask_app
  • Logging
  • OpenAPI
  • Plugins
  • Utils
  • Formatter package
    • Base class
    • csv
  • Process package
    • Base class
    • hello_world
  • Provider
    • Base class
    • CSV provider
    • Elasticsearch provider
    • GeoJSON
    • OGR
    • postgresql
    • sqlite/geopackage

Indices and tables

• Index

• Module Index

• Search Page