Skip to content

Commit

Permalink
add installation note about Python version support (#1644)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed Jul 25, 2024
1 parent 86390a6 commit af1794b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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

0 comments on commit af1794b

Please sign in to comment.