Skip to main content

Package for HipChat's v2 API

Project description

A Python package for HipChat’s v2 JSON REST API. It’s based on v2’s navigability and self-declaration.

Concepts

There are two basic types in HypChat: Linker and RestObject. They are not meant to be instantiated directly but instead created as references from other objects.

Linker

A simple callable that represents an unfollowed reference.

l.url
The URL this object points to
l()
Calling a Linker will perform the request and return a RestObject

RestObject

A subclass of dict, contains additional functionality for links and actions.

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 Type List.

Timezone Handling

HypChat uses aware datetime objects throughout by the dateutil module. 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.tz has a wonderful selection of timezones available.

Usage

First, create a HypChat object with the token

hc = HypChat("mytoken")

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.

Console

If you call python -m hypchat, a interactive prompt (using IPython if available) will appear. The environment will contain hipchat, an instance of the HypChat object. The token is pulled from ~/.hypchat, /etc/hypchat, or the environment variable HIPCHAT_TOKEN.

Type List

See TYPES.rst

TODO List

  • Proper Datetime and Timezone (dateutils) support
  • History
  • API Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hypchat, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size hypchat-0.2.tar.gz (10.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page