diff --git a/README.md b/README.md index 45d4efbd67f980604363350fa6e696aca5a6b674..8aaac097dc08a439f2889361c8ccee2a3a211f69 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,29 @@ This repo keeps different rabbitmq agents that help in account creation on OHPC system. -It has 2 branches ```develop``` and ```production``` , that houses agents based on where they are launched +It has 2 branches ```develop``` and ```production``` , that house agents based on where they are launched + +## Using RCRMQ class + +- First, rename `rabbitmq_config.py.example` to `rabbitmq_config.py` + +- Modify config file, at least the `Password` needs to be your own passwod + +- In your code: + +``` +# import the class +from rc_rmq import RCRMQ + +# instantiate an instance +rc_rmq = RCRMQ({'exchange': 'RegUsr'}) + +# publish a message to message queue +rc_rmq.publish_msg({ + 'routing_key': 'your_key', + 'msg': { + 'type': 'warning', + 'content': 'this is warning' + } +}) +```