Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.12.dev2.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.12.dev2-py3-none-any.whl (16.2 MB view details)

Uploaded Python 3

File details

Details for the file geoservercloud-0.8.12.dev2.tar.gz.

File metadata

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

File hashes

Hashes for geoservercloud-0.8.12.dev2.tar.gz
Algorithm Hash digest
SHA256 6a3745de9d907f17dfde91636a0d7f63a564e178e68b093a431a2920738a1e90
MD5 7892e088dc4d723049414190a2e17b0b
BLAKE2b-256 ff0f3b775eba12cbb3e1f82c2062bc8fb01af04e2a89edf02cad92d1298d44fc

See more details on using hashes here.

File details

Details for the file geoservercloud-0.8.12.dev2-py3-none-any.whl.

File metadata

File hashes

Hashes for geoservercloud-0.8.12.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 e09f13a61f14e01100d09ab5298fa8b0836f69436e0829f656abbd33dd8772d8
MD5 c2ba1af685ed8c804166242739416e86
BLAKE2b-256 837c1488adc51c136babdf61d433619a1f314980174fb2de3b0edd2b537b3b20

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.8.12.dev2 This release

2 files

0.8.11

2 files

0.8.10

2 files

0.8.9

2 files

0.8.8

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page