Skip to main content

python-geoservercloud

Documentation

https://camptocamp.github.io/python-geoservercloud/

Installation

From PyPI:

pip install geoservercloud

From git repository:

git clone https://github.com/camptocamp/python-geoservercloud
cd python-geoservercloud
python3 -m venv .venv
source .venv/bin/activate
poetry install

Quick start

from geoservercloud import GeoServerCloud

geoserver = GeoServerCloud(
    url="http://localhost:9090/geoserver/cloud/",
    user="admin",
    password="geoserver",
)
geoserver.create_workspace("newworkspace")

About

Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services. Intended use cases are listed below.

Programmatic setup of a GeoServer catalog

For example, creating a workspace, connecting to a PostGIS datastore and publishing a PG layer:

geoserver.create_workspace("example")
geoserver.create_pg_datastore(
    workspace_name="example",
    datastore_name="example_store",
    pg_host="localhost",
    pg_port=5432,
    pg_db="database",
    pg_user="user",
    pg_password="password"
)
geoserver.create_feature_type(
    layer_name="layer_example",
    workspace_name="example",
    datastore_name="example_store",
    title={
        "en":"Layer title",
        "fr": "Titre de la couche",
        "default": "Default title",
    },
)

Testing

Automatic tests of GeoServer functionalities with pytest, for example before upgrading. The example below tests the fallback mechanism for internationalized layer titles in the GetCapabilities document.

@pytest.mark.parametrize(
    "language,expected_title",
    [
        (
            "en",
            "Layer title",
        ),
        (
            "fr",
            "Titre de la couche",
        ),
        (
            "de,en",
            "Layer title",
        ),
        (
            None,
            "Default title",
        ),
    ],
)
def test_i18n_layer_title(geoserver, language, expected_title):
    capabilities = geoserver.get_wms_layers(
        workspace="example",
        accept_languages=language,
    )
    layer = capabilities.get("Layer")
    assert layer.get("Title") == expected_title

A test suite is provided in the directory geoserver_acceptance_tests.

Syncing

Copying a workspace from one GeoServer instance to another, including PG datastores, layers, styles and style images.

In a Python console or script

from geoservercloud import GeoServerCloudSync
geoserversync = GeoServerCloudSync(
    src_url="http://localhost:8080/geoserver",
    src_user="admin",
    src_password="geoserver",
    dst_url="http://localhost:9099/geoserver",
    dst_user="admin",
    dst_password="geoserver",
)
geoserversync.copy_workspace("workspace_name", deep_copy=True)

In a shell terminal or script

First install the package in your current virtual environment (see Installation), then run the script with:

copy-workspace --src_url "http://localhost:8080/geoserver" --src_user admin --src_password geoserver --dst_url "http://localhost:9099/geoserver" --dst_user admin --dst_password geoserver --workspace workspace_name

Logging

Set the log level using the standard logging module, e.g.:

import logging

gs_logger = logging.getLogger("geoservercloud")
gs_logger.setLevel(logging.DEBUG)
handler = logging.StreamHandler()
handler.setLevel(logging.DEBUG)
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)
gs_logger.addHandler(handler)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geoservercloud-0.8.8.tar.gz (16.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

geoservercloud-0.8.8-py3-none-any.whl (16.2 MB view details)

Uploaded Python 3

File details

Details for the file geoservercloud-0.8.8.tar.gz.

File metadata

  • Download URL: geoservercloud-0.8.8.tar.gz
  • Upload date:
  • Size: 16.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.14.6

File hashes

Hashes for geoservercloud-0.8.8.tar.gz
Algorithm Hash digest
SHA256 0db70b355a2134d219507f27d7dbc3b024b4210e220c79bb7fcaca69ba6eece6
MD5 f2e0c7b53208aafa83373bd291791139
BLAKE2b-256 287690a9f27efe948f685c656d09e42b6136dba31d6ddce3e1bcc9074ed69382

See more details on using hashes here.

File details

Details for the file geoservercloud-0.8.8-py3-none-any.whl.

File metadata

  • Download URL: geoservercloud-0.8.8-py3-none-any.whl
  • Upload date:
  • Size: 16.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.14.6

File hashes

Hashes for geoservercloud-0.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4e7b4fde1516c4d0077e64dfa0f3d265ea2867ab2dbf6b1e60c324ecb9fd18ed
MD5 ff84a9dc1c7d3cdc1a6aa7e9ce506cbc
BLAKE2b-256 765f98909289ef0bfe95ab7321a441378ebc47c36141a1dab294c9c782b36173

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page