Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A python module for working with the HipChat API
branch: master

This branch is 1 commit ahead of mlaugharn:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
hipchat
.gitattributes
.gitignore
LICENSE.txt
MANIFEST.in
README.rst
setup.py

README.rst

(Super simple) Python Module for HipChat API

Description

Easy peasy wrapper for the HipChat API. Exposes core URI endpoint wrapper and some basic methods for common integrations.

Dependencies

None beyond the Python standard library.

Usage

Install:

pip install python-simple-hipchat

Instantiate:

import hipchat
hipster = hipchat.HipChat(token=YourHipChatToken)

Request a URI endpoint as described in the HipChat API docs:

hipster.method(url='method/url/', method="GET/POST", parameters={'name':'value', })

Example methods:

# List rooms
hipster.method('rooms/list')

# Post a message to a HipChat room
hipster.method('rooms/message', method='POST', parameters={'room_id': 8675309, 'from': 'HAL', 'message': 'All your base...'})

Two handy shortcut methods:

# List rooms, print response JSON
print hipster.list_rooms()

# POST a message to a room, print response JSON
print hipster.message_room(8675309, 'HAL', 'All your base...')
Something went wrong with that request. Please try again.