Commits

Anonymous committed 6e65d98

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/sboz/osa/wiki
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+Welcome to osa's documentation!
+===================================
+
+*osa* is a fast/slim library to consume `WSDL 1.1`_/`SOAP 1.1`_ services.
+It is created with the following three requirements in mind: fast calls,
+small memory footprint and convenience of use. I was not able to find a library
+that meets all my requirements, especially for large messages (millions of
+elements). Therefore I created this library by combining ideas found in
+`suds`_ (nice printing), `soaplib`_ (serialization/deserialization) and
+`Scio`_ (`WSDL 1.1`_ parsing).
+
+At the moment the library is limited to wrapped document/literal `SOAP 1.1`_
+convention. To include other call conventions one has to extend the
+:py:func:`to_xml` and :py:func:`from_xml` methods of the :py:class:`Message`
+:ref:`class <methods>`. The structure of the library is briefly explained
+:ref:`here <Structure>`. The *XML* processing is performed with the
+help of :py:mod:`cElementTree` module.
+
+To install the library please do the usual *Python* magic:
+{{{
+    >>> python setup.py install
+}}}
+
+Online help is available for all classes, please see also section
+:ref:`using` for examples.
+
+
+
+
+
+
+== Welcome ==
+
+Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
+
+=== Wiki features ===
+
+This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
+
+The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
+
+Go ahead and try:
+
+{{{
+$ hg clone http://bitbucket.org/sboz/osa/wiki
+}}}
+
+Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
+
+=== Syntax highlighting ===
+
+You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
+
+Here's an example of some Python code:
+
+{{{
+#!python
+
+def wiki_rocks(text):
+	formatter = lambda t: "funky"+t
+	return formatter(text)
+}}}
+
+You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
+
+Have fun!