A supervisord process notification for rocketchat.
Project description
# superrocket
A supervisord process notification for rocketchat.
This project has been highly inspired from the [superslacker](https://github.com/MTSolutions/superslacker) project.
## Installation
```
pip install superrocket
```
## Current Stable Version
```
0.3.0
```
## Usage:
To use it with supervisor put this as a plugin in your `supervisor.conf`
```
[eventlistener:superslacker]
command=superslacker --webhook="your-complete-rocketchat-webhook" --channel="#notifications" --hostname="HOST"
events=PROCESS_STATE,TICK_60
```
To use it standalone:
```
from superrocket.api import Api
api = Api(channel='#general', webhook='my_webhook_url')
api.send("```This is my markdown enabled message```")
```
## Options:
```
usage: superrocket [-h] -c CHANNEL -w WEBHOOK [-a ATTACHMENT] [-n HOSTNAME]
[-b BOTNAME] [-e EMOJI] [-k]
Send messages from supervisor state changes, to RocketChat
optional arguments:
-h, --help show this help message and exit
-c CHANNEL, --channel CHANNEL
RocketChat channel to post message to
-w WEBHOOK, --webhook WEBHOOK
RocketChat WebHook URL
-a ATTACHMENT, --attachment ATTACHMENT
RocketChat attachment text
-n HOSTNAME, --hostname HOSTNAME
System Hostname
-b BOTNAME, --botname BOTNAME
Default username for the bot
-e EMOJI, --emoji EMOJI
Default emoji to show for the bot
-k, --insecure Skip RocketChat server certificate verification
```
### Development Installation
* Clone the project.
* Install in Anaconda3 environment
* This command creates a python environment and then activates it.
```
$ make recreate_pyenv && chmod +x activate-env.sh && . activate-env.sh
```
* Now install the application in editable mode and you are ready to start development
```
$ pip install -e .
```
## Test
To run the tests:
```
make test
```
## License
See the LICENSE and Copyright.txt files.
A supervisord process notification for rocketchat.
This project has been highly inspired from the [superslacker](https://github.com/MTSolutions/superslacker) project.
## Installation
```
pip install superrocket
```
## Current Stable Version
```
0.3.0
```
## Usage:
To use it with supervisor put this as a plugin in your `supervisor.conf`
```
[eventlistener:superslacker]
command=superslacker --webhook="your-complete-rocketchat-webhook" --channel="#notifications" --hostname="HOST"
events=PROCESS_STATE,TICK_60
```
To use it standalone:
```
from superrocket.api import Api
api = Api(channel='#general', webhook='my_webhook_url')
api.send("```This is my markdown enabled message```")
```
## Options:
```
usage: superrocket [-h] -c CHANNEL -w WEBHOOK [-a ATTACHMENT] [-n HOSTNAME]
[-b BOTNAME] [-e EMOJI] [-k]
Send messages from supervisor state changes, to RocketChat
optional arguments:
-h, --help show this help message and exit
-c CHANNEL, --channel CHANNEL
RocketChat channel to post message to
-w WEBHOOK, --webhook WEBHOOK
RocketChat WebHook URL
-a ATTACHMENT, --attachment ATTACHMENT
RocketChat attachment text
-n HOSTNAME, --hostname HOSTNAME
System Hostname
-b BOTNAME, --botname BOTNAME
Default username for the bot
-e EMOJI, --emoji EMOJI
Default emoji to show for the bot
-k, --insecure Skip RocketChat server certificate verification
```
### Development Installation
* Clone the project.
* Install in Anaconda3 environment
* This command creates a python environment and then activates it.
```
$ make recreate_pyenv && chmod +x activate-env.sh && . activate-env.sh
```
* Now install the application in editable mode and you are ready to start development
```
$ pip install -e .
```
## Test
To run the tests:
```
make test
```
## License
See the LICENSE and Copyright.txt files.
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
superrocket-0.3.0.tar.gz
(4.8 kB
view hashes)
Built Distribution
Close
Hashes for superrocket-0.3.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fcd0212473b72ad86da0d297350bf6e0d79dba441a7dc48b095b651e3a5882d |
|
MD5 | bc39522cefaf942e78fdd58d62ec9be1 |
|
BLAKE2b-256 | c9f53f2c018295bf36671bed358f2a238a4cb215354f45b0afa1795faaa69e05 |