# TP-sendNotify
<p align="center">
<a href="https://github.com/truocphan/TP-sendNotify/releases/"><img src="https://img.shields.io/github/release/truocphan/TP-sendNotify" height=30></a>
<a href="#"><img src="https://img.shields.io/github/downloads/truocphan/TP-sendNotify/total" height=30></a>
<a href="#"><img src="https://img.shields.io/github/stars/truocphan/TP-sendNotify" height=30></a>
<a href="#"><img src="https://img.shields.io/github/forks/truocphan/TP-sendNotify" height=30></a>
<a href="https://github.com/truocphan/TP-sendNotify/issues?q=is%3Aopen+is%3Aissue"><img src="https://img.shields.io/github/issues/truocphan/TP-sendNotify" height=30></a>
<a href="https://github.com/truocphan/TP-sendNotify/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/truocphan/TP-sendNotify" height=30></a>
</p>
## Installation
#### From PyPI:
```console
pip install TP-sendNotify
```
#### From Source:
```console
git clone https://github.com/truocphan/TP-sendNotify.git --branch <Branch/Tag>
cd TP-sendNotify
python setup.py build
python setup.py install
```
## Basic Usage
The default configuration file created at `~/.TPConfig/TP-sendNotify/sendNotify.json` has the following content:
```json
{
"Discord": {
"<BOT_NAME>": {
"WEBHOOK-URL": "https://discord.com/api/webhooks/<WEBHOOK_ID>/<WEBHOOK_TOKEN>"
},
...
},
"Telegram": {
"<BOT_NAME>": {
"BOT-TOKEN": "<BOT_TOKEN>",
"CHANNEL-USERNAME": "<CHANNEL_USERNAME>"
},
...
},
"Slack": {
"<BOT_NAME>": {
"WEBHOOK-URL": "https://hooks.slack.com/services/<WORKSPACE_ID>/<CHANNEL_ID>/<TOKEN>"
},
...
}
}
```
### toDiscord(bot_name, message, SidebarColor=0xcc0500, ConfigFile=None)
Sending message notification to Discord
```python
import TP_sendNotify
TP_sendNotify.toDiscord("<BOT_NAME>", "This message notification has been sent to the Discord using TP-sendNotify")
```
### toTelegram(bot_name, message, MessageFormat=None, ConfigFile=None)
Sending message notification to Telegram
```python
import TP_sendNotify
TP_sendNotify.toTelegram("<BOT_NAME>", "This message notification has been sent to the Telegram using TP-sendNotify")
```
### toSlack(bot_name, message, ConfigFile=None)
Sending message notification to Slack
```python
import TP_sendNotify
TP_sendNotify.toSlack("<BOT_NAME>", "This message notification has been sent to the Slack using TP-sendNotify")
```
Raw data
{
"_id": null,
"home_page": "https://github.com/truocphan/TP-sendNotify",
"name": "TP-sendNotify",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "TPCyberSec",
"author": "TP Cyber Security",
"author_email": "tpcybersec2023@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/01/d4/ac3dcb3632c262af4dbb13305d4e597f26c4d6bac5f01e4e7c1e6e11f5a2/TP-sendNotify-2024.9.1.tar.gz",
"platform": null,
"description": "# TP-sendNotify\n\n<p align=\"center\">\n <a href=\"https://github.com/truocphan/TP-sendNotify/releases/\"><img src=\"https://img.shields.io/github/release/truocphan/TP-sendNotify\" height=30></a>\n <a href=\"#\"><img src=\"https://img.shields.io/github/downloads/truocphan/TP-sendNotify/total\" height=30></a>\n <a href=\"#\"><img src=\"https://img.shields.io/github/stars/truocphan/TP-sendNotify\" height=30></a>\n <a href=\"#\"><img src=\"https://img.shields.io/github/forks/truocphan/TP-sendNotify\" height=30></a>\n <a href=\"https://github.com/truocphan/TP-sendNotify/issues?q=is%3Aopen+is%3Aissue\"><img src=\"https://img.shields.io/github/issues/truocphan/TP-sendNotify\" height=30></a>\n <a href=\"https://github.com/truocphan/TP-sendNotify/issues?q=is%3Aissue+is%3Aclosed\"><img src=\"https://img.shields.io/github/issues-closed/truocphan/TP-sendNotify\" height=30></a>\n</p>\n\n## Installation\n#### From PyPI:\n```console\npip install TP-sendNotify\n```\n#### From Source:\n```console\ngit clone https://github.com/truocphan/TP-sendNotify.git --branch <Branch/Tag>\ncd TP-sendNotify\npython setup.py build\npython setup.py install\n```\n\n## Basic Usage\nThe default configuration file created at `~/.TPConfig/TP-sendNotify/sendNotify.json` has the following content:\n```json\n{\n \"Discord\": {\n \"<BOT_NAME>\": {\n \"WEBHOOK-URL\": \"https://discord.com/api/webhooks/<WEBHOOK_ID>/<WEBHOOK_TOKEN>\"\n },\n ...\n },\n \"Telegram\": {\n \"<BOT_NAME>\": {\n \"BOT-TOKEN\": \"<BOT_TOKEN>\",\n \"CHANNEL-USERNAME\": \"<CHANNEL_USERNAME>\"\n },\n ...\n },\n \"Slack\": {\n \"<BOT_NAME>\": {\n \"WEBHOOK-URL\": \"https://hooks.slack.com/services/<WORKSPACE_ID>/<CHANNEL_ID>/<TOKEN>\"\n },\n ...\n }\n}\n```\n\n### toDiscord(bot_name, message, SidebarColor=0xcc0500, ConfigFile=None)\nSending message notification to Discord\n```python\nimport TP_sendNotify\n\nTP_sendNotify.toDiscord(\"<BOT_NAME>\", \"This message notification has been sent to the Discord using TP-sendNotify\")\n```\n\n### toTelegram(bot_name, message, MessageFormat=None, ConfigFile=None)\nSending message notification to Telegram\n```python\nimport TP_sendNotify\n\nTP_sendNotify.toTelegram(\"<BOT_NAME>\", \"This message notification has been sent to the Telegram using TP-sendNotify\")\n```\n\n### toSlack(bot_name, message, ConfigFile=None)\nSending message notification to Slack\n```python\nimport TP_sendNotify\n\nTP_sendNotify.toSlack(\"<BOT_NAME>\", \"This message notification has been sent to the Slack using TP-sendNotify\")\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sending message notification to Discord, Telegram, Slack",
"version": "2024.9.1",
"project_urls": {
"Homepage": "https://github.com/truocphan/TP-sendNotify"
},
"split_keywords": [
"tpcybersec"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36e5ee88af13001894f0d203325ac01a76426afe94832578cb9213844a08db81",
"md5": "4622bde2a5877c21b84d5ab7e00e2db5",
"sha256": "f4893fac111a5aafa15ce3b42115838d7278267cbaa83cdb583509d6b04e826c"
},
"downloads": -1,
"filename": "TP_sendNotify-2024.9.1-py2-none-any.whl",
"has_sig": false,
"md5_digest": "4622bde2a5877c21b84d5ab7e00e2db5",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 3993,
"upload_time": "2024-09-01T08:51:24",
"upload_time_iso_8601": "2024-09-01T08:51:24.742761Z",
"url": "https://files.pythonhosted.org/packages/36/e5/ee88af13001894f0d203325ac01a76426afe94832578cb9213844a08db81/TP_sendNotify-2024.9.1-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "906d8396979d5bcf5a444b09b2fc638909cabf1c2ec1a5b3a54f1ce2686c2ced",
"md5": "a306368f4ea3972c0a76c0adb10d9d2b",
"sha256": "b67a6ffe32d982c397b416526f9ff5f3a9d0ba54603b9dae1bafdcae53a133b4"
},
"downloads": -1,
"filename": "TP_sendNotify-2024.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a306368f4ea3972c0a76c0adb10d9d2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4011,
"upload_time": "2024-09-01T08:51:26",
"upload_time_iso_8601": "2024-09-01T08:51:26.579707Z",
"url": "https://files.pythonhosted.org/packages/90/6d/8396979d5bcf5a444b09b2fc638909cabf1c2ec1a5b3a54f1ce2686c2ced/TP_sendNotify-2024.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01d4ac3dcb3632c262af4dbb13305d4e597f26c4d6bac5f01e4e7c1e6e11f5a2",
"md5": "410613e351c8b18895cf8528004c5dba",
"sha256": "ce8ba7e0c726d09e0cb396ac3da6a962f9e7942f66d934b5201ff01761c6342d"
},
"downloads": -1,
"filename": "TP-sendNotify-2024.9.1.tar.gz",
"has_sig": false,
"md5_digest": "410613e351c8b18895cf8528004c5dba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3573,
"upload_time": "2024-09-01T08:51:29",
"upload_time_iso_8601": "2024-09-01T08:51:29.229612Z",
"url": "https://files.pythonhosted.org/packages/01/d4/ac3dcb3632c262af4dbb13305d4e597f26c4d6bac5f01e4e7c1e6e11f5a2/TP-sendNotify-2024.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 08:51:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "truocphan",
"github_project": "TP-sendNotify",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "certifi",
"specs": []
},
{
"name": "charset-normalizer",
"specs": []
},
{
"name": "idna",
"specs": []
},
{
"name": "json-duplicate-keys",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "urllib3",
"specs": []
}
],
"lcname": "tp-sendnotify"
}
JSON
