# python-simple-hipchat

**Repository Path**: mirrors_pimterry/python-simple-hipchat

## Basic Information

- **Project Name**: python-simple-hipchat
- **Description**: A python module for working with the HipChat API
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

(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...')


.. _`HipChat API`: https://www.hipchat.com/docs/api