MigratoryData Python Client API can be downloaded from here. The API works with Python version 3.0.1 or more recent.

A demo application on how to use the API is on github. Clone the repo using command:

git clone https://github.com/migratorydata/getting-started-python-client-api.git

The client application connects to the MigratoryData server deployed at localhost:8800 and publishes a message every second on the subject /server/status.

If you don’t have a MigratoryData server installed on your machine but there is docker installed you can run the following command to start MigratoryData server, otherwise you can download and install the latest version for your os from here.

docker pull migratorydata/server:latest
docker run --platform linux/amd64 -d --name my_migratorydata -p 8800:8800 migratorydata/server:latest

Next, run the application using command:

python sample

A typical API usage is as follows:

Step 1 - Include the library

For using this API please reference in your application the file migratorydata_client.py which is located in the folder lib of the SDK package.

Use the following to include the library:

from migratorydata_client import *

Step 2 - Define a listener to get messages and status notifications

The listener should implement the MigratoryDataListener interface.

Use the API call MigratoryDataClient.set_listener() to attach your listener implementation.

Step 3 - Specify where to connect to

Specify a cluster of one or more MigratoryData servers to which the Python client will connect to using the API method MigratoryDataClient.set_servers(). In fact, the client will connect to only one of the MigratoryData servers in this list. But, defining two or more MigratoryData servers is recommended in order to achieve fail-over. Supposing the MigratoryData server to which the client connected goes down, then the API will automatically reconnect the client to another MigratoryData server in the list.

Step 4 - Connect to the MigratoryData cluster

Use the API method MigratoryDataClient.connect() to connect to the cluster and start receiving real-time messages from the MigratoryData cluster as well as status notifications.

Step 5 - Subscribe to subjects and publish messages

Use the API method MigratoryDataClient.subscribe() to specify interest in receiving real-time messages having as subjects the strings provided in the parameter of this API method. You can call the API method MigratoryDataClient.subscribe() at any time to subscribe to further subjects. To unsubscribe from subscribed subjects, use the API method MigratoryDataClient.unsubscribe().

Use the API method MigratoryDataClient.publish() to publish messages.

Step 6 - Handle the real-time messages and status notifications

Handle the messages received for the subscribed subjects as well as the status notifications in your listener implementation defined at Step 2 above.


Examples built with this API are available in the folder examples of this SDK package. Start with the README file which explains how to run them.