Python SOAP Client Libraries and Documentation

General Discussions
, ,
1

What Python SOAP client libraries are available, and where can I find their documentation?

I’m new to both SOAP and Python, and I’m exploring SOAP for learning purposes. I’ve installed SOAPlib and have tried to read the Client documentation, but I find it a bit unclear. Are there other SOAP client libraries for Python that are more user-friendly or better documented? Just to clarify, I am using Python 2.6.

2

Hey there! I’ve worked with SOAP in Python for a while now, and I can tell you this: the ecosystem has evolved a lot. As of 2016, if you’re looking for a solid and user-friendly SOAP client library, you should definitely check out the zeep library. It’s modern, well-maintained, and supports both Python 2 and 3, making it a great choice for your needs.

If you’re still exploring other options, here’s a quick rundown of popular Python SOAP libraries:

Older Libraries:

  • SOAPy: Was once a favorite but doesn’t work with Python 2.5+ and is no longer maintained.
  • ZSI: Includes a module named “SOAPpy” (different from the older SOAPy) but is quite tricky to use and slow to develop.

Newer Libraries:

  • SUDS: Easy to use and very Pythonic, but it doesn’t support Python 3. If you’re sticking with Python 2.6, this might be a good option.
  • SUDS-py3: A Python 3 fork of SUDS for those who have moved to modern Python.
  • spyne: Better for creating SOAP servers, though its client creation can be challenging. Documentation is hit or miss.
  • pysimplesoap: Lightweight and effective for both client and server use. Works with web2py too!
  • soaplib: A minimalistic library, great for building lightweight SOAP services.
  • osa: A slim, no-frills client library.

From personal experience, I’d recommend starting with zeep or SUDS (if Python 2 is your only option). Hope this helps!

3

Great insights from Tim! I’d like to emphasize his mention of zeep—this library has been a game-changer for working with Python SOAP services. It’s not just modern but also really simple to integrate into your projects. Plus, the documentation is clear and beginner-friendly, which is a big win when you’re new to SOAP.

As Tim pointed out, older libraries like SOAPy and ZSI aren’t practical anymore, especially with Python 2.6. I’d also second SUDS for Python 2 users—its Pythonic design makes it one of the easiest options out there. However, if you’re considering upgrading to Python 3 in the future, SUDS-py3 or zeep should be at the top of your list.

For lightweight needs, pysimplesoap is worth exploring. It’s particularly handy if you want a client-server combo in one package. But for your case, zeep might be the most future-proof choice.

4

I completely agree with both Tim and Ian—zeep is a solid recommendation for most modern SOAP use cases. But I’d like to dive a bit deeper into pysimplesoap, as it might fit your requirements if you’re experimenting with SOAP on Python 2.6.*

pysimplesoap is incredibly lightweight and straightforward, making it an excellent starting point for learning SOAP concepts without getting bogged down by complexity. It also works nicely with the web2py framework, which could be a bonus if you’re planning to explore web applications down the line.*

That said, for long-term use or more advanced SOAP services, zeep offers better tooling, especially if you’re willing to upgrade to Python 3 eventually. If server creation is in your future plans, spyne might be worth exploring, but keep in mind it leans more towards server-side tasks than client-side simplicity.

At the end of the day, the best choice depends on your specific use case. If you’re just starting out, my vote goes to pysimplesoap for simplicity or zeep for a more modern, comprehensive experience. Good luck on your SOAP journey!