Merge pull request #10 from geopython/master

sync with codebase

Author: pzaborowski

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Build documentation ⚙️
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+  release:
+    types:
+      - released
+
+jobs:
+  main:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        include:
+          - python-version: '3.10'
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      name: Setup Python ${{ matrix.python-version }}
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install requirements 📦
+      run: |
+        pip3 install -r requirements.txt
+        pip3 install -r docs/requirements.txt
+    - name: build docs 🏗️
+      run: cd docs && make html

.github/workflows/main.yml

@@ -4,11 +4,13 @@ on:
   push:
     paths-ignore:
       - '**.md'
+      - 'docs/**'
   pull_request:
     branches:
       - master
     paths-ignore:
       - '!**.md'
+      - 'docs/**'
   release:
     types:
       - released
@@ -65,7 +67,7 @@ jobs:
       with:
         mongodb-version: 4.4
     - name: Install and run SensorThingsAPI
-      uses: cgs-earth/sensorthings-action@v0.0.2
+      uses: cgs-earth/sensorthings-action@v0.1.0
     - name: Install sqlite and gpkg dependencies
       uses: awalsh128/cache-apt-pkgs-action@latest
       with:
@@ -90,7 +92,6 @@ jobs:
         pip3 install -r requirements-dev.txt
         pip3 install -r requirements-provider.txt
         pip3 install -r requirements-django.txt
-        pip3 install -r docs/requirements.txt
         python3 setup.py install
         pip3 install --upgrade numpy elasticsearch
         pip3 install --upgrade numpy "sqlalchemy<2"
@@ -103,6 +104,7 @@ jobs:
         python3 tests/load_mongo_data.py tests/data/ne_110m_populated_places_simple.geojson
         gunzip < tests/data/hotosm_bdi_waterways.sql.gz | psql postgresql://postgres:${{ secrets.DatabasePassword || 'postgres' }}@localhost:5432/test
         psql postgresql://postgres:${{ secrets.DatabasePassword || 'postgres' }}@localhost:5432/test -f tests/data/dummy_data.sql
+        psql postgresql://postgres:${{ secrets.DatabasePassword || 'postgres' }}@localhost:5432/test -f tests/data/dummy_types_data.sql
         docker ps
         python3 tests/load_oracle_data.py
     - name: run unit tests ⚙️
@@ -139,8 +141,6 @@ jobs:
         pytest tests/test_util.py
         pytest tests/test_xarray_netcdf_provider.py
         pytest tests/test_xarray_zarr_provider.py
-    - name: build docs 🏗️
-      run: cd docs && make html
     - name: failed tests 🚩
       if: ${{ failure() }}
       run: |

Dockerfile

@@ -34,7 +34,7 @@
 #
 # =================================================================
 
-FROM ubuntu:jammy-20240227
+FROM ubuntu:jammy-20240627.1
 
 LABEL maintainer="Just van den Broecke <[email protected]>"
 

docker/default.config.yml

@@ -342,7 +342,7 @@ resources:
         keywords:
             - Portugal
             - POI
-            - Point of Interrest
+            - Point of Interest
             - Madeira
             - Azores
             - OSM

docker/entrypoint.sh

@@ -71,7 +71,7 @@ case ${entry_cmd} in
 	test)
 	  for test_py in $(ls tests/test_*.py)
 	  do
-	    # Skip tests requireing backend server or libs installed
+	    # Skip tests requiring backend server or libs installed
 	    case ${test_py} in
 	        tests/test_elasticsearch__provider.py)
 	        ;&

docs/source/admin-api.rst

@@ -18,7 +18,7 @@ Access control
 --------------
 
 It should be made clear that authentication and authorization is beyond the responsibility of pygeoapi.  This means that
-if a pygeoapi user enables the Admin API, they must provide access control explicity via another service.
+if a pygeoapi user enables the Admin API, they must provide access control explicitly via another service.
 
 pygeoapi hot reloading in gunicorn
 ----------------------------------

docs/source/conf.py

@@ -112,7 +112,7 @@ def __getattr__(cls, name):
 # built documents.
 #
 # The short X.Y version.
-version = '0.17.dev0'
+version = '0.18.dev0'
 # The full version, including alpha/beta/rc tags.
 release = version
 

docs/source/configuration.rst

@@ -83,8 +83,8 @@ The ``logging`` section provides directives for logging messages which are usefu
   logging:
       level: ERROR  # the logging level (see https://docs.python.org/3/library/logging.html#logging-levels)
       logfile: /path/to/pygeoapi.log  # the full file path to the logfile
