Skip to content

Welcome to the Diving into pygeoapi workshop!

Version: 1.4.0

pygeoapi logo

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 and released under an MIT license.

Diving into pygeoapi is a half day workshop designed for users to become familiar with installing, configuring, publishing data to and extending pygeoapi. This workshop will cover publishing geospatial data to the Web using pygeoapi in support of the suite of OGC API standards.

This workshop covers a wide range of topics (install/setup/configuration, publishing, cloud, templating, plugins, etc.). Please see the left hand navigation for the table of contents.

Your FOSS4G 2024 workshop team

Tom Kralidis Joana Simoes Antonio Cerciello Benjamin Webb

About this tutorial

This tutorial is a combination of step-by-step explanations of various aspects of pygeoapi as well as a series of exercises to familiarize yourself with the project.

Exercises are indicated as follows:

Example exercise

A section marked like this indicates that you can try out the exercise.

Example exercise with tabs

A section marked like this indicates that you can try out the exercise and choose your environment (Linux/Mac or Windows).

docker run -p 5000:80 -v $(pwd)/default.config.yml:/pygeoapi/local.config.yml geopython/pygeoapi:latest


docker run -p 5000:80 -v ${pwd}/default.config.yml:/pygeoapi/local.config.yml geopython/pygeoapi:latest

Also you will notice tips and notes sections within the text:

Tip

Tips share additional help on how to best achieve tasks

Examples are indicated as follows:

Code 

1
2
3
4
5
<html>
    <head>
        <title>This is an HTML sample</title>
    </head>
</html>

Configuration 

1
2
3
4
my-collection:
    type: collection
    title: my cool collection title
    description: my cool collection description

Snippets which need to be typed in a on a terminal/console are indicated as:

echo 'Hello world'

Workshop location and materials

This workshop is always provided live at https://dive.pygeoapi.io.

The workshop contents, wiki and issue tracker are managed on GitHub at https://github.com/geopython/diving-into-pygeoapi.

Printing this workshop

To print this workshop, navigate to the print page and select File > Print > Save as PDF.

Support

A Gitter channel exists for discussion and live support from the developers of the workshop and other workshop participants.

For issues/bugs/suggestions or improvements/contributions, please use the GitHub issue tracker.

All bugs, enhancements and issues can be reported on GitHub.

As always, core pygeoapi support and community information can be found on the pygeoapi website.

Contributions are always enncouraged and welcome!

Now, on to the workshop. Let's go!