clicast
=======
Broadcast messages for CLI tools, such as a warning for critical bug or notification about new features.
Quick Start Tutorial
====================
As easy as 1-2-3:
1. Install::
pip install clicast
2. Create your own cast file and make it accessible as an URL.
I.e. https://raw.githubusercontent.com/maxzheng/clicast/master/tests/example.cast ::
cast "New Message" -f example.cast
# See 'cast -h' for more options to edit cast file
3. Import and call check_message::
from clicast import check_message
def main():
check_message('https://raw.githubusercontent.com/maxzheng/clicast/master/tests/example.cast',
allow_exit=True,
header='=' * 80,
footer='=' * 80)
CLI Example
============
Don't even want to write the bin script to try? I got you covered! :) ::
$ wget https://raw.githubusercontent.com/maxzheng/clicast/master/bin/cast-example
$ chmod +x cast-example
If you run cast-example for the first time, you will see::
$ ./cast-example
================================================================================
We found a big bad bug. Please try not to step on it!! Icky...
No worries. It will be fixed soon! :)
Version 0.1 has been released! If you upgrade, you will get:
1) Cool feature 1
2) Cool feature 2
So what are you waiting for? :)
Version 0.2 has been released! Upgrade today to get cool features.
There is a small bug over there, so watch out!
================================================================================
Hello World! Pass in '-f' to see message targeted for that option
And run it again::
$ ./cast-example
================================================================================
We found a big bad bug. Please try not to step on it!! Icky...
No worries. It will be fixed soon! :)
================================================================================
Hello World! Pass in '-f' to see message targeted for that option
And now with -f option::
$ ./cast-example -f
================================================================================
We found a big bad bug. Please try not to step on it!! Icky...
No worries. It will be fixed soon! :)
A bug that affects the -f option. (applies only if `clicast.filters.match_cli_args` filter is used)
================================================================================
Hello World! Pass in '-f' to see message targeted for that option
That's it!
More
====
| Documentation: http://clicast.readthedocs.org/
|
| PyPI: https://pypi.python.org/pypi/clicast
| GitHub Project: https://github.com/maxzheng/clicast
| Report Issues/Bugs: https://github.com/maxzheng/clicast/issues
|
| Connect: https://www.linkedin.com/in/maxzheng
| Contact: maxzheng.os @t gmail.com
Raw data
{
"_id": null,
"home_page": "https://github.com/maxzheng/clicast",
"name": "clicast",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cli broadcast command warning critical bug",
"author": "Max Zheng",
"author_email": "maxzheng.os @t gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7b/dd/8807daa012e2a857ed27cbff33724a307b837462ad70dbd2c90f8bacdf6d/clicast-1.0.1.tar.gz",
"platform": null,
"description": "clicast\n=======\n\nBroadcast messages for CLI tools, such as a warning for critical bug or notification about new features.\n\nQuick Start Tutorial\n====================\n\nAs easy as 1-2-3:\n\n1. Install::\n\n pip install clicast\n\n2. Create your own cast file and make it accessible as an URL.\n I.e. https://raw.githubusercontent.com/maxzheng/clicast/master/tests/example.cast ::\n\n cast \"New Message\" -f example.cast\n # See 'cast -h' for more options to edit cast file\n\n3. Import and call check_message::\n\n from clicast import check_message\n\n def main():\n check_message('https://raw.githubusercontent.com/maxzheng/clicast/master/tests/example.cast',\n allow_exit=True,\n header='=' * 80,\n footer='=' * 80)\n\nCLI Example\n============\n\nDon't even want to write the bin script to try? I got you covered! :) ::\n\n $ wget https://raw.githubusercontent.com/maxzheng/clicast/master/bin/cast-example\n $ chmod +x cast-example\n\nIf you run cast-example for the first time, you will see::\n\n $ ./cast-example\n ================================================================================\n We found a big bad bug. Please try not to step on it!! Icky...\n No worries. It will be fixed soon! :)\n\n Version 0.1 has been released! If you upgrade, you will get:\n 1) Cool feature 1\n 2) Cool feature 2\n So what are you waiting for? :)\n\n Version 0.2 has been released! Upgrade today to get cool features.\n\n There is a small bug over there, so watch out!\n ================================================================================\n Hello World! Pass in '-f' to see message targeted for that option\n\nAnd run it again::\n\n $ ./cast-example\n ================================================================================\n We found a big bad bug. Please try not to step on it!! Icky...\n No worries. It will be fixed soon! :)\n ================================================================================\n Hello World! Pass in '-f' to see message targeted for that option\n\nAnd now with -f option::\n\n $ ./cast-example -f\n ================================================================================\n We found a big bad bug. Please try not to step on it!! Icky...\n No worries. It will be fixed soon! :)\n\n A bug that affects the -f option. (applies only if `clicast.filters.match_cli_args` filter is used)\n ================================================================================\n Hello World! Pass in '-f' to see message targeted for that option\n\nThat's it!\n\nMore\n====\n\n| Documentation: http://clicast.readthedocs.org/\n|\n| PyPI: https://pypi.python.org/pypi/clicast\n| GitHub Project: https://github.com/maxzheng/clicast\n| Report Issues/Bugs: https://github.com/maxzheng/clicast/issues\n|\n| Connect: https://www.linkedin.com/in/maxzheng\n| Contact: maxzheng.os @t gmail.com\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Broadcast messages for CLI tools, such as a warning for critical bug or notification about new features.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/maxzheng/clicast"
},
"split_keywords": [
"cli",
"broadcast",
"command",
"warning",
"critical",
"bug"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ee4050ba96c4076a30736eac287a18634f710a3abd27bb344055e6ed6258e82",
"md5": "075f15ac35820a86a98a4254b34b0004",
"sha256": "6f048298e194d80672d1308708db964958de740e3efae13b3663b594ff412c2c"
},
"downloads": -1,
"filename": "clicast-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "075f15ac35820a86a98a4254b34b0004",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9165,
"upload_time": "2024-01-07T17:40:32",
"upload_time_iso_8601": "2024-01-07T17:40:32.894812Z",
"url": "https://files.pythonhosted.org/packages/2e/e4/050ba96c4076a30736eac287a18634f710a3abd27bb344055e6ed6258e82/clicast-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7bdd8807daa012e2a857ed27cbff33724a307b837462ad70dbd2c90f8bacdf6d",
"md5": "6583e7ec944df78dac5facae2f1e5259",
"sha256": "3b4eb7593972d1d6b6ad829135ccdb080d804534cdbd8ebd651c99ea1cfa5129"
},
"downloads": -1,
"filename": "clicast-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "6583e7ec944df78dac5facae2f1e5259",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18152,
"upload_time": "2024-01-07T17:40:34",
"upload_time_iso_8601": "2024-01-07T17:40:34.568555Z",
"url": "https://files.pythonhosted.org/packages/7b/dd/8807daa012e2a857ed27cbff33724a307b837462ad70dbd2c90f8bacdf6d/clicast-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-07 17:40:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxzheng",
"github_project": "clicast",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"requirements": [
{
"name": "localconfig",
"specs": [
[
"==",
"1.1.*"
]
]
},
{
"name": "remoteconfig",
"specs": []
},
{
"name": "requests",
"specs": []
}
],
"tox": true,
"lcname": "clicast"
}
JSON
