Now read the long_description and the doc introduction from the README file.

This commit is contained in:
Christophe de Vienne 2011-10-22 15:59:24 +02:00
parent 259f94d8e8
commit 9ddfc01efb
4 changed files with 33 additions and 49 deletions

40
README
View File

@ -1,16 +1,36 @@
WSME
====
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 and framework-independance.
with focus on extensibility, framework-independance and better type handling.
Main features are:
Main features
~~~~~~~~~~~~~
- Very simple API
- Very simple API.
- Supports user defined complex types.
- Multi-protocol : REST+Json, REST+XML, SOAP, and more to come
- Multi-protocol : REST+Json, REST+XML, SOAP, and more to come.
- Extensible : easy to add more protocols or more base types.
- WSGI application : can be used within any web framework
- Depends on webob, simplegeneric (+ Genshi if you use SOAP)
- Integration in Sphinx for making clean documentation
- Framework independance : adapters are provided to easily integrate
your API in any web framework, for example a wsgi container,
turbogears, and more to come.
- Very few runtime dependencies: webob, simplegeneric
(+ Genshi if you use SOAP).
- Integration in Sphinx for making clean documentation with
sphinxcontrib-wsme (not released yet).
Install
~~~~~~~
.. code-block:: bash
easy_install WSME
Getting Help
~~~~~~~~~~~~
Questions about WSME should to the `python-wsme mailinglist`_.
Contribute
~~~~~~~~~~
:Report issues: `WSME issue tracker`_
:Source code: hg clone https://bitbucket.org/cdevienne/wsme/

View File

@ -4,42 +4,7 @@ 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 complex types.
- Multi-protocol : REST+Json, REST+XML, SOAP, 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, and more to come.
- Very few runtime dependencies: webob, simplegeneric
(+ Genshi if you use SOAP).
- Integration in Sphinx for making clean documentation with
sphinxcontrib-wsme (not released yet).
Install
~~~~~~~
.. code-block:: bash
easy_install WSME
Getting Help
~~~~~~~~~~~~
Questions about WSME should to the `python-wsme mailinglist`_.
Contribute
~~~~~~~~~~
:Report issues: `WSME issue tracker`_
:Source code: hg clone https://bitbucket.org/cdevienne/wsme/
.. include:: ../README
Contents
--------

View File

@ -4,6 +4,8 @@ from setuptools import setup
execfile(os.path.join('wsme', 'release.py'))
long_description = open("README").read()
setup(
name=name,
version=version,

View File

@ -2,9 +2,6 @@ name = "WSME"
version = "0.1.1"
description = "Web Services Made Easy"
long_description = """
Web Service Made Easy is a pure-wsgi and modular rewrite of TGWebServices.
"""
author = "Christophe de Vienne"
email = "python-wsme@googlegroups.com"