Skip to main content

Travis Python27 Python33 Python34 Python35 Python36

wampy

[whomp-ee]

WAMP RPC and Pub/Sub for your Python apps and microservices

This is a Python implementation of WAMP not requiring Twisted or asyncio, enabling use within classic blocking Python applications. It is a light-weight alternative to autobahn.

With wampy you can quickly and easily create your own WAMP clients, whether this is in a web app, a microservice, a script or just in a Python shell.

wampy tries to provide an intuitive API for your WAMP messaging.

See ReadTheDocs for more detailed documentation.

Quickstart: wampy from the command line

Before any messaging can happen you need a Router. Messages are then routed between Clients over an administrative domain on the Router called a Realm.

For the quickest of starts I suggest that you use Crossbar.io and start it up on the default host and port, and with the default realm and roles. See the Crossbar.io docs for the instructions on this or alternatively run with wampy’s testing setup.

$ pip install --editable .[dev]

$ crossbar start --config ./wampy/testing/configs/crossbar.json

wampy RPC

Now open your preferred text editor and we’ll write a few lines of Python constructing a simple WAMP service that takes a decimal number and returns the binary representation of it - wowzers!

from wampy.peers.clients import Client
from wampy.roles import callee

class BinaryNumberService(Client):

    @callee
    def get_binary_number(self, number):
        return bin(number)

Save this module somewhere on your Python path and we’ll use a wampy command line interface tool to start the service.

$ wampy run path.to.your.module.including.module_name:BinaryNumberService

For example, running one of the wampy example applications against the Router suggested previously:

$ wampy run docs.examples.services:DateService --config ./wampy/testing/configs/crossbar.json

Actually - no need to panic! The BinaryNumberService example already exists in the wampy examples so put that text editor away if you like. Just execute from the command line:

$ wampy run docs.examples.services:BinaryNumberService --config ./wampy/testing/configs/crossbar.json

Now, open a Python console in a new terminal, allowing the BinaryNumberService to run uninterupted in your original terminal (but once you’re done with it Ctrl-C is required).

In [1]: from wampy.peers.clients import Client

In [2]: from wampy.peers.routers import Crossbar

In [3]: router = Crossbar(config_path='./wampy/testing/configs/crossbar.json')

In [2]: with Client(router=router) as client:
            result = client.rpc.get_binary_number(number=100)

In [3]: result
Out[3]: u'0b1100100'

Note here that a Client takes a router argument which defaults to Crossbar. Crossbar then defaults to realm1 on localhost:8080. To use different values you’ll need to configure and pass in the router object to the client yourself. This isn’t hard, but when you’re developing locally these defaults are there to help you get up and running quickly.

wampy RPC for Crossbar.io

The RPC pattern above was inspired by the nameko project, but this pattern may not feel intuitive for those familiar with Crossbar.io, the primary Router used by wampy.

For this reason there also exists the CallProxy object which implements the call API by more loosely wrapping wampy’s Call Message. In this pattern, applications and their endpoints are identified by dot delimented strings rather than a single API name, e.g.

"com.example.endpoint"

Just like the rpc API, the call API is directly available on every wampy client. Lets look at the two examples side by side.

>>> client.rpc.get_foo_bar(eggs, foo=bar, spam=ham)
>>> client.call("get_foo_bar", eggs, foo=bar, spam=ham)

Noted these are very similar and achieve the same, but the intention here is for the call API to behave more like a classic Crossbar.io application and the rpc to be used in nameko_wamp.

The call API however does allow calls of the form…

>>> client.call("com.myapp.foo.bar", eggs, foo=bar, spam=ham)

…which you will not be able to do with the rpc API.

Publishing and Subscribing is equally as simple

To demonstrate, first of all you need a Subscriber. You can either create one yourself in a Python module (as a subclass of a wampy Client) or use the example Client already for you in docs.examples.services.

Here we use the said example service, but all a Subscriber is is a wampy Client with a method decorated by subscribe. Take a look and see for yourself in the examples.

Let’s start up that example service.

$ wampy run docs.examples.services:SubscribingService --config './wampy/testing/configs/crossbar.config.ipv4.json'

Now we have a service running that subscribes to the topic “foo”.

In another terminal, with a wampy virtualenv, you can create a Publisher - which is no different to any other wampy Client.

In [1]: from wampy.peers.clients import Client

In [2]: from wampy.peers.routers import Crossbar

In [3]: with Client(router=Crossbar()) as client:
            result = client.publish(topic="foo", message="spam")

Hopefully you’ll see any message you send printed to the screen where the example service is running. You’ll also see the meta data that wampy chooses to send.

See ReadTheDocs for more detailed documentation.

Running the tests

$ pip install --editable .[dev]
$ py.test ./test -v

Build the docs

$ pip install -r rtd_requirements.txt
$ sphinx-build -E -b html ./docs/ ./docs/_build/

If you like this project, then Thank You, and you’re welcome to get involved.

Metadata

Release files for wampy 0.9.6

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

Built distributions (wheels)

Table of built distributions (wheels) for wampy 0.9.6
File Interpreter ABI Platform Actions
wampy-0.9.6-py2.py3-none-any.whl Python 3, Python 2 none any Details for wampy-0.9.6-py2.py3-none-any.whl
wampy-0.9.6-py2-none-any.whl Python 2 none any Details for wampy-0.9.6-py2-none-any.whl

Total release size: 110.0 kB

Release files / wampy-0.9.6-py2.py3-none-any.whl

Download URL wampy-0.9.6-py2.py3-none-any.whl
Size 55.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
eda9829fcd7181588461d2748250ec4a05bfc615c5cdbe55adf48ea873f52ebf
BLAKE2b-256 checksum
How to use checksums
c6599b5e5fe456a6e3c19dccbda4a582ad414e3f75231eb9d09981a7cb28f43a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / wampy-0.9.6-py2-none-any.whl

Download URL wampy-0.9.6-py2-none-any.whl
Size 55.0 kB
Tags Python 2
SHA-256 checksum
How to use checksums
98633679195c533202102227d790c6118f438f989e9dd5185329ceba86016eee
BLAKE2b-256 checksum
How to use checksums
fe13ee23299e0c12688e77449bca41ded1d250d937394188f360ae37ab0dcf9b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for wampy 0.9.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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