add installation note about Python version support (#1644) (#1760)

This commit is contained in:
Tom Kralidis
2024-07-27 07:50:17 -04:00
committed by GitHub
parent 0a7bb7f5f4
commit a806f89a31
+9 -1
View File
@@ -11,6 +11,13 @@ Requirements and dependencies
pygeoapi runs on Python 3.
.. note::
The exact Python version requirements are aligned with the version of Python on the pygeoapi supported Ubuntu
operating system version. For example, as of 2024-07, the supported version of Python is bound to Ubuntu 22.04
(Jammy) which supports Python 3.10. Ensure you have a Python version that is compatible with the current Ubuntu
version that is specified in pygeoapi's `Dockerfile`_.
Core dependencies are included as part of a given pygeoapi installation procedure. More specific requirements
details are described below depending on the platform.
@@ -32,7 +39,7 @@ For developers and the truly impatient
vi example-config.yml # edit as required
export PYGEOAPI_CONFIG=example-config.yml
export PYGEOAPI_OPENAPI=example-openapi.yml
pygeoapi openapi generate $PYGEOAPI_CONFIG > $PYGEOAPI_OPENAPI
pygeoapi openapi generate $PYGEOAPI_CONFIG --output-file $PYGEOAPI_OPENAPI
pygeoapi serve
curl http://localhost:5000
@@ -142,3 +149,4 @@ onto your system.
.. _`Docker image`: https://github.com/geopython/pygeoapi/pkgs/container/pygeoapi
.. _`Dockerfile`: https://github.com/geopython/pygeoapi/blob/master/Dockerfile