Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acm-uiuc/groot-notification-service
Notification service for Twitter, Email and Slack Endpoints
https://github.com/acm-uiuc/groot-notification-service
groot service
Last synced: about 18 hours ago
JSON representation
Notification service for Twitter, Email and Slack Endpoints
- Host: GitHub
- URL: https://github.com/acm-uiuc/groot-notification-service
- Owner: acm-uiuc
- Created: 2017-09-07T23:41:24.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T00:41:33.000Z (almost 2 years ago)
- Last Synced: 2024-04-09T11:30:27.943Z (7 months ago)
- Topics: groot, service
- Language: Python
- Size: 25.4 KB
- Stars: 0
- Watchers: 30
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# groot-notification-service 📣
Notification service for Twitter, Email and Slack Endpoints
[](https://travis-ci.org/acm-uiuc/groot-notification-service)
[](https://acm-uiuc.slack.com/messages/C6XGZD212/)
## Install / Setup
1. Clone repo:
```
git clone https://github.com/acm-uiuc/groot-notification-service
cd groot-notification-service
```
2. Install dependencies:
```
pip install -r requirements.txt
```
3. Copy settings template:
```
cd groot_notification_service
cp settings.template.py settings.py
```
4. Add your DB credentials to settings.py.
## Run Application
```
python app.py
```
## Routes
### POST /notification
Sends a message to the provided list of services / recipients
*Body Params:*
* `services` - List of services to send the notification to
* Required
* `message` - The message to be sent in the body of the notification
* Required
*Service Schemas:*
- **Slack**
```
{
"name": "slack",
"recipients": []
}
```
- **Email**
```
{
"name": "email",
"sender": "",
"subject": "",
"recipients": [],
"mimetype": "" # Optional, one of [plain, html]
}
```
- **Twitter**
```
{
"name": "twitter"
}
```
*Example Request:*
```
{
"services": [
{
"name": "twitter"
},
{
"name": "slack",
"recipients": ["#general"]
},
{
"name": "email",
"recipients": ["[email protected]"],
"sender": "[email protected]",
"subject": "Urgent Message"
}
],
"message": "Come clean up the office at 2pm today!"
}
```
## Contributing
Contributions to `groot-notification-service` are welcomed!
1. Fork the repo.
2. Create a new feature branch.
3. Add your feature / make your changes.
4. Install [pep8](https://pypi.python.org/pypi/pep8) and run `pep8 *.py` in the root project directory to lint your changes. Fix any linting errors.
5. Create a PR.
6. ???
7. Profit.