djhipchat2 0.5.1

djhipchat.send_message

这将使用默认后端发送 HipChat 消息。这些参数反映了 HipChat 消息传递 API 的参数，在此处定义：https ://www.hipchat.com/docs/api/method/rooms/message 。

这些是参数：

• room_id：要发送到的 HipChat 房间的 ID。房间 ID 可以在这里找到：https:// {{your- account}}.hipchat.com /rooms/ids

• 发件人：消息的发件人。长度必须少于 15 个字符。可能包含字母、数字、-、_ 和空格。（注意：在 HipChat API 中，它被指定为from。它已被更改，因此它不是 Python 关键字。）

• message：消息的文本或 HTML。

• message_format：应该是text或html。默认为html

• notify：如果消息应在房间中触发通知，则应为True 。默认为假

• color：消息的颜色。“黄色”、“红色”、“绿色”、“紫色”、“灰色”或“随机”之一。默认为“黄色”。

djhipchat.get_backend

获取对 HipChat 后端的引用。每个后端都有一个定义的方法：send_message ，它具有与djhipchat.send_message相同的参数。

记录器

将 HipChat 集成到您的服务器日志记录中：这定义了一个将消息发送到 HipChat 房间的日志记录处理程序。您可以配置一个记录器来通知房间的成员，或者也可以使用同一个处理程序为日志级别配置多种颜色。这是一个示例：

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'djhipchat': {
            'level': 'INFO',
            'class': 'djhipchat.logger.HipChatHandler',
            'token': '{{your_token_here}}',
            'room' : '{{your_room_id_here}}',
            'sender': 'Myapp',
            'notify': True,
            'color':'green',
            'colors': {
               'ERROR':'red',
               'CRITICAL':'red',
               'WARNING':'yellow',
           }
        }
    },
    'loggers': {
        'test_handler': {
            'handlers': ['djhipchat'],
            'level': 'INFO',
            'propagate': False,
        },
    }
}

灵感来自：https ://gist.github.com/hugorodgerbrown/3176710

管理指挥

这个应用程序提供了一个管理命令，可以轻松地将消息发送到配置的后端。用法很简单：python manage.py hipchat <room_id> <message>

选项位于：python manage.py help hipchat

HIPCHAT_BACKEND

指定要使用的默认后端。默认为djhipchat.backends.locmem.HipChatBackend

HIPCHAT_API_TOKEN

指定 HipChat API 令牌。除了请求后端之外，这在理论上是可选的，但这可能是您无论如何都想在生产中使用的。

HIPCHAT_DEFAULT_SENDER

如果未在 send_message 调用中指定，则为默认发件人。如果未指定，则默认为“Django”。

HIPCHAT_CELERY_BACKEND

当使用 Celery 后端时，它需要一个“同步”后端来实际发送消息。没有默认值，因此您必须指定它才能使用 Celery 后端。

djhipchat.backends.celery.HipChatBackend

此后端通过Celery任务发送所有消息。为了使用这个后端，你必须安装 celery 并在HIPCHAT_CELERY_BACKEND设置中指定一个同步后端。

djhipchat.backends.dummy.HipChatBackend

听起来像什么：这个后端什么都不做。

djhipchat.backends.locmem.HipChatBackend

与 Django 中的 locmem 电子邮件后端类似，这会将所有消息收集到djhipchat.sent_messages的数组中。您可以使用它进行测试。

djhipchat.backends.request.HipChatBackend

这是默认后端，它实际上将您的消息发送到 HipChat。