x/wsme
Code Issues Proposed changes

Fix misc README issues

Browse Source 
Change-Id: I973a40a64c98433bb0112576615ec72e18b84485
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2019-05-01 16:57:41 -06:00
parent 2be89e587c
commit 64530e8eb5
1 changed files with 32 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.rst
View File

@ -12,17 +12,17 @@ WSME can work standalone or on top of your favorite Python web
(micro)framework, so you can use both your preferred way of routing your REST
requests and most of the features of WSME that rely on the typing system like:
- Alternate protocols, including those supporting batch-calls
- Easy documentation through a Sphinx_ extension
- Alternate protocols, including those supporting batch-calls
- Easy documentation through a Sphinx_ extension
WSME is originally a rewrite of TGWebServices
with a focus on extensibility, framework-independance and better type handling.
WSME is originally a rewrite of TGWebServices with a focus on extensibility,
framework-independence and better type handling.
How Easy ?
~~~~~~~~~~
How Easy?
~~~~~~~~~
Here is a standalone WSGI example::
Here is a standalone wsgi example::
from wsme import WSRoot, expose
class MyService(WSRoot):
@ -34,8 +34,8 @@ Here is a standalone wsgi example::
ws = MyService(protocols=['restjson', 'restxml'])
application = ws.wsgiapp()
With this published at the ``/ws`` path of your application, you can access
your hello function in various protocols:
With this published at the ``/ws`` path of your application, you can access your
hello function in various protocols:
.. list-table::
:header-rows: 1
@ -49,20 +49,24 @@ your hello function in various protocols:
* - ``http://<server>/ws/hello.xml``
- ``<result>Hello World !</result>``
Main features
~~~~~~~~~~~~~
- Very simple API.
- Supports user-defined simple and complex types.
- Multi-protocol : REST+Json, REST+XML and more to come.
- Extensible : easy to add more protocols or more base types.
- Framework independence : adapters are provided to easily integrate
your API in any web framework, for example a wsgi container,
Pecan_, Flask_, ...
- Very few runtime dependencies: webob, simplegeneric.
- Integration in `Sphinx`_ for making clean documentation with
``wsmeext.sphinxext``.
- Very simple API.
- Supports user-defined simple and complex types.
- Multi-protocol : REST+JSON, REST+XML and more possible.
- Extensible : easy to add more protocols or more base types.
- Framework independence : adapters are provided to easily integrate your API in
any web framework, for example an WSGI container, Pecan_, Flask_, ...
- Very few runtime dependencies: webob, simplegeneric.
- Integration in `Sphinx`_ for making clean documentation with
``wsmeext.sphinxext``.
.. _Pecan: http://pecanpy.org/
.. _Flask: http://flask.pocoo.org/
@ -74,30 +78,24 @@ Install
pip install WSME
or, if you do not have pip on your system or virtualenv
::
easy_install WSME
Changes
~~~~~~~
- Read the `Changelog`_
- Read the `Changelog`_
Getting Help
~~~~~~~~~~~~
- Read the `WSME Documentation`_.
- Questions about WSME should go to the `python-wsme mailinglist`_.
- Read the `WSME Documentation`_.
- Questions about WSME should go to the `python-wsme mailinglist`_.
Contribute
~~~~~~~~~~
* Documentation: http://packages.python.org/WSME/
* Source: http://git.openstack.org/cgit/openstack/wsme
* Bugs: https://bugs.launchpad.net/wsme/+bugs
* Code review: https://review.openstack.org/#/q/project:openstack/wsme,n,z
- Documentation: http://packages.python.org/WSME/
- Source: http://git.openstack.org/cgit/openstack/wsme
- Bugs: https://bugs.launchpad.net/wsme/+bugs
- Code review: https://review.openstack.org/#/q/project:openstack/wsme,n,z
.. _Changelog: http://packages.python.org/WSME/changes.html
.. _python-wsme mailinglist: http://groups.google.com/group/python-wsme