Python 3 package to do client operations on web service respecting Open Geospatial Consortium (OGC) standard.

Sometime in the future the package will be on pypi and there will be a .deb or .rpm package, but for now you will need to do

python3 setup.py install

This package is develloped and tested on a linux machine it should work on other platform, but there are no guaranties and no support for it. This is a python3 package since python2 end of life is supposed to be on January the first 2020, I will neighter devellope nor support for python2 (python2 needs to die and thus I don't believe in it anymore).

This is a list of package that Mapycli relies on.

• requests

This package is under MIT license, for more information look in LICENSE file.

This is a complete and exaustiv documentation of how to use the package.

To import the package in your program use:

import mapycli

Although the creation of a session is not mandatory to do requests, it is highly recommanded to use them because it add a lot of functionality and they can make your life easier. A session is an object that will keep in memory some parameters and most importantly the information about ressource available on the server. Session are service specific ('WMS','WFS','WCS','WPS','CWS')

To create a session you should do:

se = mapycli.service.session()

Here service should be replaced by the name of the service e.g. mapycli.WMS.session(). This opperation will create an empty session.

If you want to create a session and to a getcapabilities at the same time:

se = mapycli.service.session(URL,*args,**kargs)

Sessions allow 3 type of opperation to control it.

The add opperation enables you to add a source to the session and ask for the getcapabilities of this source. This method returns a getCapabilitiesObject.

re = se.add(URL)

The update opperation enables you to update the informations about the layers. You can do an update on every layers by doing

se.update()

In this case the session will go threw every layer and do a getcapabilities on every different source available. You can also add all arguments allowed by a the getcapabilities requests (including vendor extention) (for more information go see getcapabilities to do an update on somme of the layers.

se.update(url)

The update opperation only add layers and replace the one that already exist with new ones, it will not erase the ones that aren't provided anymore by the server. Therefor, it might not be consistent with the state of the server. If you want full consistency with the server use reset

This opperation will remove the old information about layers in the session. You can reset every layer in the session by doing

se.reset()

If you want to do a reset and then add a specific source you can pass all the getcapabilities parameters. e.g.

se.reset(url)

This opperation will not touch other parameters set in session.

If you want to change the default version tag used to communicate with the web service you can change the version variable e.g.

se.version = "1.3.0"

The default values are:

If you want session requests to be automaticaly decoded with a seledted encoding e.g. utf-8 (so it's faster).

se.autoDecode = "utf-8"

not available yet

This section will list every WMS supported opperations available. Note that wms session object support all of these opperations e.g. The function call

mapycli.wms.getcapabilities(*args,**kargs)

will translate to

se.getcapabilities(*args,**args)

Note:

It is important to note that since mapycli is using requests under the houd you can always add any parameters to your request (usefull for vendor support) and you force mapycli to not send a default parameter by explicitily setting it to None

usage

getCapRes = mapycli.wms.getcapabilities(url,service="WMS",request="GetCapabilities",version="1.3.0",format="application/vnd.ogc.se_xml",**kargs)

every kargs given to getcapabilities will be url encoded and passed directly to the server. The function returns a getCapabilitiesObject object. If the format of the server response is the default one (application/xml) mapycli will parse the response, otherwise the only functionality provided by getCapabilitiesObject will be the

Res = getCapRes.response

This will return you the requests response

If you want to go threw the basic parsing of the xml file you can use getCapDict. This variable is a dictionary that contains lists of every tags with their respective values. Therefore, the content of every tags with a given label at root level are assembled together in a list and placed in the dict with their label as key.

The value stored in the list paired with the key is a tuple of lenght 3. The first element is a dict of tags, if the tag has children, they will be stored in this element. The second element is a dict of the attributes, the key is the name of the attribute and the value is the value of the attribute. The third element of the tuple is the value stored in the tag.

e.g.

dic = getCapRes.getCapDict
# Accessing all 'Service' tags
serv = dic['Service']
# Accessing the first Service tag
s = serv[0]

If you want to go threw a well parsed hierarchy using OGC standard you can use getCapStruct.

e.g.

val = getCapRes.getCapStruct.service.title

val will then have the value of the <Title> tag in <service> tag. Here is a list of all the supported tags and their place in the getCapStruct object.

Inheritance of layers properties is manage with the folowing:

If you want to have the list of the layer name you can call the getLayers method.

e.g.

layers = getCapRes.getLayers()

This package is developed threw documentation driven developement (DDD). If you want to commit a change, the documentation should be the first thing you touch. No pull request without a change in the doc will be merged.

Every document consulted to make this package will be listed here.

• OWSLib