# whecho
linux echo but with webhooks! ⚓
Don't guess when a job is finished! Have it message you!
## requirements
- python 3.6+
## installation
```
pip install whecho
```
## First Time Setup
- obtain a webhook URL
- Currently supports:
- [discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
- [slack](https://api.slack.com/messaging/webhooks)
- [webex](https://apphub.webex.com/applications/incoming-webhooks-cisco-systems-38054-23307-75252) (with markdown)
- Initialize the `default_url`
```
$ whecho --init
Current config:
[1] default_url: None
[2] user: craut
[3] machine: craut-spectre
Please enter the number/name of the config option you would like to modify (empty or Q to exit): 1
Please enter the new value for default_url: <WEBHOOK_URL>
Successfully modified default_url to <WEBHOOK_URL>!
Current config:
[1] default_url: <WEBHOOK_URL>
[2] user: craut
[3] machine: craut-spectre
Please enter the number/name of the config option you would like to modify (empty or Q to exit): q
Successfully initialized whecho!
```
## general usage (from shell/console)
```
$ whecho "hello there"
```
## usage from python
```
from whecho.whecho import whecho_simple
whecho_simple("I'm inside python 🐍")
```
## advanced usage
```
$ whecho --help
usage: whecho [-h] [--version] [-m MSG] [--init] [-u URL] [-d] [MSG [MSG ...]]
Linux echo with webhooks! ⚓
positional arguments:
MSG The message to echo.
optional arguments:
-h, --help show this help message and exit
--version Prints the version of whecho and exits.
-m MSG, --msg MSG The message to echo (same as 1st positional argument).
--init Initializes whecho. Also used to change current config.
-u URL, --url URL The webhook URL to send the message to.
-d, --debug Whether to print debugging information.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/cvraut/whecho",
"name": "whecho",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "webhooks,notifications,echo,whecho,command-line,cli",
"author": "Chinmay Raut",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/12/63/1debb665c61afbed64dd983ef6b7ca682e270f140b1eafbab63146191951/whecho-0.0.5.tar.gz",
"platform": null,
"description": "# whecho\nlinux echo but with webhooks! \u2693\n\nDon't guess when a job is finished! Have it message you!\n\n## requirements\n- python 3.6+\n\n## installation\n```\npip install whecho\n```\n\n## First Time Setup\n- obtain a webhook URL\n\n- Currently supports:\n - [discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)\n - [slack](https://api.slack.com/messaging/webhooks)\n - [webex](https://apphub.webex.com/applications/incoming-webhooks-cisco-systems-38054-23307-75252) (with markdown)\n- Initialize the `default_url`\n```\n$ whecho --init\nCurrent config:\n[1] default_url: None\n[2] user: craut\n[3] machine: craut-spectre\n\nPlease enter the number/name of the config option you would like to modify (empty or Q to exit): 1\nPlease enter the new value for default_url: <WEBHOOK_URL>\nSuccessfully modified default_url to <WEBHOOK_URL>!\nCurrent config:\n[1] default_url: <WEBHOOK_URL>\n[2] user: craut\n[3] machine: craut-spectre\n\nPlease enter the number/name of the config option you would like to modify (empty or Q to exit): q\nSuccessfully initialized whecho!\n```\n\n## general usage (from shell/console)\n```\n$ whecho \"hello there\"\n```\n\n\n## usage from python\n```\nfrom whecho.whecho import whecho_simple\nwhecho_simple(\"I'm inside python \ud83d\udc0d\")\n```\n\n\n## advanced usage\n```\n$ whecho --help\nusage: whecho [-h] [--version] [-m MSG] [--init] [-u URL] [-d] [MSG [MSG ...]]\n\nLinux echo with webhooks! \u2693\n\npositional arguments:\n MSG The message to echo.\n\noptional arguments:\n -h, --help show this help message and exit\n --version Prints the version of whecho and exits.\n -m MSG, --msg MSG The message to echo (same as 1st positional argument).\n --init Initializes whecho. Also used to change current config.\n -u URL, --url URL The webhook URL to send the message to.\n -d, --debug Whether to print debugging information.\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Linux echo with webhooks! \u2693",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/cvraut/whecho",
"Repository": "https://github.com/cvraut/whecho"
},
"split_keywords": [
"webhooks",
"notifications",
"echo",
"whecho",
"command-line",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d48b02d309c71881c234c03b995a025464098ca3d0028e63d805940e8813c9db",
"md5": "93f8166439f200bd0f681f57aad704a4",
"sha256": "d305245051fa84cfc98bbba7c9cdf619c95a690a353ad4490dc191162b1519b5"
},
"downloads": -1,
"filename": "whecho-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93f8166439f200bd0f681f57aad704a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7956,
"upload_time": "2024-02-11T21:55:59",
"upload_time_iso_8601": "2024-02-11T21:55:59.024619Z",
"url": "https://files.pythonhosted.org/packages/d4/8b/02d309c71881c234c03b995a025464098ca3d0028e63d805940e8813c9db/whecho-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12631debb665c61afbed64dd983ef6b7ca682e270f140b1eafbab63146191951",
"md5": "70e3d77cf65967f3565e40f97babf1e2",
"sha256": "7a33cd801658affb283f290e806e3975e0903898e258310db4c9a6698cac5898"
},
"downloads": -1,
"filename": "whecho-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "70e3d77cf65967f3565e40f97babf1e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6672,
"upload_time": "2024-02-11T21:56:00",
"upload_time_iso_8601": "2024-02-11T21:56:00.056354Z",
"url": "https://files.pythonhosted.org/packages/12/63/1debb665c61afbed64dd983ef6b7ca682e270f140b1eafbab63146191951/whecho-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-11 21:56:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cvraut",
"github_project": "whecho",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "whecho"
}
JSON
