rest-solace
===============
**rest-solace** is a rest based python library for Solace Message Broker that allows you to Publish, Consume, & Manage!!
It is written with the intent to be easy to understand, functional, and pythonic.
Input and output parameters for every function is always one of int, float, str, bool, list, dict and None;
making them directly compatible with json data types.
| Check it out at `PyPI <https://pypi.org/project/rest-solace/>`_.
| View the code at `Github <https://github.com/skyler-guha/rest-solace/>`_.
| Read the docs from `Here <https://github.com/skyler-guha/rest-solace/blob/master/docs/index.rst/>`_.
Note:
| Right now the focus of this library is on the 'messaging' mode for solace message VPNs.
| In the future I plan to add better support for 'gateway' mode as well.
| This library currently uses SEMPv2 for management.
Getting started with Solace:
-----------------------------
If you are new to solace and confused about the terminology and workflows around it, it is **highly** recommended
that you read `this <https://github.com/skyler-guha/rest-solace/blob/master/docs/getting_started_with_solace.rst/>`_ document first.
It gives a brief explanation on the different components of solace; and that too within the context of this library.
|
Sending messages (for message-VPN in messaging mode):
-----------------------------------------------------
(Note: The single message sending functions in this example have async versions as well)
.. code-block:: python
from rest_solace import MessagingPublisher
publish = MessagingPublisher(user_name= "admin",
password=" admin",
host= BROKER_IP,
rest_vpn_port= VPN_PORT #For 'default' VPN it is 9000
)
#Publish to a queue and (only confirms if the message was received by the broker)
publish.direct_message_to_queue(queue_name= "my_queue",
message= "hello world!!")
#Publish for a topic string (only confirms if the message was received by the broker)
publish.direct_message_for_topic(topic_string= "test_topic",
message= "hello world!!")
#Publish to a queue and wait for confirmation on if the message was spooled into a queue
publish.persistent_message_to_queue(queue_name= "my_queue",
message= "hello world!!",
request_reply= False)
#Publish for a topic string and wait for confirmation on if the message was spooled into a queue
publish.persistent_message_for_topic(topic_string= "test_topic",
message= "hello world!!",
request_reply= False)
#Publish to a queue and wait for reply from a consumer
response = publish.persistent_message_to_queue(queue_name= "my_queue",
message= "hello world!!",
request_reply= True)
print(response)
#Publish for a topic string and wait for reply from a consumer
response = publish.persistent_message_for_topic(topic_string= "test_topic",
message= "hello world!!"
request_reply= True)
print(response)
|
Receiving messages and sending back a response:
-----------------------------------------------
(You can use your own REST server too. The one included with this library is only for simple uses and testing)
.. code-block:: python
from rest_solace import Consumer
consumer_obj = Consumer()
#Receive a single message and get the value returned to you.
incoming_message = consumer_obj.startConsumer(host= CONSUMER_HOST,
port= CONSUMER_PORT,
auto_stop= True #Required for single message mode
)
print(incoming_message)
#Keep receiving messages and handle them through a callback function
def return_uppercase(event:dict, kill_function):
"""Convert request message string to upper case to return as response.
Stops the consumer server if message is "kill".
Args:
event (dict): contains info about the received request.
kill_function (function): stops the consumer server if you run it.
Returns:
str: Returns the incoming message to the publisher in uppercase
"""
byte_string_content= event["content"][1:-1]
regular_string_content= byte_string_content.decode("utf-8")
uppercase_response= str.upper( regular_string_content )
if regular_string_content == "kill":
kill_function()
return uppercase_response
#You can run this function on a septate thread too if you want.
consumer_obj.startConsumer(host= CONSUMER_HOST,
port= CONSUMER_PORT,
callback_function= return_uppercase,
log= True)
|
Setting up a message VPN for message broking (in messaging mode):
------------------------------------------------------------------
(This is a bit advance but the library includes lots of utility functions to make initial setup easy)
.. code-block:: python
from rest_solace import Manager
manager = Manager(user_name= admin,
password= admin,
host= BROKER_IP,
semp_port= SEMP_PORT) #Default rest management port is 8080
#Creating a custom message VPN
#(can automatically apply required VPN configuration for rest based communication).
manager.create_message_vpn(
msgVpnName= NEW_VPN_NAME,
serviceRestIncomingPlainTextListenPort= VPN_PORT, #Assign it an unused port
serviceRestMode= "messaging" #auto configuration will be influenced by this parameter
)
#Automatically setting up your Message VPN for rest based communication
manager.auto_rest_messaging_setup_utility(
msgVpnName= NEW_VPN_NAME, #Existing message VPN
queueName= 'my_queue', #Creates a new queue
subscriptionTopic="test_topic", #The topic the queue should subscribe to
restDeliveryPointName='myRDP', #New RDP to handle incoming messages
restConsumerName= 'myConsumer', #A name for your consumer
remoteHost= CONSUMER_HOST,
remotePort= CONSUMER_PORT
)
#Doing the same setup manually (Shown for comparison)
manager.update_client_profile(msgVpnName= NEW_VPN_NAME,
clientProfileName= "default",
allowGuaranteedMsgReceiveEnabled= True,
allowGuaranteedMsgSendEnabled= True)
manager.update_client_username(msgVpnName=NEW_VPN_NAME,
clientUsername= "default",
enabled= True)
manager.create_queue_endpoint(queueName='my_queue', msgVpnName=NEW_VPN_NAME)
manager.subscribe_to_topic_on_queue(subscriptionTopic= "test_topic", queueName= 'my_queue')
manager.create_rest_delivery_point(msgVpnName= NEW_VPN_NAME,
restDeliveryPointName= 'myRDP',
clientProfileName= "default")
manager.specify_rest_consumer(msgVpnName= NEW_VPN_NAME,
restDeliveryPointName= 'myRDP',
restConsumerName= 'myConsumer',
remoteHost= CONSUMER_HOST,
remotePort= CONSUMER_PORT)
manager.create_queue_binding(msgVpnName= NEW_VPN_NAME,
restDeliveryPointName= 'myRDP',
queueBindingName= 'my_queue',
postRequestTarget= '/')
#Turning your RDP off and on again (Useful if solace has trouble connecting to your consumer)
manager.restart_rest_delivery_point(msgVpnName= NEW_VPN_NAME, restDeliveryPointName= 'myRDP')
..
_Note: Make sure to indent using spaces in the code blocks!
Raw data
{
"_id": null,
"home_page": null,
"name": "rest-solace",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Skyler Guha <skylerguha@gmail.com>",
"keywords": "solace, rest, REST API, rest-solace, rest_solace, rest solace, python, pythonic",
"author": null,
"author_email": "Skyler Guha <skylerguha@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/70/ab/afafdd2c9714bf6d25bd357c04fba29785848d54d3d7a01d9b47fda59d70/rest_solace-0.2.0.tar.gz",
"platform": null,
"description": "rest-solace\n===============\n\n**rest-solace** is a rest based python library for Solace Message Broker that allows you to Publish, Consume, & Manage!!\n\nIt is written with the intent to be easy to understand, functional, and pythonic.\nInput and output parameters for every function is always one of int, float, str, bool, list, dict and None; \nmaking them directly compatible with json data types. \n\n| Check it out at `PyPI <https://pypi.org/project/rest-solace/>`_.\n| View the code at `Github <https://github.com/skyler-guha/rest-solace/>`_.\n| Read the docs from `Here <https://github.com/skyler-guha/rest-solace/blob/master/docs/index.rst/>`_.\n\nNote: \n | Right now the focus of this library is on the 'messaging' mode for solace message VPNs.\n | In the future I plan to add better support for 'gateway' mode as well.\n | This library currently uses SEMPv2 for management. \n\nGetting started with Solace:\n-----------------------------\nIf you are new to solace and confused about the terminology and workflows around it, it is **highly** recommended \nthat you read `this <https://github.com/skyler-guha/rest-solace/blob/master/docs/getting_started_with_solace.rst/>`_ document first.\nIt gives a brief explanation on the different components of solace; and that too within the context of this library.\n\n|\n\nSending messages (for message-VPN in messaging mode):\n-----------------------------------------------------\n(Note: The single message sending functions in this example have async versions as well)\n\n.. code-block:: python\n\n from rest_solace import MessagingPublisher\n\n publish = MessagingPublisher(user_name= \"admin\", \n password=\" admin\", \n host= BROKER_IP, \n rest_vpn_port= VPN_PORT #For 'default' VPN it is 9000\n )\n\n #Publish to a queue and (only confirms if the message was received by the broker)\n publish.direct_message_to_queue(queue_name= \"my_queue\",\n message= \"hello world!!\")\n \n #Publish for a topic string (only confirms if the message was received by the broker)\n publish.direct_message_for_topic(topic_string= \"test_topic\", \n message= \"hello world!!\")\n\n\n #Publish to a queue and wait for confirmation on if the message was spooled into a queue\n publish.persistent_message_to_queue(queue_name= \"my_queue\", \n message= \"hello world!!\",\n request_reply= False) \n\n #Publish for a topic string and wait for confirmation on if the message was spooled into a queue\n publish.persistent_message_for_topic(topic_string= \"test_topic\", \n message= \"hello world!!\",\n request_reply= False)\n\n\n #Publish to a queue and wait for reply from a consumer\n response = publish.persistent_message_to_queue(queue_name= \"my_queue\", \n message= \"hello world!!\",\n request_reply= True) \n print(response)\n\n #Publish for a topic string and wait for reply from a consumer\n response = publish.persistent_message_for_topic(topic_string= \"test_topic\", \n message= \"hello world!!\"\n request_reply= True)\n print(response)\n\n|\n\nReceiving messages and sending back a response:\n-----------------------------------------------\n(You can use your own REST server too. The one included with this library is only for simple uses and testing)\n\n.. code-block:: python\n\n from rest_solace import Consumer\n\n consumer_obj = Consumer()\n\n #Receive a single message and get the value returned to you.\n incoming_message = consumer_obj.startConsumer(host= CONSUMER_HOST, \n port= CONSUMER_PORT, \n auto_stop= True #Required for single message mode\n )\n print(incoming_message)\n\n\n #Keep receiving messages and handle them through a callback function\n\n def return_uppercase(event:dict, kill_function):\n \"\"\"Convert request message string to upper case to return as response.\n Stops the consumer server if message is \"kill\".\n\n Args:\n event (dict): contains info about the received request.\n kill_function (function): stops the consumer server if you run it.\n Returns:\n str: Returns the incoming message to the publisher in uppercase\n \"\"\"\n byte_string_content= event[\"content\"][1:-1]\n regular_string_content= byte_string_content.decode(\"utf-8\")\n uppercase_response= str.upper( regular_string_content ) \n \n if regular_string_content == \"kill\":\n kill_function()\n \n return uppercase_response\n\n #You can run this function on a septate thread too if you want.\n consumer_obj.startConsumer(host= CONSUMER_HOST, \n port= CONSUMER_PORT,\n callback_function= return_uppercase, \n log= True) \n\n|\n\nSetting up a message VPN for message broking (in messaging mode):\n------------------------------------------------------------------\n(This is a bit advance but the library includes lots of utility functions to make initial setup easy)\n\n.. code-block:: python\n\n from rest_solace import Manager\n\n manager = Manager(user_name= admin, \n password= admin, \n host= BROKER_IP, \n semp_port= SEMP_PORT) #Default rest management port is 8080\n\n \n #Creating a custom message VPN \n #(can automatically apply required VPN configuration for rest based communication).\n manager.create_message_vpn(\n msgVpnName= NEW_VPN_NAME,\n serviceRestIncomingPlainTextListenPort= VPN_PORT, #Assign it an unused port\n serviceRestMode= \"messaging\" #auto configuration will be influenced by this parameter\n )\n\n \n #Automatically setting up your Message VPN for rest based communication\n manager.auto_rest_messaging_setup_utility(\n msgVpnName= NEW_VPN_NAME, #Existing message VPN\n queueName= 'my_queue', #Creates a new queue\n subscriptionTopic=\"test_topic\", #The topic the queue should subscribe to\n restDeliveryPointName='myRDP', #New RDP to handle incoming messages\n restConsumerName= 'myConsumer', #A name for your consumer\n remoteHost= CONSUMER_HOST, \n remotePort= CONSUMER_PORT\n )\n\n \n #Doing the same setup manually (Shown for comparison)\n manager.update_client_profile(msgVpnName= NEW_VPN_NAME, \n clientProfileName= \"default\",\n allowGuaranteedMsgReceiveEnabled= True,\n allowGuaranteedMsgSendEnabled= True)\n manager.update_client_username(msgVpnName=NEW_VPN_NAME, \n clientUsername= \"default\",\n enabled= True)\n manager.create_queue_endpoint(queueName='my_queue', msgVpnName=NEW_VPN_NAME)\n manager.subscribe_to_topic_on_queue(subscriptionTopic= \"test_topic\", queueName= 'my_queue')\n manager.create_rest_delivery_point(msgVpnName= NEW_VPN_NAME, \n restDeliveryPointName= 'myRDP', \n clientProfileName= \"default\")\n manager.specify_rest_consumer(msgVpnName= NEW_VPN_NAME, \n restDeliveryPointName= 'myRDP',\n restConsumerName= 'myConsumer',\n remoteHost= CONSUMER_HOST,\n remotePort= CONSUMER_PORT)\n manager.create_queue_binding(msgVpnName= NEW_VPN_NAME,\n restDeliveryPointName= 'myRDP',\n queueBindingName= 'my_queue',\n postRequestTarget= '/')\n\n\n #Turning your RDP off and on again (Useful if solace has trouble connecting to your consumer)\n manager.restart_rest_delivery_point(msgVpnName= NEW_VPN_NAME, restDeliveryPointName= 'myRDP')\n\n \n\n\n \n..\n _Note: Make sure to indent using spaces in the code blocks!\n",
"bugtrack_url": null,
"license": "apache 2.0",
"summary": "REST API library for Solace Message Broker. Publish, Consume, & Manage!!",
"version": "0.2.0",
"project_urls": {
"documentation": "https://github.com/skyler-guha/rest-solace/blob/master/docs/index.rst",
"pypi": "https://pypi.org/project/rest-solace/",
"repository": "https://github.com/skyler-guha/rest-solace"
},
"split_keywords": [
"solace",
" rest",
" rest api",
" rest-solace",
" rest_solace",
" rest solace",
" python",
" pythonic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ae2a5ebdaf83b48415de7eaf49bd2c36f9af117a23a38259879a0caf7ac3f1a",
"md5": "2fe2fadb15d3f5303f8acbe44e8bf10b",
"sha256": "ffade38de79cc9412759313745305ecf4daa3cd1506e47856efa738eef5aa735"
},
"downloads": -1,
"filename": "rest_solace-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fe2fadb15d3f5303f8acbe44e8bf10b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 52331,
"upload_time": "2024-05-19T20:20:16",
"upload_time_iso_8601": "2024-05-19T20:20:16.908646Z",
"url": "https://files.pythonhosted.org/packages/0a/e2/a5ebdaf83b48415de7eaf49bd2c36f9af117a23a38259879a0caf7ac3f1a/rest_solace-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "70abafafdd2c9714bf6d25bd357c04fba29785848d54d3d7a01d9b47fda59d70",
"md5": "c11a788f840896b72eafbae70f51351f",
"sha256": "95b2570afa8949edb74cae6d19038496259034a8c2a788a5e0eb7e655319f787"
},
"downloads": -1,
"filename": "rest_solace-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c11a788f840896b72eafbae70f51351f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 49571,
"upload_time": "2024-05-19T20:20:18",
"upload_time_iso_8601": "2024-05-19T20:20:18.738175Z",
"url": "https://files.pythonhosted.org/packages/70/ab/afafdd2c9714bf6d25bd357c04fba29785848d54d3d7a01d9b47fda59d70/rest_solace-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-19 20:20:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "skyler-guha",
"github_project": "rest-solace",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rest-solace"
}
JSON
