pygeoapi 0.14.0 documentation¶

Author: the pygeoapi team
Contact: pygeoapi at lists.osgeo.org
Release: 0.14.0
Date: 2023-02-03

Welcome to the official pygeoapi documentation! Here you will find complete reference documentation on all aspects of the project.

Note

Did you know about the pygeoapi workshop? Ready to get your hands dirty? Dive in!

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
- Conda
- UbuntuGIS
- FreeBSD
- Summary
Configuration
- Reference
- Publishing hidden resources
- Validating the configuration
- Using environment variables
- Hierarchical collections
- Selective properties in feature and record providers
- 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
- 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
- Raster 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
Data publishing
- Providers overview
Transactions
- Access control
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
- 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
- Testing
- CQL extension lifecycle
- 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

pygeoapi 0.14.0 documentation¶

Indices and tables¶