Table of Contents

• Introduction
  • Features
  • Standards Support
• How pygeoapi works
• Install
  • Requirements and dependencies
  • For developers and the truly impatient
  • pip
  • Docker
    • Using DockerHub
    • Using GitHub Container Registry
  • Kubernetes
  • Conda
  • UbuntuGIS
  • FreeBSD
  • Summary
• Configuration
  • Reference
    • server
    • logging
    • logging.rotation
    • metadata
    • resources
  • Using environment variables
  • Adding links to collections
  • Publishing hidden resources
  • API Design Rules
    • api_version
    • strict_slashes
    • url_prefix
    • version_header
  • Hierarchical collections
  • Selective properties in feature and record providers
  • Limiting data responses
    • Vector data (features, records)
    • Raster data (coverages, environmental data retrieval)
  • Linked Data
  • Validating the configuration
  • Summary
• Administration
  • Creating the OpenAPI document
  • Validating the OpenAPI document
  • Setting system environment variables
  • Summary
• Running
  • Running in development
    • Flask WSGI
    • Starlette ASGI
    • Django
    • Hot-reloading
  • Running in production
    • Apache and mod_wsgi
    • Gunicorn
    • Gunicorn and Flask
    • Gunicorn and Starlette
  • Summary
• Docker
  • The basics
  • Overriding the default configuration
  • Environment Variables for 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
    • Transactions
  • Raster data
    • Collection coverage schema
    • Collection coverage data
  • Maps
  • Tiles
    • URI templates
    • Generic metadata
  • Metadata Records
    • Transactions
  • Processes
  • Environmental data retrieval
  • SpatioTemporal Assets
  • API Documentation
  • Conformance
• OpenAPI
  • Using OpenAPI via Swagger
  • Using OpenAPI via ReDoc
  • Summary
• Publishing
  • Data publishing
    • Publishing vector data to OGC API - Features
      • Providers
      • Connection examples
      • Including extra query parameters
      • Controlling the order of properties
      • Data access examples
    • Publishing raster data to OGC API - Coverages
      • Providers
      • Connection examples
      • Data access examples
    • Publishing maps to OGC API - Maps
      • Providers
      • Connection examples
      • Data visualization examples
    • Publishing tiles to OGC API - Tiles
      • Providers
      • Connection examples
      • Providing custom Tile Matrix Set definitions
      • Data access examples
    • Publishing data to OGC API - Environmental Data Retrieval
      • Providers
      • Connection examples
      • Data access examples
  • Metadata publishing
    • Publishing metadata to OGC API - Records
      • Providers
      • Connection examples
      • Including extra query parameters
      • Metadata search examples
    • Publishing files to a SpatioTemporal Asset Catalog
      • Static catalog
      • STAC API
      • Data access examples
  • Process publishing
    • Publishing processes via OGC API - Processes
      • Configuration
      • Job managers
      • Asynchronous support
      • Processing and response handling
      • Processing examples
• Transactions
  • Access control
• Admin API
  • Access control
  • pygeoapi hot reloading in gunicorn
• Security
• Customizing pygeoapi: plugins
  • Overview
  • Connecting plugins to pygeoapi
    • Specifying custom pygeoapi CLI commands
    • Customizing pygeoapi process manager
  • Example: custom pygeoapi vector data provider
    • Python code
  • Example: custom pygeoapi raster data provider
    • Python code
  • Example: custom pygeoapi processing plugin
    • Python code
    • Documenting process metadata
  • Example: custom pygeoapi formatter
    • Python code
  • Featured plugins
• HTML Templating
  • Dataset level templates
    • Example
  • Featured themes
  • Customizing the default HTML templates
• CRS support
  • Background
  • Configuration
  • Metadata
  • Parameters
  • Implementation
    • bbox-crs Parameter
    • filter-crs Parameter
    • crs Parameter
  • Examples
• CQL support
  • Providers
  • Limitations
  • Formats
    • Queries
    • Examples
• Multilingual support
  • End user guide
    • Notes
  • Maintainer guide
    • Notes
    • Add translations for configurable text values
  • Translator guide
  • Developer guide
    • Notes
• Development
  • Codebase
  • Pull Requests and GitHub Actions
  • Testing
  • Linting
    • Using flake8
    • Using pre-commit
  • Building the documentation
  • 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