OWSLib Documentation

OWSLib is a Python package designed for client programming with Open Geospatial Consortium (OGC) web service interface standards. It provides a common API for accessing service metadata and includes wrappers for various OGC interfaces, including:

• WMS: Web Map Service
• WFS: Web Feature Service
• WCS: Web Coverage Service
• CSW: Catalogue Service for the Web
• WPS: Web Processing Service
• WMTS: Web Map Tile Service (Note: some services may be beta quality)

If you want to configure proxies for your entire shell session, use the following commands depending on your operating system.

Linux/macOS (Bash)

Use export to set HTTP_PROXY, HTTPS_PROXY, and ALL_PROXY (which supports socks5 protocols).

Windows (PowerShell)

Use the $env: prefix to set environment variables.

For more advanced proxy configurations, refer to the requests library documentation.

# Linux (Bash)
$ export HTTP_PROXY="http://10.10.1.10:3128"
$ export HTTPS_PROXY="http://10.10.1.10:1080"
$ export ALL_PROXY="socks5://10.10.1.10:3434"

# Windows (PowerShell)
$env:HTTP_PROXY = "http://10.10.1.10:3128"
$env:HTTPS_PROXY = "http://10.10.1.10:1080"
$env:ALL_PROXY = "socks5://10.10.1.10:3434"

To perform filtered queries in WFS, you must construct an XML filter string.

For WFS 1.1.0 (FE 1.1), use owslib.fes to build the filter and owslib.etree to convert it to an XML string.

For WFS 2.0.0 (FE 2.0), use owslib.fes2 to build the filter and owslib.etree to convert it to an XML string.

# Example for WFS 2.0 using fes2
from owslib.fes2 import *
from owslib.etree import etree
from owslib.wfs import WebFeatureService

wfs11 = WebFeatureService(url='http://geoserv.weichand.de:8080/geoserver/wfs', version='2.0.0')

filter_obj = Filter(
    PropertyIsLike(propertyname='bez_gem', literal='Ingolstadt', wildCard='*')
)
filterxml = etree.tostring(filter_obj.toXML()).decode("utf-8")

response = wfs11.getfeature(typename='bvv:gmd_ex', filter=filterxml)

After setting up the development environment, you can verify the codebase using pytest for the test suite and flake8 for linting.

• Run tests: Use python3 -m pytest to execute the test suite.
• Run linting: Use flake8 owslib/ to check for style violations in the source directory.

# Run the test suite
python3 -m pytest

# Run linting
flake8 owslib/

To develop OWSLib, create a virtual environment, clone the repository, and install the package in editable mode along with the development dependencies.

1. Create and activate a virtual environment.
2. Clone the OWSLib repository.
3. Install the package with the [dev] extra using pip install -e ".[dev]" to ensure all testing and linting tools are available.

python3 -m venv owslibenv
source owslibenv/bin/activate

git clone https://github.com/geopython/OWSLib.git
cd OWSLib

pip install -e ".[dev]"

OWSLib uses standard Python module-based named loggers. You can capture and configure these logs in your application using the logging module. This is useful for debugging service interactions.

import logging

# Get a logger for your current module
LOGGER = logging.getLogger(__name__)

# Configure a handler (e.g., to console)
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
ch.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))

# Add the handler and set the level
LOGGER.addHandler(ch)
LOGGER.setLevel(logging.DEBUG)

You can interactively explore OWSLib functionality using Jupyter Notebooks. These notebooks are available online through Binder or can be viewed via NBViewer. The examples cover various service types, such as WMS (Web Map Service).

https://mybinder.org/v2/gh/geopython/OWSLib.git/master?filepath=docs/source/notebooks

To run OWSLib, you must have the following installed:

• A Python interpreter
• lxml for XML parsing

To install the tools required for the release process, install the package with the [release] extra.

pip install -e ".[release]"

The simplest way to install OWSLib is using the standard Python package manager, pip3.

pip3 install OWSLib