SOAPpy - Simple to use SOAP library for Python

Current Maintainer:

Gregory R. Warnes <>

Original Authors:

Cayce Ullman <> Brian Matthews <>

Contributions by:

Christopher Blunck <> Brad Knotwell <> Mark Bucciarelli <> (ported WSDL

client from ZSI)

Ivan R. Judson <> (Globus support) Kirk Strauser <> Antonio Beamud Montero <> (patches

for integrating SOAPpy into Zope)

And others.

Copyright (c) 2002-2005, Pfizer, Inc. Copyright (c) 2001, Cayce Ullman. Copyright (c) 2001, Brian Matthews. All rights reserved, see the file LICENSE for conditions of use.


The goal of the SOAPpy team is to provide a full-featured SOAP library for Python that is very simple to use and that fully supports dynamic interaction between clients and servers.

  • General SOAP Parser based on sax.xml
  • General SOAP Builder
  • SOAP Proxy for RPC client code
  • SOAP Server framework for RPC server code
  • Handles all SOAP 1.0 types
  • Handles faults
  • Allows namespace specification
  • Allows SOAPAction specification
  • Homogeneous typed arrays
  • Supports multiple schemas
  • Header support (mustUnderstand and actor)
  • XML attribute support
  • Multi-referencing support (Parser/Builder)
  • Understands SOAP-ENC:root attribute
  • Good interop, passes all client tests for Frontier, SOAP::LITE, SOAPRMI
  • Encodings
  • SSL clients (with Python compiled with OpenSSL support)
  • SSL servers (with Python compiled with OpenSSL support and M2Crypto installed)
  • Encodes XML tags per SOAP 1.2 name mangling specification (Gregory Warnes)
  • Automatic stateful SOAP server support (Apache v2.x) (blunck2)
  • WSDL client support
  • WSDL server support
  • Timeout on method calls
  • Advanced arrays (sparse, multidimensional and partial)
  • Attachments
  • mod_python example
  • medusa example
  • Improved documentation


README This file RELEASE_NOTES General information about each release ChangeLog Detailed list of changes TODO List of tasks that need to be done Python installation control files MANIFEST

SOAPpy.spec* RPM package control file


SOAPpy/* Source code for the package SOAPpy/wstools/* Source code for WSDL tools tests/* unit tests and examples validate/* interop client and servers bid/* N+I interop client and server doc/* Documentation contrib/ Contributed examples (also see test/) docs/ Documentation tools/ Misc tools useful for the SOAPpy developers zope/ Patches to Zope allowing it to provide SOAP services


As of version 0.9.8 SOAPpy can be installed using the standard python package installation tools.

To install:

  1. Unpack the distribution package:

    On Windows, use your favorite zip file uncompression tool.

    On Unix:

    $ tar -xvzf SOAPpy-$VERSION$.tar.gz

    if you have gnu tar, otherwise

    $ gzcat SOAPpy-$VERSION$.tar.gz | tar -xvf -

  2. Change into the source directory

    $ cd SOAPpy-$VERSION$

  3. Compile the package

    $ python build

  4. Install the package

    On Windows:

    $ python install

    On Unix install as the owner of the python directories (usally root):

    $ su root Password: XXXXXX $ python install


A simple "Hello World" http SOAP server:

import SOAPpy def hello():

return "Hello World"

server = SOAPpy.SOAPServer(("localhost", 8080)) server.registerFunction(hello) server.serve_forever()

And the corresponding client:

import SOAPpy server = SOAPpy.SOAPProxy("http://localhost:8080/") print server.hello()

Mark Pilgrims' _Dive Into Python_, published in printed form by Apress and online at at provides a nice tutorial for SOAPpy in Chapter 12, "SOAP Web Services". See .

For further information see the files in the docs/ directory.

Note that documentation is one of SOAPpy's current weak points. Please help us out!


Please submit bug reports, feature requests, patches, etc at the Python Web Services web site:

Please address questions and general discussion to the pywebsvcs-talk mailing list,

For subscription information visit List archives are available at

Please remember that the authors do have day jobs, so please try the mailing list before contacting them directy.

$Id: README,v 1.18 2005/02/22 15:58:35 warnes Exp $