Deadly simple HipChat API V2 room notification library
Project description
# hipnotify
[![PyPI version](https://img.shields.io/pypi/v/hipnotify.svg)](https://pypi.python.org/pypi/hipnotify)
[![PyPI downloads](https://img.shields.io/pypi/dm/hipnotify.svg)](https://pypi.python.org/pypi/hipnotify)
[![Build Status](https://travis-ci.org/achiku/hipnotify.svg)](https://travis-ci.org/achiku/hipnotify)
[![Requirements Status](https://requires.io/github/achiku/hipnotify/requirements.svg?branch=master)](https://requires.io/github/achiku/hipnotify/requirements/?branch=master)
Deadly simple HipChat API V2 room notification library
# Why created
HipChat official [third-party library web page](https://www.hipchat.com/docs/apiv2/libraries) introduces two sophisticated Python client libraries supporting almost all V2 APIs currently available. However, our usecase just needed HipChat V2 room notification API + Python3 compatible HipChat client, which can only send messages to the specified room if a room token is given, without needing an admin token. (Admin token could be pretty dangerous and certainly unnecessary in this case.)
This library is designed to do simple thing simple with minimum sysadmin concern.
# Usage
```python
# -*- coding: utf-8 -*-
from hipnotify import Room
HIPCHAT_TOKEN = 'token'
HIPCHAT_ROOM_ID = 'room_id'
if __name__ == '__main__':
room = Room(HIPCHAT_TOKEN, HIPCHAT_ROOM_ID)
room.notify('hello, world!')
```
![](artwork/green-hello-world.png)
```python
room.notify('Watch out!! Something is going wrong!!', color='red')
```
![](artwork/red-caution.png)
```python
room.notify('Ha? Just <a href="https://google.com">google</a> it.', message_format='html')
```
![](artwork/green-html-format.png)
[![PyPI version](https://img.shields.io/pypi/v/hipnotify.svg)](https://pypi.python.org/pypi/hipnotify)
[![PyPI downloads](https://img.shields.io/pypi/dm/hipnotify.svg)](https://pypi.python.org/pypi/hipnotify)
[![Build Status](https://travis-ci.org/achiku/hipnotify.svg)](https://travis-ci.org/achiku/hipnotify)
[![Requirements Status](https://requires.io/github/achiku/hipnotify/requirements.svg?branch=master)](https://requires.io/github/achiku/hipnotify/requirements/?branch=master)
Deadly simple HipChat API V2 room notification library
# Why created
HipChat official [third-party library web page](https://www.hipchat.com/docs/apiv2/libraries) introduces two sophisticated Python client libraries supporting almost all V2 APIs currently available. However, our usecase just needed HipChat V2 room notification API + Python3 compatible HipChat client, which can only send messages to the specified room if a room token is given, without needing an admin token. (Admin token could be pretty dangerous and certainly unnecessary in this case.)
This library is designed to do simple thing simple with minimum sysadmin concern.
# Usage
```python
# -*- coding: utf-8 -*-
from hipnotify import Room
HIPCHAT_TOKEN = 'token'
HIPCHAT_ROOM_ID = 'room_id'
if __name__ == '__main__':
room = Room(HIPCHAT_TOKEN, HIPCHAT_ROOM_ID)
room.notify('hello, world!')
```
![](artwork/green-hello-world.png)
```python
room.notify('Watch out!! Something is going wrong!!', color='red')
```
![](artwork/red-caution.png)
```python
room.notify('Ha? Just <a href="https://google.com">google</a> it.', message_format='html')
```
![](artwork/green-html-format.png)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
hipnotify-1.0.8.tar.gz
(45.6 kB
view details)
File details
Details for the file hipnotify-1.0.8.tar.gz
.
File metadata
- Download URL: hipnotify-1.0.8.tar.gz
- Upload date:
- Size: 45.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a2b2a6c333d2f065ee7e86cc25a125fbe4d0fb41116e88c1562275692c15de0 |
|
MD5 | 2609c97d6f5c130a19cbdea52616fe9d |
|
BLAKE2b-256 | b772f71a162182c775cdefa0c9972c876ad955ce5d5f0b53c32747e3cc082ee0 |