Skip to main content
Backplane Client Library for Python
===================================

This library integrates server side Backplane clients with the Backplane server protocol (https://github.com/janrain/janrain-backplane-2).

Installation
============
```shell
pip install backplane2-pyclient
```

Usage
=====

You should have client credentials for a Backplane server, with a bus provisioned for your use. If you have admin access to a backplane server, the following steps will get you set up:

1. Provision a client (/v2/provision/client/update)
2. Provision a bus (/v2/provision/bus/update)
3. Grant client access to bus (/v2/provision/grant/add)

For more information see the [Backplane server readme](https://github.com/janrain/janrain-backplane-2/blob/master/README20.md).

Example:

```python
import backplane
from backplane import ClientCredentials, Client, Message, channel_from_scope

backplane.debug() # Enable debugging output

client_credentials = ClientCredentials('https://backplane1.janrainbackplane.com', 'client id', 'secret')
client = Client(client_credentials, True, 'bus:mybusname')
access_token = client.get_regular_token('mybusname')
channel = channel_from_scope(access_token.scope)
message = Message('mybusname', channel, 'test', 'payload', True)
client.post_message(message)

# Poll server for messages
message_wrapper = None
while True:
# connect to Backplane server for 20 seconds at a time
message_wrapper = client.get_messages(message_wrapper, 20)
...
```

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backplane2-pyclient-0.2.tar.gz (8.0 kB view details)

Uploaded Source

File details

Details for the file backplane2-pyclient-0.2.tar.gz.

File metadata

File hashes

Hashes for backplane2-pyclient-0.2.tar.gz
Algorithm Hash digest
SHA256 d63cae12d7c70ea8cdd8548c6369089514790989249c226e226d8e7fff1bc412
MD5 012ad5781fd9d1a0cb9dd8ff1a0351e0
BLAKE2b-256 f50c4af6c8d58806f0af620e88ed6f9851a3be28c2d54f50ecfe88e1148c2ec5

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2 This release

1 file

0.1

1 file

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