Skip to content

README.md

Latest commit

 

History

History
46 lines (29 loc) · 1.21 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.21 KB
Raw

Olark - Hipchat

Broadcast presence on HipChat to Olark, receive messages from Olark on HipChat

Features

  • Connect to Olark via XMPP
  • Use the Hipchat REST API
  • Monitor a Hipchat room if a person is connected
  • Connect to Olark if one person is connected
  • Disconnect from Olark if nobody is connected to Hichat
  • Transfer Olark users messages to Hipchat with a notification sound and a link to go to Olark chat

How to use it

Install

$ git clone https://github.com/pricingassistant/olark-hipchat.git
$ cd olark-hipchat
$ make virtualenv
$ source venv/bin/activate
$ pip install -r requirements.txt

Run tests

In the virtualenv environment, use nose to discover and run tests:

$ pip install nose
$ nosetests

Config

Configure environment variables listed in src/config.py.

  • Create a v1 HipChat API Token (https://hipchat.com/admin/api) with an admin type
  • Set it in src/config.py (HIPCHAT_TOKEN)
  • Change the room name where to send Olark messages (HIPCHAT_ROOMNAME)
  • Change the Olark username and password (OLARK_USERNAME, OLARK_PASSWORD)

If you deploy on Heroku, installation is automatic, and you only need to scale to a single Worker to start.

Execute

$ python src/olark-hipchat.py