python-simple-hipchat 0.3.1

Easy peasy wrapper for HipChat's v1 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...'})

Some handy shortcut methods:

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

# Find room by name.
hipster.find_room('name')

# List users, print response JSON
print hipster.list_users()

# Find user by name.
hipster.find_user('John Doe')

# POST a message to a room, print response JSON
print hipster.message_room(8675309, 'HAL', 'All your base...')

Changelog

v0.3.0

• Added shortcut method for listing users (thanks @Raizex)

• Added shortcut method for finding user by name (thanks @Raizex)

• Added shortcut method for finding room by name (thanks @Raizex)

v0.2.0

• Added Python 3 support without losing support for Python 2 (thanks @pimterry)

• Expose timeout for safer synchronous use (thanks @zachsnow)

v0.1.0

• Added shortcut method for messaging a room

• Added shortcut method for listing rooms (requires admin token)