-      logformat: # example for miliseconds:'[%(asctime)s.%(msecs)03d] {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s'
-      dateformat: # example for miliseconds:'%Y-%m-%dT%H:%M:%S'
+      logformat: # example for milliseconds:'[%(asctime)s.%(msecs)03d] {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s'
+      dateformat: # example for milliseconds:'%Y-%m-%dT%H:%M:%S'
 
 .. note::
    If ``level`` is defined and ``logfile`` is undefined, logging messages are output to the server's ``stdout``.

docs/source/data-publishing/ogcapi-coverages.rst

@@ -100,23 +100,41 @@ Data access examples
 --------------------
 
 * list all collections
+
   * http://localhost:5000/collections
+  
 * overview of dataset
+
   * http://localhost:5000/collections/foo
+  
 * schema of dataset
+
   * http://localhost:5000/collections/foo/schema
+  
 * coverage access via CoverageJSON (default)
+
   * http://localhost:5000/collections/foo/coverage?f=json
+  
 * coverage access via native format (as defined in ``provider.format.name``)
+
   * http://localhost:5000/collections/foo/coverage?f=GRIB
+  
 * coverage access with comma-separated properties
+
   * http://localhost:5000/collections/foo/coverage?properties=1,3
+  
 * coverage access with subsetting
+
   * http://localhost:5000/collections/foo/coverage?subset=lat(10:20)&subset=long(10:20)
+  
 * coverage with bbox
+
   * http://localhost:5000/collections/foo/coverage?bbox=10,10,20,20
+  
 * coverage with bbox and bbox CRS
+
   * http://localhost:5000/collections/foo/coverage?bbox=-8794239.772668611,5311971.846945471,-8348961.809495518,5621521.486192066&bbox=crs=3857
+  
 
 .. note::
    ``.../coverage`` queries which return an alternative representation to CoverageJSON (which prompt a download)

docs/source/data-publishing/ogcapi-features.rst

@@ -361,7 +361,7 @@ Mandatory properties
         - example_group_id
 
 On large tables it could be useful to disallow a query on the complete dataset. For this reason it is possible to 
-configure mandatory properties. When this is activated, the provoder throws an exception when the parameter
+configure mandatory properties. When this is activated, the provider throws an exception when the parameter
 is not in the query uri.
 
 Extra properties
@@ -387,13 +387,28 @@ Extra properties
 Extra properties is a list of strings which are added as fields for data retrieval in the SELECT clauses. They
 can be used to return expressions computed by the database.
 
+Session Pooling
+""""""""""""""""
+
+Configured using environment variables.
+
+.. code-block:: bash
+
+   export ORACLE_POOL_MIN=2
+   export ORACLE_POOL_MAX=10
+
+
+The ``ORACLE_POOL_MIN`` and ``ORACLE_POOL_MAX`` environment variables are used to trigger session pool creation in the Oracle Provider and the ``DatabaseConnection`` class. See https://python-oracledb.readthedocs.io/en/latest/api_manual/module.html#oracledb.create_pool for documentation of the ``create_pool`` function.
+
+If none or only one of the environment variables is set, session pooling will not be activated and standalone connections are established at every request.
+
 
 Custom SQL Manipulator Plugin
 """""""""""""""""""""""""""""
 The provider supports a SQL-Manipulator-Plugin class. With this, the SQL statement could be manipulated. This is
 useful e.g. for authorization at row level or manipulation of the explain plan with hints. 
 
-An example an more informations about that feature you can find in the test class in tests/test_oracle_provider.py.
+An example an more information about that feature you can find in the test class in tests/test_oracle_provider.py.
 
 .. _PostgreSQL:
 
@@ -488,7 +503,7 @@ SQLiteGPKG
 ^^^^^^^^^^
 
 .. note::
-   Requries Spatialite installation
+   Requires Spatialite installation
 
 SQLite file:
 

docs/source/data-publishing/ogcapi-processes.rst

@@ -110,7 +110,7 @@ Hello World (Default)
    # execute a job for the ``hello-world`` process in asynchronous mode
    curl -X POST http://localhost:5000/processes/hello-world/execution \
        -H "Content-Type: application/json" \
-       -H "Prefer: respond-async"
+       -H "Prefer: respond-async" \
        -d "{\"inputs\":{\"name\": \"hi there2\"}}"
    # execute a job for the ``hello-world`` process with a success subscriber
     curl -X POST http://localhost:5000/processes/hello-world/execution \

docs/source/data-publishing/ogcapi-records.rst

@@ -100,27 +100,49 @@ Metadata search examples
 ------------------------
 
 * overview of record collection
+
   * http://localhost:5000/collections/metadata-records
+  
 * queryables
+
   * http://localhost:5000/collections/foo/queryables
+  
 * browse records
+
   * http://localhost:5000/collections/foo/items
+  
 * paging
+
   * http://localhost:5000/collections/foo/items?offset=10&limit=10
+  
 * CSV outputs
+
   * http://localhost:5000/collections/foo/items?f=csv
+  
 * query records (spatial)
