Skip to main content

Web Services Made Easy

Introduction

Web Services Made Easy (WSME) simplifies the writing of REST web services by providing simple yet powerful typing, removing the need to directly manipulate the request and the response objects.

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

WSME is originally a rewrite of TGWebServices with a focus on extensibility, framework-independence and better type handling.

How Easy?

Here is a standalone WSGI example:

from wsme import WSRoot, expose

class MyService(WSRoot):
    @expose(unicode, unicode)  # First parameter is the return type,
                               # then the function argument types
    def hello(self, who=u'World'):
        return u"Hello {0} !".format(who)

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:

URL

Returns

http://<server>/ws/hello.json?who=you

"Hello you !"

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 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.

Install

pip install WSME

Changes

Getting Help

Contribute

Metadata

Release files for WSME 0.13.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for WSME 0.13.0
File Size Uploaded
wsme-0.13.0.tar.gz 90.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for WSME 0.13.0
File Interpreter ABI Platform
wsme-0.13.0-py3-none-any.whl Python 3 none any Details

Total release size: 150.1 kB

Release files / wsme-0.13.0.tar.gz

Download URL wsme-0.13.0.tar.gz
Size 90.3 kB
Tags Source
SHA-256 checksum
How to use checksums
5bf32010ed943ecfb3f08795a4602e2683df5d5ea8cc71eaf1ebe3f449f39833
BLAKE2b-256 checksum
How to use checksums
2b78b78fda48cc560127744fb7349945a7af5f4de94a77d2b08f204aa22389b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release files / wsme-0.13.0-py3-none-any.whl

Download URL wsme-0.13.0-py3-none-any.whl
Size 59.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
88306aa06cbe70133b442fe1e84a29f99c11a2298a204d8fbaa789ead3df814b
BLAKE2b-256 checksum
How to use checksums
bc2afd83f417e4896e68806c4b906aaaa9b8cadf85cf1ddfa3f4f6943945c280
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page