Zeep: Python SOAP client

A fast and modern Python SOAP client

Highlights:
  • Compatible with Python 2.7, 3.3, 3.4, 3.5, 3.6 and PyPy
  • Build on top of lxml and requests
  • Support for Soap 1.1, Soap 1.2 and HTTP bindings
  • Support for WS-Addressing headers
  • Support for WSSE (UserNameToken / x.509 signing)
  • Experimental support for asyncio via aiohttp (Python 3.5+)

A simple example:

from zeep import Client

client = Client('http://www.webservicex.net/ConvertSpeed.asmx?WSDL')
result = client.service.ConvertSpeed(
    100, 'kilometersPerhour', 'milesPerhour')

assert result == 62.137

Quick Introduction

Zeep inspects the WSDL document and generates the corresponding code to use the services and types in the document. This provides an easy to use programmatic interface to a SOAP server.

The emphasis is on SOAP 1.1 and SOAP 1.2, however Zeep also offers support for HTTP Get and Post bindings.

Parsing the XML documents is done by using the lxml library. This is the most performant and compliant Python XML library currently available. This results in major speed benefits when processing large SOAP responses.

The SOAP specifications are unfortunately really vague and leave a lot of things open for interpretation. Due to this there are a lot of WSDL documents available which are invalid or SOAP servers which contain bugs. Zeep tries to be as compatible as possible but there might be cases where you run into problems. Don’t hesitate to submit an issue in this case (but please first read Reporting bugs).

Installation

Zeep is a pure-python module. This means that there is no C code which needs to be compiled. However the lxml dependency does contain C code since it uses libxml2 and libxslt. For linux/bsd this means you need to install libxml2-dev and libxslt-dev packages. For Windows this is unfortunately a bit more complicated. The easiest way is to install lxml via wheel files since that contains already compiled code for your platform.

To install wheel files you need a recent pip client. See https://pip.pypa.io/en/stable/installing/ how to install pip on your platform.

If you have installed pip then run:

pip install zeep

This assumes that there are wheel files available for the latest lxml release. If that is not the case (https://pypi.python.org/pypi/lxml/) then first install lxml 3.7.1 since that release should have the wheel files for all platforms:

pip install lxml==3.7.1 zeep

When you want to use wsse.Signature() you will need to install the python xmlsec module. This can be done by install the xlmsec extras:

pip install zeep[xmlsec]

For the asyncio support in Python 3.5+ the aiohttp module is required, this can be installed with the async extras:

pip install zeep[async]

Getting started

The first thing you generally want to do is inspect the wsdl file you need to implement. This can be done with:

python -mzeep <wsdl>

See python -mzeep --help for more information about this command.

Note

Since this module hasn’t reached 1.0.0 yet their might be minor releases which introduce backwards compatible changes. While I try to keep this to a minimum it can still happen. So as always pin the version of zeep you used (e.g. zeep==0.24.0‘).

A simple use-case

To give you an idea how zeep works a basic example.

import zeep

wsdl = 'http://www.soapclient.com/xml/soapresponder.wsdl'
client = zeep.Client(wsdl=wsdl)
print(client.service.Method1('Zeep', 'is cool'))

The WSDL used above only defines one simple function (Method1) which is made available by zeep via client.service.Method1. It takes two arguments and returns a string. To get an overview of the services available on the endpoint you can run the following command in your terminal.

python -mzeep http://www.soapclient.com/xml/soapresponder.wsdl

API Documentation

Support

If you encounter bugs then please let me know . Please see Reporting bugs for information how to best report them.

I’m also able to offer commercial support. As in contracting work. Please contact me at info@mvantellingen.nl for more information. If you just have a random question and don’t intent to actually pay me for my support then please DO NOT email me at that e-mail address but just use stackoverflow or something..