A Python package for HipChat's
v2 JSON REST API_. It's based on v2's navigability and self-declaration.
.. _v2 JSON REST API: https://www.hipchat.com/docs/apiv2
HypChat can either be installed from PyPI_: ::
pip install hypchat
Or from source_: ::
python setup.py install
.. _PyPI: https://pypi.python.org/pypi/hypchat/ .. _source: https://github.com/RidersDiscountCom/HypChat
There are two basic types in HypChat:
RestObject. They are not meant to be instantiated directly but instead created as references from other objects.
A simple callable that represents an unfollowed reference.
l.urlThe URL this object points to
Linkerwill perform the request and return a
A subclass of
dict, contains additional functionality for links and actions.
Links ~~~~~ As part of the v2 API, all objects have a
linksproperty with references to other objects. This is used to create
Linkerobjects as attributes.
For example, all objects have a link called
self. This may be referenced as: ::
And the request performed by calling it: ::
Title Expansion_ is desired, just past a list of things to be expanded as the
.. _Title Expansion: https://www.hipchat.com/docs/apiv2/expansion
Other Actions ~~~~~~~~~~~~~
Many of the v2 types define additional types, eg Rooms have methods for messaging, setting the topic, getting the history, and inviting users to the room. These are implemented as methods of subclasses. The complete listing is in the
HypChat uses aware
datetimeobjects throughout by the
dateutilmodule. However, the HipChat API universally uses UTC.
For methods that take a
datetime, if a naive object is given, it will be assumed to be in UTC. If this is not what you mean,
dateutil.tzhas a wonderful selection of timezones_ available.
.. _timezones: http://labix.org/python-dateutil#head-587bd3efc48f897f55c179abc520a34330ee0a62
First, create a HypChat object with the token
hc = HypChat("mytoken")
If you use Hipchat Server
hc = HypChat("mytoken", endpoint="https://hipchat.example.com")
There are several root links:
rooms = hc.rooms() users = hc.users() emots = hc.emoticons() caps = hc.capabilities()
In addition, the HypChat object has methods for creating objects and directly referencing the basic types.
For example, you might do:
for room in (r for r in hipchat.rooms(expand='items') if r['last_active'] < datetime.datetime(2013, 12, 1)): room.owner.message("Your room is dead; maybe archive it")
room.owneris a User stub, not just a generic object. (The Room objects are not stubs, since the
expandkeyword is used).
Downloading history is as easy as:
Note that this may eat up many requests for large rooms.
Any time an object is referenced in a value (eg
room['owner']), a stub of that object is created, and the full object may be found with
.self(). Stubs contain the ID of the object, the name (if applicable), and any links that object has-including
self. This can be avoided by using the expand_ keyword.
emotsabove-all have an
'items'key containing their list of things. In addition, the
.contents()method will generate all of the items, handling pagination. As usual, object
If you call
python -m hypchat, a interactive prompt (using IPython_ if available) will appear. The environment will contain
hipchat, an instance of the
HypChatobject. The token is pulled from
/etc/hypchat, or the environment variable
.. _IPython: http://ipython.org/
.. _TYPES.rst: https://github.com/RidersDiscountCom/HypChat/blob/master/TYPES.rst