KoalaGeo
8cd1e737f2
* Create ghcr.yml Create and publish a Docker image to GitHub Container Registry * Update installation.rst Add reference to GitHub Container registry * Update running-with-docker.rst Add ghcr references * Make ghcr conditional on main.yml Updated main.yml run conditions & add on-success condition to ghcr.yml * Miss aligned * change workflow name GHCR * Update build to Build Names didn't match GHCR condition * Remove cog symbol from Build name * Add paths-ignore **.md * Added build & push to DockerHub * Add authorship & update header * Tidy yml, add on-success condition * Add on failure condition * Remove GHC Tests and Conditional Push * DockerHub Test - koalageo/pygeoapi * DockerHub - Revert to geopython/pygeoapi * Use SECRET for DockerHub repo * Combined Build & Push * Update tag function * Fix tags for latest * Lastest tag only on `master` * Use tag on push tag event * Add latest tag on default branch * Add unit tests step * Add separate build & test steps * Typo in docs * Move flake8 to before tests - catch errors early * Add further tags Co-authored-by: Benjamin Webb <40066515+webb-ben@users.noreply.github.com> Co-authored-by: Benjamin Webb <40066515+webb-ben@users.noreply.github.com>
104 lines
2.4 KiB
ReStructuredText
104 lines
2.4 KiB
ReStructuredText
.. _install:
|
|
|
|
Install
|
|
=======
|
|
|
|
pygeoapi is easy to install on numerous environments. Whether you are a user, administrator or developer, below
|
|
are multiple approaches to getting pygeoapi up and running depending on your requirements.
|
|
|
|
Requirements and dependencies
|
|
-----------------------------
|
|
|
|
pygeoapi runs on Python 3.
|
|
|
|
Core dependencies are included as part of a given pygeoapi installation procedure. More specific requirements
|
|
details are described below depending on the platform.
|
|
|
|
|
|
For developers and the truly impatient
|
|
--------------------------------------
|
|
|
|
.. code-block:: bash
|
|
|
|
python -m venv pygeoapi
|
|
cd pygeoapi
|
|
. bin/activate
|
|
git clone https://github.com/geopython/pygeoapi.git
|
|
cd pygeoapi
|
|
pip install --upgrade pip
|
|
pip install -r requirements.txt
|
|
python setup.py install
|
|
cp pygeoapi-config.yml example-config.yml
|
|
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 serve
|
|
curl http://localhost:5000
|
|
|
|
|
|
pip
|
|
---
|
|
|
|
`PyPI package info <https://pypi.org/project/pygeoapi>`_
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install pygeoapi
|
|
|
|
Docker
|
|
------
|
|
|
|
Using DockerHub
|
|
^^^^^^^^^^^^^^^
|
|
|
|
`Docker image <https://hub.docker.com/r/geopython/pygeoapi>`_
|
|
|
|
.. code-block:: bash
|
|
|
|
docker pull geopython/pygeoapi:latest
|
|
|
|
Using GitHub Container Registry
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
`Docker image <https://github.com/geopython/pygeoapi/pkgs/container/pygeoapi>`_
|
|
|
|
.. code-block:: bash
|
|
|
|
docker pull ghcr.io/geopython/pygeoapi:latest
|
|
|
|
Conda
|
|
-----
|
|
|
|
`Conda package info <https://anaconda.org/conda-forge/pygeoapi>`_
|
|
|
|
.. code-block:: bash
|
|
|
|
conda install -c conda-forge pygeoapi
|
|
|
|
UbuntuGIS
|
|
---------
|
|
|
|
`UbuntuGIS package (stable) <https://launchpad.net/%7Eubuntugis/+archive/ubuntu/ppa/+sourcepub/10758317/+listing-archive-extra>`_
|
|
|
|
`UbuntuGIS package (unstable) <https://launchpad.net/~ubuntugis/+archive/ubuntu/ubuntugis-unstable/+sourcepub/10933910/+listing-archive-extra>`_
|
|
|
|
.. code-block:: bash
|
|
|
|
apt-get install python3-pygeoapi
|
|
|
|
FreeBSD
|
|
-------
|
|
|
|
`FreeBSD port <https://www.freshports.org/graphics/py-pygeoapi>`_
|
|
|
|
.. code-block:: bash
|
|
|
|
pkg install py-pygeoapi
|
|
|
|
|
|
Summary
|
|
-------
|
|
Congratulations! Whichever of the abovementioned methods you chose, you have successfully installed pygeoapi
|
|
onto your system.
|