OWSLib
Overview
OWSLib is a Python package for client programming with Open Geospatial Consortium (OGC) web service (hence OWS) interface standards, and their related content models.
Full documentation is available at https://owslib.readthedocs.io
OWSLib provides a common API for accessing service metadata and wrappers for numerous OGC Web Service interfaces.
Installation
The easiest way to install OWSLib is via the Python pip utility:
pip3 install OWSLib
Requirements
- Python 3
- virtualenv
Dependencies
Dependencies are listed in pyproject.toml. Dependencies are automatically installed during OWSLib installation.
Installing OWSLib
# setup virtualenv
python3 -m venv owslib
cd owslib
source bin/activate
# clone codebase and install
git clone https://github.com/geopython/OWSLib.git
cd OWSLib
pip3 install .
Running
Find out what a WMS has to offer. Service metadata:
>>> from owslib.wms import WebMapService
>>> wms = WebMapService('http://wms.jpl.nasa.gov/wms.cgi', version='1.1.1')
>>> wms.identification.type
'OGC:WMS'
>>> wms.identification.version
'1.1.1'
>>> wms.identification.title
'JPL Global Imagery Service'
>>> wms.identification.abstract
'WMS Server maintained by JPL, worldwide satellite imagery.'
Available layers::
>>> list(wms.contents)
['us_landsat_wgs84', 'modis', 'global_mosaic_base', 'huemapped_srtm',
'srtm_mag', 'daily_terra', 'us_ned', 'us_elevation', 'global_mosaic',
'daily_terra_ndvi', 'daily_aqua_ndvi', 'daily_aqua_721', 'daily_planet',
'BMNG', 'srtmplus', 'us_colordem', None, 'daily_aqua', 'worldwind_dem',
'daily_terra_721']
Details of a layer::
>>> wms['global_mosaic'].title
'WMS Global Mosaic, pan sharpened'
>>> wms['global_mosaic'].boundingBoxWGS84
(-180.0, -60.0, 180.0, 84.0)
>>> wms['global_mosaic'].crsOptions
['EPSG:4326', 'AUTO:42003']
>>> wms['global_mosaic'].styles
{'pseudo_bright': {'title': 'Pseudo-color image (Uses IR and Visual bands,
542 mapping), gamma 1.5'}, 'pseudo': {'title': '(default) Pseudo-color
image, pan sharpened (Uses IR and Visual bands, 542 mapping), gamma 1.5'},
'visual': {'title': 'Real-color image, pan sharpened (Uses the visual
bands, 321 mapping), gamma 1.5'}, 'pseudo_low': {'title': 'Pseudo-color
image, pan sharpened (Uses IR and Visual bands, 542 mapping)'},
'visual_low': {'title': 'Real-color image, pan sharpened (Uses the visual
bands, 321 mapping)'}, 'visual_bright': {'title': 'Real-color image (Uses
the visual bands, 321 mapping), gamma 1.5'}}
Available methods, their URLs, and available formats::
>>> [op.name for op in wms.operations]
['GetTileService', 'GetCapabilities', 'GetMap']
>>> wms.getOperationByName('GetMap').methods
{'Get': {'url': 'http://wms.jpl.nasa.gov/wms.cgi?'}}
>>> wms.getOperationByName('GetMap').formatOptions
['image/jpeg', 'image/png', 'image/geotiff', 'image/tiff']
That's everything needed to make a request for imagery::
>>> img = wms.getmap( layers=['global_mosaic'],
... styles=['visual_bright'],
... srs='EPSG:4326',
... bbox=(-112, 36, -106, 41),
... size=(300, 250),
... format='image/jpeg',
... transparent=True
... )
>>> out = open('jpl_mosaic_visb.jpg', 'wb')
>>> out.write(img.read())
>>> out.close()
A very similar API exists for WebFeatureService. See tests/wfs_MapServerWFSCapabilities.txt for details.
There is also support for Web Coverage Service (WCS), Catalogue Service for the Web (CSW), Web Processing Service (WPS), and Web Map Tile Service (WMTS). Some of those are beta quality.
Logging
OWSLib logs messages to module-based named Python loggers. You may configure your application to use the log messages like so:
>>> import logging
>>> LOGGER = logging.getLogger(__name__)
>>> # Add formatting and handlers as needed, for example to log to the console
>>> ch = logging.StreamHandler()
>>> ch.setLevel(logging.DEBUG)
>>> ch.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
>>> # add the handler to the logger
>>> LOGGER.addHandler(ch)
>>> LOGGER.setLevel(logging.DEBUG)
Releasing
# update version
vi pyproject.toml # update [project]/version
git commit -m 'update release version' owslib/pyproject.toml
# push changes
git push origin master
git tag -a x.y.z -m 'tagging OWSLib release x.y.z'
# push tag
git push --tags
# update on PyPI (must be a maintainer)
rm -fr build dist *.egg-info
python3 -m build
twine upload dist/*
Support
4 maintainers
Release files for owslib 0.36.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| owslib-0.36.0.tar.gz | 196.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| owslib-0.36.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 437.4 kB
Release files / owslib-0.36.0.tar.gz
| Download URL | owslib-0.36.0.tar.gz |
|---|---|
| Size | 196.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b1ea352ee84f37a1a8ae44122b13cbd3b5b7bf9af0f74d84fe9ed7d9613b9543
|
|
BLAKE2b-256 checksum How to use checksums |
105df2b14a61454bc290c48786c1521f7c9e60996cb0d207b544feb722c82dee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.11
|
Release files / owslib-0.36.0-py3-none-any.whl
| Download URL | owslib-0.36.0-py3-none-any.whl |
|---|---|
| Size | 241.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ffe9168684fe091b18985e9368ff88b8419634d773c8566f14347c0ff6fc5aff
|
|
BLAKE2b-256 checksum How to use checksums |
6871c64b65fba54bda45948aec187b5199ccee01c538214e51aff1fc795b5cc0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.11
|