+
   * http://localhost:5000/collections/foo/items?bbox=-180,-90,180,90
+  
 * query records (attribute)
+
   * http://localhost:5000/collections/foo/items?propertyname=foo
+  
 * query records (temporal)
+
   * http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z
+  
 * query features (temporal) and sort ascending by a property (if no +/- indicated, + is assumed)
+
   * http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z&sortby=datetime
+  
 * query features (temporal) and sort descending by a property
+
   * http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z&sortby=-datetime
+  
 * fetch a specific record
+
   * http://localhost:5000/collections/my-metadata/items/123
+  
 
 .. note::
    provider `id_field` values support slashes (i.e. ``my/cool/identifier``). The client request would then

docs/source/data-publishing/ogcapi-tiles.rst

@@ -19,7 +19,7 @@ pygeoapi core tile providers are listed below, along with supported features.
    :align: left
 
    `MVT-tippecanoe`_,❌,✅,✅,❌
-   `MVT-elastic`_,✅,❌,✅,❌
+   `MVT-elastic`_,✅,✅,✅,❌
    `MVT-proxy`_,❓,❓,❓,❓
    `WMTSFacade`_,✅,❌,✅,✅
 
@@ -162,15 +162,25 @@ Data access examples
 --------------------
 
 * list all collections
+
   * http://localhost:5000/collections
+  
 * overview of dataset
+
   * http://localhost:5000/collections/foo
+  
 * overview of dataset tiles
+
   * http://localhost:5000/collections/foo/tiles
+  
 * tile matrix metadata
+
   * http://localhost:5000/collections/lakes/tiles/WorldCRS84Quad/metadata
+  
 * tiles URI template
+
   * `http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt <http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt>`_
+  
 
 
 .. _`OGC API - Tiles`: https://github.com/opengeospatial/ogcapi-tiles

docs/source/data-publishing/stac.rst

@@ -49,7 +49,7 @@ Connection examples
 pygeometa metadata control files
 --------------------------------
 
-pygeoapi's STAC filesystem fuctionality supports `pygeometa`_ MCF files residing
+pygeoapi's STAC filesystem functionality supports `pygeometa`_ MCF files residing
 in the same directory as data files.  If an MCF file is found, it will be used
 as part of generating the STAC item metadata (e.g. a file named ``birds.csv``
 having an associated ``birds.yml`` file).  If no MCF file is found, then
@@ -66,6 +66,7 @@ Data access examples
 --------------------
 
 * STAC root page
+
   * http://localhost:5000/stac
 
 From here, browse the filesystem accordingly.

docs/source/html-templating.rst

@@ -36,21 +36,13 @@ Linking to a static file in your HTML templates can be done using Jinja syntax a
   <img src="{{ config['server']['url'] }}/static/img/logo.png" title="{{ config['metadata']['identification']['title'] }}" />
 
 
-Featured templates
-------------------
-
-The following themes provide useful examples of pygeoapi templates implemented
-by downstream applications.
-
-.. csv-table::
-   :header: "Plugin(s)", "Organization/Project","Description"
-   :align: left
-
-   `pygeoapi-skin-dashboard`_,GeoCat bv,skin for pygeoapi based on a typical dashboard interface
+Featured themes
+----------------
 
+Community based themes can be found on the `pygeoapi Community Plugins and Themes wiki page`_.
 
 .. _`Jinja`: https://palletsprojects.com/p/jinja/
 .. _`Jinja documentation`: https://jinja.palletsprojects.com
 .. _`Flask`: https://palletsprojects.com/p/flask/
 .. _`Flask documentation`: https://flask.palletsprojects.com
-.. _`pygeoapi-skin-dashboard`: https://github.com/GeoCat/pygeoapi-skin-dashboard
+.. _`pygeoapi Community Plugins and Themes wiki page`: https://github.com/geopython/pygeoapi/wiki/CommunityPluginsThemes

docs/source/index.rst

@@ -51,7 +51,6 @@ reference documentation on all aspects of the project.
    support
    further-reading
    license
-
    api-documentation
 
 Indices and tables

docs/source/introduction.rst

@@ -10,15 +10,19 @@ Features
 
 * out of the box modern OGC API server
 * certified OGC Compliant and Reference Implementation
+  
   * OGC API - Features
   * OGC API - Environmental Data Retrieval
+  * OGC API - Tiles
+
 * additionally implements
+
   * OGC API - Coverages
   * OGC API - Maps
-  * OGC API - Tiles
   * OGC API - Processes
   * OGC API - Records
   * SpatioTemporal Asset Library
+  
 * out of the box data provider plugins for rasterio, GDAL/OGR, Elasticsearch, PostgreSQL/PostGIS
 * easy to use OpenAPI / Swagger documentation for developers
 * supports JSON, GeoJSON, HTML and CSV output