{"id":20632740,"url":"https://github.com/acm-uiuc/groot-notification-service","last_synced_at":"2025-05-10T06:31:00.177Z","repository":{"id":53669231,"uuid":"102796055","full_name":"acm-uiuc/groot-notification-service","owner":"acm-uiuc","description":"Notification service for Twitter, Email and Slack Endpoints","archived":false,"fork":false,"pushed_at":"2022-12-08T00:41:33.000Z","size":26,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":30,"default_branch":"master","last_synced_at":"2024-04-09T11:30:27.943Z","etag":null,"topics":["groot","service"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acm-uiuc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-07T23:41:24.000Z","updated_at":"2017-09-12T00:08:44.000Z","dependencies_parsed_at":"2023-01-24T01:00:53.062Z","dependency_job_id":null,"html_url":"https://github.com/acm-uiuc/groot-notification-service","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acm-uiuc%2Fgroot-notification-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acm-uiuc%2Fgroot-notification-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acm-uiuc%2Fgroot-notification-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acm-uiuc%2Fgroot-notification-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acm-uiuc","download_url":"https://codeload.github.com/acm-uiuc/groot-notification-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224923249,"owners_count":17392826,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["groot","service"],"created_at":"2024-11-16T14:17:15.450Z","updated_at":"2024-11-16T14:17:16.110Z","avatar_url":"https://github.com/acm-uiuc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# groot-notification-service 📣\nNotification service for Twitter, Email and Slack Endpoints\n\n[![Build Status](https://travis-ci.org/acm-uiuc/groot-notification-service.svg?branch=master)](https://travis-ci.org/acm-uiuc/groot-notification-service)\n\n[![Join the chat at https://acm-uiuc.slack.com/messages/C6XGZD212/](https://img.shields.io/badge/slack-groot-724D71.svg)](https://acm-uiuc.slack.com/messages/C6XGZD212/)\n\n## Install / Setup\n1. Clone repo:\n\n    ```\n    git clone https://github.com/acm-uiuc/groot-notification-service\n    cd groot-notification-service\n    ```\n\n2. Install dependencies:\n\n    ```\n    pip install -r requirements.txt\n    ```\n\n3. Copy settings template:\n\n    ```\n    cd groot_notification_service\n    cp settings.template.py settings.py\n    ```\n\n4. Add your DB credentials to settings.py.\n\n## Run Application\n```\npython app.py\n```\n\n## Routes\n\n### POST /notification\n\nSends a message to the provided list of services / recipients\n\n*Body Params:*\n\n* `services` - List of services to send the notification to\n    * Required\n* `message` - The message to be sent in the body of the notification\n    * Required\n\n*Service Schemas:*\n\n- **Slack**\n\n    ```\n    {\n        \"name\": \"slack\",\n        \"recipients\": [\u003cLIST_OF_CHANNELS_OR_USERS\u003e]\n    }\n    ```\n\n- **Email**\n\n    ```\n    {\n        \"name\": \"email\",\n        \"sender\": \"\u003cSENDER_EMAIL_ADDRESS\u003e\",\n        \"subject\": \"\u003cEMAIL_SUBJECT\u003e\",\n        \"recipients\": [\u003cLIST_OF_RECIPIENT_EMAIL_ADDRESSES\u003e],\n        \"mimetype\": \"\u003cEMAIL MIME TYPE\u003e\" # Optional, one of [plain, html]\n    }\n    ```\n\n- **Twitter**\n\n    ```\n    {\n        \"name\": \"twitter\"\n    }\n    ```\n\n*Example Request:*\n```\n{\n    \"services\": [\n        {\n            \"name\": \"twitter\"\n        },\n        {\n            \"name\": \"slack\",\n            \"recipients\": [\"#general\"]\n        },\n        {\n            \"name\": \"email\",\n            \"recipients\": [\"foo@illinois.edu\"],\n            \"sender\": \"admin@acm.illinois.edu\",\n            \"subject\": \"Urgent Message\"\n        }\n    ],\n    \"message\": \"Come clean up the office at 2pm today!\" \n}\n```\n\n## Contributing\n\nContributions to `groot-notification-service` are welcomed!\n\n1. Fork the repo.\n2. Create a new feature branch.\n3. Add your feature / make your changes.\n4. 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.\n5. Create a PR.\n6. ???\n7. Profit.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facm-uiuc%2Fgroot-notification-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facm-uiuc%2Fgroot-notification-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facm-uiuc%2Fgroot-notification-service/lists"}