HipChat Notifications
This is a very simple library for sending user and room notifications to HipChat via their v2 API.
It contains a couple of generic functions for sending messages to rooms and users within HipChat.
>>> hipchat.notify_room('Customer Service', 'This is a message')
>>> hipchat.notify_user('hugo', 'Hello, Hugo')
It includes some colour-specific helpers for room-only notifications:
>>> hipchat.green('Customer service', 'This is a green message')
The functions support the message_format values:
html - Message is rendered as HTML and receives no special treatment. Must be valid HTML and entities must be escaped (e.g.: ‘&’ instead of ‘&’). May contain basic tags: a, b, i, strong, em, br, img, pre, code, lists, tables.
text - Message is treated just like a message sent by a user. Can include @mentions, emoticons, pastes, and auto-detected URLs (Twitter, YouTube, images, etc).
>>> hipchat.green('Customer service', 'Hello @fred', message_format='text')
The color, notify and from parameters are also supported (from is passed as a kwarg called label):
>>> notify_room(
... 'customer service',
... 'Hey there @Tony',
... color='red',
... label='baz',
... notify=True,
... message_format='text'
... )
Settings
The following settings are read from the environment using os.getenv
HIPCHAT_API_TOKEN
A valid API access token. See the API docs for details on how to generate a token. (Hint: the easiest way is to use a “Personal access token” generated through the site.)
If there is no token set in the environment the notifications will be logged using the ‘hipchat’ logger, with a DEBUG level.
Installation
The library is available on PyPI as ‘hipchat_notifications’.
Tests
The tests can be run using tox:
$ tox
Contributors
Hugo Rodger-Brown - @hugorodgerbrown
Roberto Salgado - @droberin
Metadata
Release files for hipchat-notifications 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hipchat-notifications-0.4.1.tar.gz | 7.7 kB | Without provenance | Details for hipchat-notifications-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hipchat_notifications-0.4.1-py2-none-any.whl | Python 2 | none | any | Details for hipchat_notifications-0.4.1-py2-none-any.whl |
Total release size: 18.2 kB
Release files / hipchat-notifications-0.4.1.tar.gz
| Download URL | hipchat-notifications-0.4.1.tar.gz |
|---|---|
| Size | 7.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0d42bf1acd1b73d42b01a88a01199105406b2f61e1f23b60a387a4450ac35a39
|
|
BLAKE2b-256 checksum How to use checksums |
bf8fb06cc4da53f49296fa343edbb451a26dca7c01bd4e8bcc90c786b0e332dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / hipchat_notifications-0.4.1-py2-none-any.whl
| Download URL | hipchat_notifications-0.4.1-py2-none-any.whl |
|---|---|
| Size | 10.5 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
2ebfb19e05b6e7205a54ff8585d954b497041add1dd66dc061e7378c0040932f
|
|
BLAKE2b-256 checksum How to use checksums |
dc9f35237ea477e849159ce428519094224d5c1e4e3cc907b682b7ebebe06629
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for hipchat-notifications 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.