Now read the long_description and the doc introduction from the README file.
This commit is contained in:
parent
259f94d8e8
commit
9ddfc01efb
40
README
40
README
@ -1,16 +1,36 @@
|
|||||||
WSME
|
|
||||||
====
|
|
||||||
|
|
||||||
Web Service Made Easy (WSME) is a very easy way to implement webservices
|
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
|
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.
|
- 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.
|
- Extensible : easy to add more protocols or more base types.
|
||||||
- WSGI application : can be used within any web framework
|
- Framework independance : adapters are provided to easily integrate
|
||||||
- Depends on webob, simplegeneric (+ Genshi if you use SOAP)
|
your API in any web framework, for example a wsgi container,
|
||||||
- Integration in Sphinx for making clean documentation
|
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/
|
||||||
|
@ -4,42 +4,7 @@ Web Services Made Easy
|
|||||||
Introduction
|
Introduction
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Web Service Made Easy (WSME) is a very easy way to implement webservices
|
.. include:: ../README
|
||||||
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/
|
|
||||||
|
|
||||||
Contents
|
Contents
|
||||||
--------
|
--------
|
||||||
|
2
setup.py
2
setup.py
@ -4,6 +4,8 @@ from setuptools import setup
|
|||||||
|
|
||||||
execfile(os.path.join('wsme', 'release.py'))
|
execfile(os.path.join('wsme', 'release.py'))
|
||||||
|
|
||||||
|
long_description = open("README").read()
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name=name,
|
name=name,
|
||||||
version=version,
|
version=version,
|
||||||
|
@ -2,9 +2,6 @@ name = "WSME"
|
|||||||
version = "0.1.1"
|
version = "0.1.1"
|
||||||
|
|
||||||
description = "Web Services Made Easy"
|
description = "Web Services Made Easy"
|
||||||
long_description = """
|
|
||||||
Web Service Made Easy is a pure-wsgi and modular rewrite of TGWebServices.
|
|
||||||
"""
|
|
||||||
|
|
||||||
author = "Christophe de Vienne"
|
author = "Christophe de Vienne"
|
||||||
email = "python-wsme@googlegroups.com"
|
email = "python-wsme@googlegroups.com"
|
||||||
|
Loading…
Reference in New Issue
Block a user