wsme/README
Christophe de Vienne 4a9708d2d9 Update the sentense about Sphinx integration features
--HG--
extra : rebase_source : 52cee810aaa4dabac7089fe9b130d2578e71e3dd
2012-04-05 10:46:32 +02:00

50 lines
1.5 KiB
Plaintext

Web Services Made Easy
======================
Introduction
------------
Web Service Made Easy (WSME) is a very easy way to implement webservices
in your python web application. It is originally a rewrite of TGWebServices
with focus on extensibility, framework-independance and better type handling.
Main features
~~~~~~~~~~~~~
- Very simple API.
- Supports user defined simple and complex types.
- Multi-protocol : REST+Json, REST+XML, SOAP, ExtDirect and more to come.
- Extensible : easy to add more protocols or more base types.
- Framework independance : adapters are provided to easily integrate
your API in any web framework, for example a wsgi container,
turbogears...
- Very few runtime dependencies: webob, simplegeneric
(+ Genshi if you use SOAP).
- Integration in `Sphinx`_ for making clean documentation with
wsme.sphinxext (work in progress).
Install
~~~~~~~
::
easy_install WSME
Getting Help
~~~~~~~~~~~~
- Read the `WSME Documentation`_.
- Questions about WSME should to the `python-wsme mailinglist`_.
Contribute
~~~~~~~~~~
:Report issues: `WSME issue tracker`_
:Source code: hg clone https://bitbucket.org/cdevienne/wsme/
:Jenkins: https://jenkins.shiningpanda.com/wsme/job/wsme/
.. _python-wsme mailinglist: http://groups.google.com/group/python-wsme
.. _WSME Documentation: http://packages.python.org/WSME/
.. _WSME issue tracker: https://bitbucket.org/cdevienne/wsme/issues?status=new&status=open
.. _Sphinx: http://sphinx.pocoo.org/