# Cloudmesh cmd5
[](https://zenodo.org/badge/latestdoi/82920490)
[](https://pypi.org/project/cloudmesh-cmd5/)
[](https://pypi.python.org/pypi/cloudmesh-cmd5)
[](https://github.com/cloudmesh/cloudmesh-cmd5/blob/main/LICENSE)
[](https://pypi.python.org/pypi/cloudmesh-cmd5)
[](https://pypi.python.org/pypi/cloudmesh-cmd5)
[](https://travis-ci.com/cloudmesh/cloudmesh-cmd5)
## Installation and Documentation
Please note that several packages are available which are pointed to in the
installation documentation.
| | Links |
|---------------|-------|
| Documentation | <https://cloudmesh.github.io/cloudmesh-cloud> |
| Code | <https://github.com/cloudmesh/cloudmesh-cloud> |
| Installation Instructions | <https://github.com/cloudmesh/get> |
An dynamically extensible CMD based command shell. For en extensive
documentation please see
* <https://github.com/cloudmesh-community/book/blob/main/vonLaszewski-cloud.epub?raw=true>
where we also document how to use pyenv virtualenv.
## Requirements
* Python greater equal 3.8.1
Cloudmesh was able to run on earlier versions of python, but we do prefer to
test it on the newest version.
We recommend that you use venv first before you install cloudmesh. This
You can as user install cmd5 with
```bash
pip install cloudemsh-cmd5
```
Developers should look at our cloudmesh manual.
* <https://cloudmesh.github.io/cloudmesh-manual/>
## CMD5 Shell and Commandline
to run the shell you can activate it with the cms command. cms stands
for cloudmesh shell::
```bash
$ cms
```
It will print the banner and enter the shell::
```
+-------------------------------------------------------+
| ____ _ _ _ |
| / ___| | ___ _ _ __| |_ __ ___ ___ ___| |__ |
| | | | |/ _ \| | | |/ _` | '_ ` _ \ / _ \/ __| '_ \ |
| | |___| | (_) | |_| | (_| | | | | | | __/\__ \ | | | |
| \____|_|\___/ \__,_|\__,_|_| |_| |_|\___||___/_| |_| |
+-------------------------------------------------------+
| Cloudmesh CMD5 Shell |
+-------------------------------------------------------+
cms>
```
To see the list of commands you can say::
```
cms> help
```
```bash
Documented commands (type help <topic>):
========================================
EOF commands default help pause q shell sys version
banner config echo info plugin quit sleep test
clear debug gui man py set stopwatch var
```
To see the manual page for a specific command, please use::
```
cms> help COMMANDNAME
```
A full manual page is available at
* <https://cloudmesh.github.io/cloudmesh-manual/>
## CMD 5 Plugin Mechanism
Cmd5 comes with a sophisticated plugin mechanism. Commands can be readily
designed from the sys command.
The sys command can be installed either from source (as discussed previously) or
via pip
```bash
$ pip install cloudmesh-sys
```
Once you have installed it, execute `cms help sys` to see the usage. Now you
simply can in a new directory execute the sys command as follows, where
`mycommnad` is than name of the command you like to implement.
```bash
$ mkdir mycommand
$ cd mycommand
$ cms sys command generate mycommand .
```
A directory with the name `cloudmesh-mycommand` will be generated that contains
the template for the command. You can enter this template and modify the
implementation in the folders `cloudmesh/mycommand/api` and
`cloudmesh/mycommand/command` when installing it with
```
$ pip install .
```
The command will be added to the cms command>
An example for the bar command is presented at:
* [cloudmesh/bar/command/bar.py](https://github.com/cloudmesh/cloudmesh.bar/blob/main/cloudmesh/bar/command/bar.py)
It shows how simple the command definition is (bar.py)::
```bash
from cloudmesh.shell.command import command
from cloudmesh.shell.command import PluginCommand
class BarCommand(PluginCommand):
@command
def do_bar(self, args, arguments):
"""
::
Usage:
command -f FILE
command FILE
command list
This command does some useful things.
Arguments:
FILE a file name
Options:
-f specify the file
"""
print(arguments)
```
An important difference to other CMD solutions is that our commands
can leverage (besides the standard definition), docopts as a way to
define the manual page. This allows us to use arguments as dict and
use simple if conditions to interpret the command. Using docopts has
the advantage that contributors are forced to think about the command
and its options and document them from the start. Previously we used
not to use docopts and argparse was used. However we noticed that for
some contributions the lead to commands that were either not properly
documented or the developers delivered ambiguous commands that
resulted in confusion and wrong usage by the users. Hence, we do
recommend that you use docopts.
The transformation is enabled by the `@command` decorator that takes
also the manual page and creates a proper help message for the shell
automatically. Thus there is no need to introduce a separate help
method as would normally be needed in CMD.
## Features
The following highlighted features are available:
* easy command integration through separate modules
* multi cloud environments (under development) though cloudmesh-cloud plugin
* openapi integration through cloudmesh-openapi plugin
* general commands as documented at in the
[manual](https://cloudmesh.github.io/cloudmesh-manual/) such as
[admin](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/admin.html),
[banner](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/banner.html),
[clear](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/clear.html),
[echo](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/echo.html),
[default](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/default.html),
[info](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/info.html),
[pause](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/pause.html),
[plugin](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/plugin.html),
[quit](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/quit.html),
[shell](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/shell.html),
[sleep](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/sleep.html),
[stopwatch](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/stopwatch.html),
[sys](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/sys.html),
[var](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/var.html),
[version](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/version.html),
[open](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/open.html),
and others
## New Features
* Support for terminals with dark background
* Support for python in variable assignments
```
cms set a=\"py 1 + 1\"
a='2'
```
* Support for executing python in a py command
```
cms py 1 + 1
2
```
* Support for shell commands in the variabe value
```
cms set a=\!pwd
```
* Support for reading values from a yaml configuration file in
`~/.cloudmesh/cloudmesh.yaml`
```
cms set a=cloudmesh.profile.user
```
where it is defined as
```
cloudmesh:
profile:
user: gregor
```
## Manual Page
<!-- START-MANUAL -->
```
Documented commands (type help <topic>):
========================================
EOF commands echo q shell sysinfo
banner debug man quit sleep term
bar default help pause var version
clear dryrun info py set sys
```
<!-- STOP-MANUAL -->
Raw data
{
"_id": null,
"home_page": "",
"name": "cloudmesh-cmd5",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Gregor von Laszewski <laszewski@gmail.com>",
"keywords": "helper library,cloudmesh",
"author": "",
"author_email": "Gregor von Laszewski <laszewski@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/c2/99a0e69da7428ab423515d854cdff5d519614675299db952391fe13da1df/cloudmesh-cmd5-5.0.20.tar.gz",
"platform": null,
"description": "# Cloudmesh cmd5\n\n[](https://zenodo.org/badge/latestdoi/82920490)\n\n\n[](https://pypi.org/project/cloudmesh-cmd5/)\n[](https://pypi.python.org/pypi/cloudmesh-cmd5)\n[](https://github.com/cloudmesh/cloudmesh-cmd5/blob/main/LICENSE)\n[](https://pypi.python.org/pypi/cloudmesh-cmd5)\n[](https://pypi.python.org/pypi/cloudmesh-cmd5)\n[](https://travis-ci.com/cloudmesh/cloudmesh-cmd5)\n\n\n\n\n## Installation and Documentation\n\nPlease note that several packages are available which are pointed to in the\ninstallation documentation.\n\n| | Links |\n|---------------|-------|\n| Documentation | <https://cloudmesh.github.io/cloudmesh-cloud> |\n| Code | <https://github.com/cloudmesh/cloudmesh-cloud> |\n| Installation Instructions | <https://github.com/cloudmesh/get> |\n\nAn dynamically extensible CMD based command shell. For en extensive\ndocumentation please see\n\n* <https://github.com/cloudmesh-community/book/blob/main/vonLaszewski-cloud.epub?raw=true>\n\nwhere we also document how to use pyenv virtualenv.\n\n## Requirements\n\n* Python greater equal 3.8.1\n\nCloudmesh was able to run on earlier versions of python, but we do prefer to\ntest it on the newest version.\n\nWe recommend that you use venv first before you install cloudmesh. This\n\nYou can as user install cmd5 with\n\n\n```bash\npip install cloudemsh-cmd5\n```\n\nDevelopers should look at our cloudmesh manual.\n\n* <https://cloudmesh.github.io/cloudmesh-manual/>\n\n## CMD5 Shell and Commandline\n\n\nto run the shell you can activate it with the cms command. cms stands\nfor cloudmesh shell::\n\n```bash\n$ cms\n```\n\nIt will print the banner and enter the shell::\n\n```\n+-------------------------------------------------------+\n| ____ _ _ _ |\n| / ___| | ___ _ _ __| |_ __ ___ ___ ___| |__ |\n| | | | |/ _ \\| | | |/ _` | '_ ` _ \\ / _ \\/ __| '_ \\ |\n| | |___| | (_) | |_| | (_| | | | | | | __/\\__ \\ | | | |\n| \\____|_|\\___/ \\__,_|\\__,_|_| |_| |_|\\___||___/_| |_| |\n+-------------------------------------------------------+\n| Cloudmesh CMD5 Shell |\n+-------------------------------------------------------+\n\ncms>\n```\n\nTo see the list of commands you can say::\n\n```\ncms> help\n```\n\n```bash\nDocumented commands (type help <topic>):\n========================================\nEOF commands default help pause q shell sys version\nbanner config echo info plugin quit sleep test\nclear debug gui man py set stopwatch var \n```\n\nTo see the manual page for a specific command, please use::\n\n```\ncms> help COMMANDNAME\n```\n\nA full manual page is available at\n\n* <https://cloudmesh.github.io/cloudmesh-manual/>\n\n## CMD 5 Plugin Mechanism\n\nCmd5 comes with a sophisticated plugin mechanism. Commands can be readily\ndesigned from the sys command.\n\nThe sys command can be installed either from source (as discussed previously) or\nvia pip\n\n```bash\n$ pip install cloudmesh-sys\n```\n\nOnce you have installed it, execute `cms help sys` to see the usage. Now you\nsimply can in a new directory execute the sys command as follows, where\n`mycommnad` is than name of the command you like to implement.\n\n```bash\n$ mkdir mycommand\n$ cd mycommand\n$ cms sys command generate mycommand .\n```\n\nA directory with the name `cloudmesh-mycommand` will be generated that contains\nthe template for the command. You can enter this template and modify the\nimplementation in the folders `cloudmesh/mycommand/api` and\n`cloudmesh/mycommand/command` when installing it with\n\n```\n$ pip install .\n```\n\nThe command will be added to the cms command>\n\nAn example for the bar command is presented at:\n\n* [cloudmesh/bar/command/bar.py](https://github.com/cloudmesh/cloudmesh.bar/blob/main/cloudmesh/bar/command/bar.py)\n\nIt shows how simple the command definition is (bar.py)::\n\n```bash\nfrom cloudmesh.shell.command import command\nfrom cloudmesh.shell.command import PluginCommand\n\nclass BarCommand(PluginCommand):\n\n @command\n def do_bar(self, args, arguments):\n \"\"\"\n ::\n \n Usage:\n command -f FILE\n command FILE\n command list\n This command does some useful things.\n Arguments:\n FILE a file name\n Options:\n -f specify the file\n \"\"\"\n print(arguments)\n```\n\nAn important difference to other CMD solutions is that our commands\ncan leverage (besides the standard definition), docopts as a way to\ndefine the manual page. This allows us to use arguments as dict and\nuse simple if conditions to interpret the command. Using docopts has\nthe advantage that contributors are forced to think about the command\nand its options and document them from the start. Previously we used\nnot to use docopts and argparse was used. However we noticed that for\nsome contributions the lead to commands that were either not properly\ndocumented or the developers delivered ambiguous commands that\nresulted in confusion and wrong usage by the users. Hence, we do\nrecommend that you use docopts.\n\nThe transformation is enabled by the `@command` decorator that takes\nalso the manual page and creates a proper help message for the shell\nautomatically. Thus there is no need to introduce a separate help\nmethod as would normally be needed in CMD.\n\n## Features\n\nThe following highlighted features are available:\n\n* easy command integration through separate modules\n* multi cloud environments (under development) though cloudmesh-cloud plugin\n* openapi integration through cloudmesh-openapi plugin\n* general commands as documented at in the\n\n [manual](https://cloudmesh.github.io/cloudmesh-manual/) such as\n [admin](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/admin.html),\n [banner](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/banner.html),\n [clear](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/clear.html),\n [echo](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/echo.html),\n [default](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/default.html),\n [info](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/info.html),\n [pause](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/pause.html),\n [plugin](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/plugin.html),\n [quit](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/quit.html),\n [shell](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/shell.html),\n [sleep](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/sleep.html),\n [stopwatch](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/stopwatch.html),\n [sys](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/sys.html),\n [var](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/var.html),\n [version](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/version.html),\n [open](https://cloudmesh.github.io/cloudmesh-manual/manual/cmd5/open.html),\n and others\n\n\n\n## New Features\n\n* Support for terminals with dark background\n* Support for python in variable assignments\n\n ```\n cms set a=\\\"py 1 + 1\\\"\n a='2'\n ```\n\n* Support for executing python in a py command\n\n ```\n cms py 1 + 1\n 2\n ```\n \n* Support for shell commands in the variabe value\n\n ```\n cms set a=\\!pwd\n ```\n \n* Support for reading values from a yaml configuration file in\n `~/.cloudmesh/cloudmesh.yaml`\n\n ``` \n cms set a=cloudmesh.profile.user\n ```\n \n where it is defined as\n \n ```\n cloudmesh:\n profile:\n user: gregor\n ```\n## Manual Page\n\n<!-- START-MANUAL -->\n```\nDocumented commands (type help <topic>):\n========================================\nEOF commands echo q shell sysinfo \nbanner debug man quit sleep term \nbar default help pause var version\nclear dryrun info py set sys \n```\n<!-- STOP-MANUAL -->\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ Copyright 2017-2021 Gregor von Laszewski, Indiana University Copyright 2021,2022 Gregor von Laszewski, University of Virginia Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
"summary": "The cloudmesh command shell",
"version": "5.0.20",
"project_urls": {
"Changelog": "https://github.com/cloudmesh/cloudmesh-cmd5/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/cloudmesh/cloudmesh-cmd5/blob/main/README.md",
"Homepage": "https://github.com/cloudmesh/cloudmesh-cmd5",
"Issues": "https://github.com/cloudmesh/cloudmesh-cmd5/issues",
"Repository": "https://github.com/cloudmesh/cloudmesh-cmd5.git"
},
"split_keywords": [
"helper library",
"cloudmesh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c063e76ed19091e115ecad170db886d19976b453fe60ef78e4544201f8c21a43",
"md5": "63ea6365c5f356964f1f8adc8e74a223",
"sha256": "12834952224b486ce66de0bda6d71d1e97a6d4bafa09ec675204a3afebdde085"
},
"downloads": -1,
"filename": "cloudmesh_cmd5-5.0.20-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "63ea6365c5f356964f1f8adc8e74a223",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 30236,
"upload_time": "2024-01-05T21:13:37",
"upload_time_iso_8601": "2024-01-05T21:13:37.130644Z",
"url": "https://files.pythonhosted.org/packages/c0/63/e76ed19091e115ecad170db886d19976b453fe60ef78e4544201f8c21a43/cloudmesh_cmd5-5.0.20-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bac299a0e69da7428ab423515d854cdff5d519614675299db952391fe13da1df",
"md5": "6f98117ba9df0c659a77bd4c7ffc2958",
"sha256": "59eb13bf70cc892c0ae1e987822bf79d87488df5023f1ff4c289ff5e4aa591fd"
},
"downloads": -1,
"filename": "cloudmesh-cmd5-5.0.20.tar.gz",
"has_sig": false,
"md5_digest": "6f98117ba9df0c659a77bd4c7ffc2958",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 32052,
"upload_time": "2024-01-05T21:13:39",
"upload_time_iso_8601": "2024-01-05T21:13:39.532225Z",
"url": "https://files.pythonhosted.org/packages/ba/c2/99a0e69da7428ab423515d854cdff5d519614675299db952391fe13da1df/cloudmesh-cmd5-5.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-05 21:13:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cloudmesh",
"github_project": "cloudmesh-cmd5",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "cloudmesh-cmd5"
}
