HipChat v1 API的简易豌豆包装
python-simple-hipchat的Python项目详细描述
说明
简单的豌豆包装纸。公开核心uri终结点包装器和一些用于公共集成的基本方法。
依赖关系
没有超出python标准库的。
用法
安装:
pip install python-simple-hipchat
实例化:
import hipchat hipster = hipchat.HipChat(token=YourHipChatToken)
请求一个uri端点,如hipchat api文档中所述:
hipster.method(url='method/url/', method="GET/POST", parameters={'name':'value', })
示例:
# 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...'})
原料药糖
要向文件室发送消息,可以使用通知或管理令牌。所有其他方法都需要管理令牌。有关详细信息,请参见HipChat’s auth docs。
向房间发送消息:
room_id = 8675309 from_name = 'HAL' message = 'All your base...' hipster.message_room(room_id, from_name, message) # per HipChat, color can be "yellow", "red", "green", "purple", "gray", or "random" message_color = 'gray' hipster.message_room(room_id, from_name, message, color=message_color) # notify users in the room message_color = 'red' hipster.message_room(room_id, from_name, message, color=message_color, notify=True)
列出房间:
hipster.list_rooms()
按名称查找房间:
room = hipster.find_room('Room Name') print "Room Name has room id = %s" % (room['room_id'])
列出用户:
hipster.list_users()
按名称查找用户:
user = hipster.find_user('Raleigh Becket') print "Raleigh Becket's status is = %s" % (user['status'])
更改日志
v0.4.x
- Added shortcut method for single room info(谢谢@claudyus)
- 已重命名Github回购
v0.3.x
- 添加了列出用户的快捷方式(感谢@raizex)
- 添加了按名称查找用户的快捷方式(感谢@raizex)
- 添加了按名称查找房间的快捷方式(感谢@raizex)
- Added trove classifiers(谢谢@ghickman)
v0.2.x
- Added Python 3 support without losing support for Python 2(谢谢@pimterry)
- Expose timeout for safer synchronous use(谢谢@zachsnow)
v0.1.x
- 添加了向房间发送消息的快捷方式
- 添加了列出房间的快捷方式