Skip to main content

A Chat Server based on AMQP using RabbitMQ message broker implementing AMQP, websocket, sockjs, sockjs-tornado, tornado, and amqp python client library, Pika

Project description


A Chat-Server/Chat-System based on AMQP protocol(RabbitMQ Message Broker)


**Link :**


:Author: Anirban Roy Das
:Copyright(C): 2016, Anirban Roy Das <>

Check ``rabbitChat/LICENSE`` file for full Copyright notice.


rabbitChat is a very simple Chat Server which can be set up locally to chat in your LAN. It supports both **Public Chat** among all participants connected simultaneously at a particular time and also **Private Chat** betweent those individual participants.

It uses the `AMQP <>`_ protocol to implement the real time message passing system. **AMQP** is implemented in many languages and in many softwares, once of such is `RabbitMQ <>`_ , which is a message broker implementing the `AMQP <>`_ protocol.

The connection is created using the `sockjs <>`_ protocol. **SockJS** is implemented in many languages, primarily in Javascript to talk to the servers in real time, which tries to create a duplex bi-directional connection between the **Client(browser)** and the **Server**. Ther server should also implement the **sockjs** protocol. Thus using the `sockjs-tornado <>`_ library which exposes the **sockjs** protocol in `Tornado <>`_ server.

It first tries to create a `Websocket <>`_ connection, and if it fails then it fallbacks to other transport mechanisms, such as **Ajax**, **long polling**, etc. After the connection is established, the tornado server**(sockjs-tornado)** connects to **rabbitMQ** via AMQP protocol using the **AMQP Python Client Library**, `Pika <>`_.

Thus the connection is *web-browser* to *tornado* to *rabbitMQ* and vice versa.

Technical Specs

:sockjs-client: Advanced Websocket Javascript Client
:Tornado: Async Python Web Library + Web Server
:sockjs-tornado: SockJS websocket server implementation for Tornado
:AMQP: Advance Message Queuing Protocol used in Message Oriented Middleware
:pika: AMQP Python Client Library
:RabbitMQ: A Message Broker implementing AMQP


* Public chat
* Shows who joined and who left
* Shows number of people online
* Shows who is typing and who is not
* Join/Leave chat room features



1. python 2.7+
2. tornado
3. sockjs-tornado
4. sockjs-client
5. pika
6. rabbitMQ


$ pip install rabbitChat

If above dependencies do not get installed by the above command, then use the below steps to install them one by one.

**Step 1 - Install pip**

Follow the below methods for installing pip. One of them may help you to install pip in your system.

* **Method 1 -**

* **Method 2 -**

* **Method 3 -** If you installed python on MAC OS X via ``brew install python``, then **pip** is already installed along with python.

**Step 2 - Install tornado**

$ pip install tornado

**Step 3 - Install sockjs-tornado**

$ pip install sockjs-tornado

**Step 4 - Install pika**

$ pip install pika

**Step 5 - Install RabbitMQ**

* *For* ``Mac`` *Users*

1. Brew Install RabbitMQ

$ brew install rabbitmq

2. Configure RabbitMq, follow this `link <>`_, this `one <>`_ and `this <>`_.

* *For* ``Ubuntu/Linux`` *Users*

1. Enable RabbitMQ application repository

$ echo "deb testing main" >> /etc/apt/sources.list

2. Add the verification key for the package

$ wget -o | sudo apt-key add -

3. Update the sources with our new addition from above

$ apt-get update

4. And finally, download and install RabbitMQ

$ sudo apt-get install rabbitmq-server

5. Configure RabbitMQ, follow this `link <>`_, this `one <>`_ and `this <>`_.


After having installed rabbitChat, just the run the following commands to use it:

* **RabbitMQ Server**

1. *For* ``Mac`` *Users*

# start normally
$ rabbitmq-server

# If you want to run in background
$ rabbitmq-server --detached

# start using brew rervices (doesn't work with tmux)
$ brew services rabbitmq start

2. *For* ``Ubuntu/LInux`` *Users*

# start normally
$ rabbitmq-server

# If you want to run in background
$ rabbitmq-server --detached

# To start using service
$ service rabbitmq-server start

# To stop using service
$ service rabbitmq-server stop

# To restart using service
$ service rabbitmq-server restart

# To check the status
$ service rabbitmq-server status

* **Start rabbitChat Server**

$ rabbitChat [options]

- **Options**

:--port: Port number where the chat server will start

- **Example**

$ rabbitChat --port=9191

* **Stop rabbitChat Server**

Click ``Ctrl+C`` to stop the server.


1. Add Private Chat functionality.

2. Manage Presence Management, sent, delivered acknowledgements.

3. Message Persistence and delivery of messages to offline clinets.

4. Add Blog post regarding this topic.

Project details

Download files

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

Source Distribution

rabbitChat-1.0.0.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distribution

rabbitChat-1.0.0-py2-none-any.whl (35.5 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page