Skip to main content

A supervisord process notification for rocketchat.

Project description

# superrocket

A supervisord process notification for rocketchat.

This project has been highly inspired from the [superslacker]( project.

## Installation
pip install superrocket

## Current Stable Version

## Usage:
To use it with supervisor put this as a plugin in your `supervisor.conf`

command=superslacker --webhook="your-complete-rocketchat-webhook" --channel="#notifications" --hostname="HOST"

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
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 && .
* 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

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)

Uploaded source

Built Distribution

superrocket-0.3.0-py2-none-any.whl (7.1 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page