Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jul 27, 2024
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/source/installation.rst
View file
Open in desktop
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
Loading