# Cloudmesh Installer
[![image](https://img.shields.io/pypi/v/cloudmesh-installer.svg)](https://pypi.org/project/cloudmesh-installer/)
[![Python](https://img.shields.io/pypi/pyversions/cloudmesh-installer.svg)](https://pypi.python.org/pypi/cloudmesh-installer)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudmesh/cloudmesh-installer/blob/main/LICENSE)
[![Format](https://img.shields.io/pypi/format/cloudmesh-installer.svg)](https://pypi.python.org/pypi/cloudmesh-installer)
[![Status](https://img.shields.io/pypi/status/cloudmesh-installer.svg)](https://pypi.python.org/pypi/cloudmesh-installer)
[![GitHub Actions Status](https://github.com/cloudmesh/cloudmesh-installer/actions/workflows/python-package-conda.yml/badge.svg)](https://github.com/cloudmesh/cloudmesh-installer/actions/)
This is an experimental installer that is most useful during the development of
cloudmesh components form source. Once cloudmesh is released, you can use the
packages hosted at pypi.
This command can be installed with
```bash
$ pip install cloudmesh-installer
```
an FAQ is available at
* <https://github.com/cloudmesh/cloudmesh-installer/blob/main/FAQ.md>
## Usage
```bash
cloudmesh-installer git key [LOCATION] [--benchmark]
cloudmesh-installer [--ssh] git [clone|pull|status|authors] [BUNDLES...] [--benchmark]
cloudmesh-installer [--ssh] get [BUNDLES...] [--benchmark]
cloudmesh-installer update [BUNDLES...] [--benchmark]
cloudmesh-installer install [BUNDLES...] [--venv=ENV | -e] [--benchmark]
cloudmesh-installer list [BUNDLE] [--short | --git]
cloudmesh-installer version
cloudmesh-installer info [BUNDLE] [--verbose]
cloudmesh-installer clean --dir=DIR [--force]
cloudmesh-installer clean --venv=ENV [--force]
cloudmesh-installer new VENV [BUNDLES...] [--python=PYTHON]
cloudmesh-installer release [REPOS...] [--benchmark]
cloudmesh-installer pi [--dev]
cloudmesh-installer burn --branch BRANCH
cloudmesh-installer to5
cloudmesh-installer help
cloudmesh-installer usage
```
## Appendix
Timings
| Command | Time |
| --- | --- |
| `pip install cloudmesh-installer` | 0m4.558s |
| `time cloudmesh-installer install cms`| 0m18.288s |
| `time cloudmesh-installer git clone storage` | 0m4.926s |
Tests
* [test_installer](tests/test_installer.py)
## Acknowledgments
This work was in part funded by the NSF
CyberTraining: CIC: CyberTraining for Students and Technologies
from Generation Z with the awadrd numbers 1829704 and 2200409.
## Manual Page
```bash
cloudmesh-installer -- a helper to install cloudmesh from source for
developers.
Usage:
cloudmesh-installer git key [LOCATION] [--benchmark]
cloudmesh-installer [--ssh] git [BUNDLES...] [--benchmark]
cloudmesh-installer [--ssh] get [BUNDLES...] [--benchmark]
cloudmesh-installer update [BUNDLES...] [--benchmark]
cloudmesh-installer install [BUNDLES...] [--venv=ENV | -e] [--benchmark]
cloudmesh-installer list [BUNDLE] [--short | --git]
cloudmesh-installer version
cloudmesh-installer info [BUNDLE] [--verbose]
cloudmesh-installer clean --dir=DIR [--force]
cloudmesh-installer clean --venv=ENV [--force]
cloudmesh-installer new VENV [BUNDLES...] [--python=PYTHON]
cloudmesh-installer release [REPOS...] [--benchmark]
cloudmesh-installer pi [--dev]
cloudmesh-installer burn --branch BRANCH
cloudmesh-installer to5
cloudmesh-installer help
cloudmesh-installer usage
A convenient program called `cloudmesh-installer` to download and install
cloudmesh from sources published in github.
Arguments:
BUNDLE the bundle
REPOS list of git repos
ENV the name of the venv
DIR the directory form where to start the search
Options:
-h --help
--force force the execution of the command. This command could delete
files.
Note: you can also use `cmsi` instead of `cloudmesh-installer`
Description:
cmsi list
cloudmesh-installer list
Cloudmesh has a number of bundles. Bundles are simple a number of git
repositories. You can list the bundels with the list command. and see
their names in the top level.
This command lists all available bundles
cmsi list bundle
cloudmesh-installer list bundle
lists the information about a particular bundle.
cmsi list [BUNDLE] --git
cloudmesh-installer list [BUNDLE] --git
Shows the location of the repositories in a bundle.
cmsi info
cloudmesh-installer info
The info command gives some very basic information about the version
numbers of cloudmesh on your system, github, and pypi. THis helps
identifying if you may run an odlder version.
In addition we try to check if you do use venv
cmsi git key [LOCATION]
cloudmesh-installer git key [LOCATION]
This command only works if you use ssh keys to authenticate with
github.
This command makes uploading the key easy as it checks for your key and
provides via the web browser automatic pageloads to github for the
key upload. You do not have tou use this command. It is intenden for
novice users.
cmsi git [BUNDLE]
cloudmesh-installer git [BUNDLE]
This command executes the given git command on the bundle
cmsi update [BUNDLE]
cmsi get [BUNDLE]
cloudmesh-installer update [BUNDLE]
cloudmesh-installer get [BUNDLE]
For each repository in the bundle it clones it and also pulls.
Thus the command can easly be used to get a new bundle element, but
also get the new code for already existing bundles elements.
The code is checked out with https
cmsi get -ssh [BUNDLE]
cloudmesh-installer get -ssh [BUNDLE]
For each repository in the bundle it clones it and also pulls.
Thus the command can easly be used to get a new bundle element, but
also get the new code for already existing bundles elements.
The code is checked out with ssh
cmsi install [BUNDLE]
cloudmesh-installer install [BUNDLE]
This command executes an install on the given bundle
cmsi info
cloudmesh-installer info
This command is very useful to list the version of the installed
package, the version n git, and the version on pypi
cmsi clean --dir=. --force
cloudmesh-installer clean --dir=. --force
removes the egs in the current directory tree
cmsi clean --venv=ENV --force
cloudmesh-installer clean --venv=ENV --force
removes the venv in ~/ENV
Examples:
let us assume you like to work on bar, than you need to do the
following
mkdir cm
cd cm
cmsi git clone bar
cmsi install bar
cmsi info
```
Raw data
{
"_id": null,
"home_page": "",
"name": "cloudmesh-installer",
"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/8f/8c/955bd1b75314ea9a2121d883f09637eba47be63150378245d2859be92ba5/cloudmesh-installer-5.0.2.tar.gz",
"platform": null,
"description": "# Cloudmesh Installer \r\n\r\n\r\n[![image](https://img.shields.io/pypi/v/cloudmesh-installer.svg)](https://pypi.org/project/cloudmesh-installer/)\r\n[![Python](https://img.shields.io/pypi/pyversions/cloudmesh-installer.svg)](https://pypi.python.org/pypi/cloudmesh-installer)\r\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudmesh/cloudmesh-installer/blob/main/LICENSE)\r\n[![Format](https://img.shields.io/pypi/format/cloudmesh-installer.svg)](https://pypi.python.org/pypi/cloudmesh-installer)\r\n[![Status](https://img.shields.io/pypi/status/cloudmesh-installer.svg)](https://pypi.python.org/pypi/cloudmesh-installer)\r\n[![GitHub Actions Status](https://github.com/cloudmesh/cloudmesh-installer/actions/workflows/python-package-conda.yml/badge.svg)](https://github.com/cloudmesh/cloudmesh-installer/actions/)\r\n\r\n\r\nThis is an experimental installer that is most useful during the development of\r\ncloudmesh components form source. Once cloudmesh is released, you can use the\r\npackages hosted at pypi.\r\n\r\nThis command can be installed with \r\n\r\n```bash\r\n$ pip install cloudmesh-installer\r\n```\r\n\r\nan FAQ is available at\r\n\r\n* <https://github.com/cloudmesh/cloudmesh-installer/blob/main/FAQ.md>\r\n\r\n## Usage\r\n\r\n```bash\r\ncloudmesh-installer git key [LOCATION] [--benchmark]\r\ncloudmesh-installer [--ssh] git [clone|pull|status|authors] [BUNDLES...] [--benchmark]\r\ncloudmesh-installer [--ssh] get [BUNDLES...] [--benchmark]\r\ncloudmesh-installer update [BUNDLES...] [--benchmark]\r\ncloudmesh-installer install [BUNDLES...] [--venv=ENV | -e] [--benchmark]\r\ncloudmesh-installer list [BUNDLE] [--short | --git]\r\ncloudmesh-installer version\r\ncloudmesh-installer info [BUNDLE] [--verbose]\r\ncloudmesh-installer clean --dir=DIR [--force]\r\ncloudmesh-installer clean --venv=ENV [--force]\r\ncloudmesh-installer new VENV [BUNDLES...] [--python=PYTHON]\r\ncloudmesh-installer release [REPOS...] [--benchmark]\r\ncloudmesh-installer pi [--dev]\r\ncloudmesh-installer burn --branch BRANCH\r\ncloudmesh-installer to5\r\ncloudmesh-installer help\r\ncloudmesh-installer usage\r\n```\r\n\r\n## Appendix\r\n\r\nTimings\r\n\r\n| Command | Time |\r\n| --- | --- |\r\n| `pip install cloudmesh-installer` | \t0m4.558s |\r\n| `time cloudmesh-installer install cms`| 0m18.288s |\r\n| `time cloudmesh-installer git clone storage` | \t0m4.926s |\r\n\r\n\r\nTests\r\n\r\n * [test_installer](tests/test_installer.py)\r\n \r\n## Acknowledgments\r\n\r\nThis work was in part funded by the NSF\r\nCyberTraining: CIC: CyberTraining for Students and Technologies\r\nfrom Generation Z with the awadrd numbers 1829704 and 2200409.\r\n\r\n\r\n\r\n## Manual Page\r\n\r\n```bash\r\ncloudmesh-installer -- a helper to install cloudmesh from source for \r\ndevelopers.\r\nUsage:\r\n cloudmesh-installer git key [LOCATION] [--benchmark]\r\n cloudmesh-installer [--ssh] git [BUNDLES...] [--benchmark]\r\n cloudmesh-installer [--ssh] get [BUNDLES...] [--benchmark]\r\n cloudmesh-installer update [BUNDLES...] [--benchmark]\r\n cloudmesh-installer install [BUNDLES...] [--venv=ENV | -e] [--benchmark]\r\n cloudmesh-installer list [BUNDLE] [--short | --git]\r\n cloudmesh-installer version\r\n cloudmesh-installer info [BUNDLE] [--verbose]\r\n cloudmesh-installer clean --dir=DIR [--force]\r\n cloudmesh-installer clean --venv=ENV [--force]\r\n cloudmesh-installer new VENV [BUNDLES...] [--python=PYTHON]\r\n cloudmesh-installer release [REPOS...] [--benchmark]\r\n cloudmesh-installer pi [--dev]\r\n cloudmesh-installer burn --branch BRANCH\r\n cloudmesh-installer to5\r\n cloudmesh-installer help\r\n cloudmesh-installer usage\r\nA convenient program called `cloudmesh-installer` to download and install\r\ncloudmesh from sources published in github.\r\nArguments:\r\n BUNDLE the bundle \r\n REPOS list of git repos\r\n ENV the name of the venv\r\n DIR the directory form where to start the search\r\nOptions:\r\n -h --help\r\n --force force the execution of the command. This command could delete \r\nfiles.\r\nNote: you can also use `cmsi` instead of `cloudmesh-installer`\r\nDescription:\r\n cmsi list\r\n cloudmesh-installer list\r\n Cloudmesh has a number of bundles. Bundles are simple a number of git\r\n repositories. You can list the bundels with the list command. and see\r\n their names in the top level.\r\n This command lists all available bundles\r\n cmsi list bundle\r\n cloudmesh-installer list bundle\r\n lists the information about a particular bundle.\r\n cmsi list [BUNDLE] --git\r\n cloudmesh-installer list [BUNDLE] --git\r\n Shows the location of the repositories in a bundle.\r\n cmsi info\r\n cloudmesh-installer info\r\n The info command gives some very basic information about the version\r\n numbers of cloudmesh on your system, github, and pypi. THis helps\r\n identifying if you may run an odlder version.\r\n In addition we try to check if you do use venv\r\n cmsi git key [LOCATION]\r\n cloudmesh-installer git key [LOCATION]\r\n This command only works if you use ssh keys to authenticate with \r\ngithub.\r\n This command makes uploading the key easy as it checks for your key and\r\n provides via the web browser automatic pageloads to github for the\r\n key upload. You do not have tou use this command. It is intenden for\r\n novice users.\r\n cmsi git [BUNDLE]\r\n cloudmesh-installer git [BUNDLE]\r\n This command executes the given git command on the bundle\r\n cmsi update [BUNDLE]\r\n cmsi get [BUNDLE]\r\n cloudmesh-installer update [BUNDLE]\r\n cloudmesh-installer get [BUNDLE]\r\n For each repository in the bundle it clones it and also pulls.\r\n Thus the command can easly be used to get a new bundle element, but\r\n also get the new code for already existing bundles elements.\r\n The code is checked out with https\r\n cmsi get -ssh [BUNDLE]\r\n cloudmesh-installer get -ssh [BUNDLE]\r\n For each repository in the bundle it clones it and also pulls.\r\n Thus the command can easly be used to get a new bundle element, but\r\n also get the new code for already existing bundles elements.\r\n The code is checked out with ssh\r\n cmsi install [BUNDLE]\r\n cloudmesh-installer install [BUNDLE]\r\n This command executes an install on the given bundle\r\n cmsi info\r\n cloudmesh-installer info\r\n This command is very useful to list the version of the installed\r\n package, the version n git, and the version on pypi\r\n cmsi clean --dir=. --force\r\n cloudmesh-installer clean --dir=. --force\r\n removes the egs in the current directory tree\r\n cmsi clean --venv=ENV --force\r\n cloudmesh-installer clean --venv=ENV --force\r\n removes the venv in ~/ENV\r\n Examples:\r\n let us assume you like to work on bar, than you need to do the \r\nfollowing\r\n mkdir cm\r\n cd cm\r\n cmsi git clone bar\r\n cmsi install bar\r\n cmsi info\r\n```\r\n\r\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": "Installer for cloudmesh",
"version": "5.0.2",
"project_urls": {
"Changelog": "https://github.com/cloudmesh/cloudmesh-installer/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/cloudmesh/cloudmesh-installer/blob/main/README.md",
"Homepage": "https://github.com/cloudmesh/cloudmesh-installer",
"Issues": "https://github.com/cloudmesh/cloudmesh-installer/issues",
"Repository": "https://github.com/cloudmesh/cloudmesh-installer.git"
},
"split_keywords": [
"helper library",
"cloudmesh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7b9637fe4c4d8c8f434c17cb013f4bf282236f519e833810cd3e9b0ff6ac9ac",
"md5": "a29bc82bedd6b5b050ed33669417f59b",
"sha256": "1291cbfe85f37e7062c8e980f29c0c21ae721a8114403c9826a16522d3d6fcb8"
},
"downloads": -1,
"filename": "cloudmesh_installer-5.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a29bc82bedd6b5b050ed33669417f59b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 14882,
"upload_time": "2024-01-16T02:27:06",
"upload_time_iso_8601": "2024-01-16T02:27:06.926294Z",
"url": "https://files.pythonhosted.org/packages/e7/b9/637fe4c4d8c8f434c17cb013f4bf282236f519e833810cd3e9b0ff6ac9ac/cloudmesh_installer-5.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f8c955bd1b75314ea9a2121d883f09637eba47be63150378245d2859be92ba5",
"md5": "6df5b397cb2a17445bd82711e49347e8",
"sha256": "3b0a47d6c758230cba0a2bb49e4b0543b63a7e33e0b0f8ff268a1b2885758e56"
},
"downloads": -1,
"filename": "cloudmesh-installer-5.0.2.tar.gz",
"has_sig": false,
"md5_digest": "6df5b397cb2a17445bd82711e49347e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19648,
"upload_time": "2024-01-16T02:27:08",
"upload_time_iso_8601": "2024-01-16T02:27:08.732303Z",
"url": "https://files.pythonhosted.org/packages/8f/8c/955bd1b75314ea9a2121d883f09637eba47be63150378245d2859be92ba5/cloudmesh-installer-5.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-16 02:27:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cloudmesh",
"github_project": "cloudmesh-installer",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "cloudmesh-installer"
}