diff --git a/.abcli/blue_plugin.sh b/.abcli/blue_plugin.sh new file mode 100755 index 0000000..d0c06a3 --- /dev/null +++ b/.abcli/blue_plugin.sh @@ -0,0 +1,33 @@ +#! /usr/bin/env bash + +function bp() { + blue-plugin $@ +} + +function blue_plugin() { + local task=$(abcli_unpack_keyword $1 help) + + if [ $task == "help" ] ; then + abcli_show_usage "abct task_1" \ + "run abct task_1." + + if [ "$(abcli_keyword_is $2 verbose)" == true ] ; then + python3 -m blue_plugin --help + fi + + return + fi + + if [[ $(type -t blue_plugin_$task) == "function" ]] ; then + blue_plugin_$task ${@:2} + fi + + if [ "$task" == "task_1" ] ; then + python3 -m blue_plugin \ + task_1 \ + ${@:2} + return + fi + + abcli_log_error "-blue_plugin: $task: command not found." +} \ No newline at end of file diff --git a/.abcli/install/blue_plugin.sh b/.abcli/install/blue_plugin.sh new file mode 100644 index 0000000..29c6967 --- /dev/null +++ b/.abcli/install/blue_plugin.sh @@ -0,0 +1,7 @@ +#! /usr/bin/env bash + +function abcli_install_blue_plugin() { + abcli_log "Installing..." +} + +abcli_install_module blue_plugin 101 \ No newline at end of file diff --git a/.abcli/session.sh b/.abcli/session.sh new file mode 100644 index 0000000..640689a --- /dev/null +++ b/.abcli/session.sh @@ -0,0 +1,16 @@ +#! /usr/bin/env bash + +function blue_plugin_session() { + local task=$(abcli_unpack_keyword $1 help) + + if [ "$task" == "start" ] ; then + abcli_log "blue-plugin: session started." + + # session code here + + abcli_log "blue-plugin: session ended." + return + fi + + abcli_log_error "-blue-plugin: session: $task: command not found." +} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..be3703e --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.ipynb_checkpoints +__pycache__ +.DS_Store +*.egg-info +*.log +, .json \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d9f4f4 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# blue-plugin + +An [`awesome-bash-cli`](https://github.com/kamangir/awesome-bash-cli) (`abcli`) plugin is a mechanism to run python and bash on Linux. Examples of `abcli` plugins are: + +1. [blue-rvr](https://github.com/kamangir/blue-rvr): A rover that carries a camera, runs deep learning vision models through python and TensorFlow, and is cloud-connected. +1. [blue-sbc](https://github.com/kamangir/blue-sbc): python + bash bootstrap for single board computers: Raspberry Pi & Jetson Nano. +1. [browser](https://github.com/kamangir/browser): A browser for cloud objects with metadata. +1. [RAW Vancouver PORTAL 2022](https://github.com/kamangir/RAW-Vancouver-PORTAL-2022): A [digital art installation](https://rawartists.com/vancouver). +1. [more...](https://github.com/kamangir?tab=repositories) + +To build an `abcli` plugin you need python3 code that is executed through the command line. You may have some of this code already in a repo named ``. Otherwise, [create the new repository `\` from template](https://github.com/kamangir/blue-plugin/generate). Then, type in, + +```bash +abcli git clone init[,~from_template] +``` + diff --git a/blue_plugin/__init__.py b/blue_plugin/__init__.py new file mode 100644 index 0000000..7c5ae65 --- /dev/null +++ b/blue_plugin/__init__.py @@ -0,0 +1,5 @@ +NAME = "blue_plugin" + +VERSION = "2.51.1" + +from .functions import * diff --git a/blue_plugin/__main__.py b/blue_plugin/__main__.py new file mode 100644 index 0000000..239a796 --- /dev/null +++ b/blue_plugin/__main__.py @@ -0,0 +1,23 @@ +import argparse +from . import * +from abcli import logging +import logging + +logger = logging.getLogger(__name__) + +parser = argparse.ArgumentParser(NAME, description=f"{NAME}-{VERSION}") +parser.add_argument( + "task", + type=str, + help="TBD", +) +args = parser.parse_args() + +success = False +if args.task == "TBD": + success = True +else: + logger.error(f"-{NAME}: {args.task}: command not found.") + +if not success: + logger.error(f"-{NAME}: {args.task}: failed.") diff --git a/blue_plugin/functions.py b/blue_plugin/functions.py new file mode 100644 index 0000000..d57cf7a --- /dev/null +++ b/blue_plugin/functions.py @@ -0,0 +1,5 @@ +from . import NAME +from abcli import logging +import logging + +logger = logging.getLogger(__name__) diff --git a/blue_plugin/urls.py b/blue_plugin/urls.py new file mode 100644 index 0000000..637600f --- /dev/null +++ b/blue_plugin/urls.py @@ -0,0 +1 @@ +urlpatterns = [] diff --git a/no-browser b/no-browser new file mode 100644 index 0000000..e69de29 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..f1f741b --- /dev/null +++ b/setup.py @@ -0,0 +1,11 @@ +from setuptools import setup + +from blue_plugin import NAME, VERSION + +setup( + name=NAME, + author="kamangir", + version=VERSION, + description="template for an abcli plugin", + packages=[NAME], +)