rinse

Rinse is a Python SOAP client using lxml, requests and defusedxml.

Latest Version Latest Version Documentation Build Status Coverage

Rinse works with both Python 2 and Python 3. Continuous integration testing is performed against the latest python 2.7, python 3.3 and python 3.4 releases.

The name “rinse” refers to its dictionary meaning, such as the act of removing soap suds from something using water.

The goal of rinse is to be a SOAP client that focuses on the minimum set of features required to make SOAP calls to services over HTTP/HTTPS. Support for common SOAP extensions including WSA (WS-Addressing) and WSSE (WS-Security) is provided. Rinse supports the WS-I Basic Profile Version 2.0 specification in principle, but takes a pragmatic approach to achieving compliance based upon further goals and constraints outlined below.

Using rinse as part of a SOAP service (SOAP server) is not supported. We recommend servers should use JSON for data interchange over RESTful HTTP(S) rather than providing SOAP services. And we’re not the only ones - Google announced its plans to abandon SOAP way back in 2009.

Security is improved by using the defusedxml library to parse XML data thereby minimising risks associated with parsing and processing data from untrusted sources. TODO: SSL certificate pinning to ensure that clients using rinse only disclose information to and parse information from intended servers.

Rinse has support for validating SOAP messages against the schema specified in XSD (XML schema definition) format within a given WSDL file, but is not capable of generating SOAP service bindings at runtime. Future development may provide support for generating bindings from WSDL in the form of Python source files. Dynamic (runtime) binding is unlikely to be supported.

Installation:

Rinse is available for installation direct from PyPi:

pip install rinse

Indices and tables

Changelog

0.4.0

  • Use @cached_property to simplify property code.
  • Fix AttributeError when debugging.
  • Include missing XSD files in wheel distributions.
  • Ensure XSD files exist in distributed files via tox test suite options.

0.3.0

  • Add ‘SOAPAction’ header to requests.
  • Expose requests.Session.
  • Include missing XSD files in package data.
  • Add Python 3.4 to test builds.

0.2.0

0.1.3

  • Add links to README.

0.1.2

  • Added Sphinx documentation.

0.1.1

  • Add ElementMaker wrapper class and safe_parse_url function.
  • Add travis-ci.org build configuration.
  • Split features into submodules.

0.1.0

  • Support for WSDL.
  • Simplified usage through use of SoapClient and SoapMessage classes.

0.0.5

  • Pylint/PEP8/pychecker fixes.

0.0.4

  • Remove reference to stale source (client.py).

0.0.3

  • Add defused.xml to requirements.

0.0.2

  • Validate messages against SOAP 1.1 Envelope and SOAP 1.2 XML schema.
  • Add support for WSSE (Security) headers.

0.0.1

  • Generate SOAP requests and parse SOAP 1.1 responses.

License

The MIT License (MIT)

Copyright (c) 2014 Tyson Clugg

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.