[](https://mash-client.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/mash-client/)
[](https://pypi.org/project/mash-client/)
**mash-client**
overview
========
**mash-client** provides a command line utility to interface with the
MASH server REST API.
Installation
============
To install the package use the following commands as root:
```shell
$ zypper ar http://download.opensuse.org/repositories/Cloud:/Tools/<distribution>
$ zypper refresh
$ zypper in mash-client
```
Requirements
============
- Click
- requests
- PyYaml
- PyJWT
# [Docs](https://mash-client.readthedocs.io/en/latest/)
Usage
=====
Mash user commands
==================
The mash user account is the authentication mechanism of a user against the mash server. It will store information about cloud framework specific account information. The cloud framework account information stored for a given mash user provides the credentials necessary for mash to access a cloud framework account.
`mash user create`
Create a mash user account.
`mash user delete`
Delete a mash user account.
`mash user info`
List information about your user account.
Mash authentication commands
============================
Authentication command are used after a mash user has been created
`mash auth login`
Login to the mash user account
`mash auth logout`
Log out of the mash user account
`mash auth token`
Manage the authentication token
Mash cloud account commands
===========================
`mash account <framework> add`
Add cloud framework account information to the mash user account. Supported <framework>s are azure, ec2, and gce.
`mash account <framework> delete`
Remove cloud framework account information from the mash user account.
`mash account <framework> info`
Retrieve cloud framework account information from the mash user account.
`mash account <framework> list`
List all the framework accounts configured for the mash user.
`mash account <framework> update`
Update information for a cloud framework account for the mash user.
Mash job commands
=================
`mash job <framework> add [PATH_TO_JOB_DOC]`
Send a job request to the mash server submitting the specified job document.
The job document will be validated and a UUID is returned if the job is accepted.
`mash job delete`
Delete a job from the mash server. If the job is a one time job parts of the job may already be executed and created artifacts are not cleaned up.
`mash job info`
Retrieve information about a given job in the pipeline.
`mash job list`
List all the user's job in the mash pipeline.
All commands and subcommands support the `--help` option to provide command help. For example
`mash account azure add --help`
Issues/Enhancements
===================
Please submit issues and requests to
[Github](https://github.com/SUSE-Enceladus/mash-client/issues).
Contributing
============
Contributions to **mash-client** are welcome and encouraged. See
[CONTRIBUTING](https://github.com/SUSE-Enceladus/mash-client/blob/master/CONTRIBUTING.md)
for info on getting started.
License
=======
Copyright (c) 2019 SUSE LLC.
Distributed under the terms of GPL-3.0+ license, see
[LICENSE](https://github.com/SUSE-Enceladus/mash-client/blob/master/LICENSE)
for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/SUSE-enceladus/mash-client",
"name": "mash-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "",
"keywords": "mash-client mash client",
"author": "SUSE",
"author_email": "public-cloud-dev@susecloud.net",
"download_url": "https://files.pythonhosted.org/packages/8c/12/10b09ae6dc9aa32998e99a263262d64e3fa53eec6e35ddbb0aa6551ddcef/mash-client-4.1.0.tar.gz",
"platform": null,
"description": "\n[](https://mash-client.readthedocs.io/en/latest/?badge=latest)\n[](https://pypi.org/project/mash-client/)\n[](https://pypi.org/project/mash-client/)\n\n**mash-client**\n\noverview\n========\n\n**mash-client** provides a command line utility to interface with the\nMASH server REST API.\n\nInstallation\n============\n\nTo install the package use the following commands as root:\n\n```shell\n$ zypper ar http://download.opensuse.org/repositories/Cloud:/Tools/<distribution>\n$ zypper refresh\n$ zypper in mash-client\n```\n\nRequirements\n============\n\n- Click\n- requests\n- PyYaml\n- PyJWT\n\n# [Docs](https://mash-client.readthedocs.io/en/latest/)\n\nUsage\n=====\n\nMash user commands\n==================\n\nThe mash user account is the authentication mechanism of a user against the mash server. It will store information about cloud framework specific account information. The cloud framework account information stored for a given mash user provides the credentials necessary for mash to access a cloud framework account.\n\n`mash user create`\n\nCreate a mash user account.\n\n`mash user delete`\n\nDelete a mash user account.\n\n`mash user info`\n\nList information about your user account.\n\n\nMash authentication commands\n============================\n\nAuthentication command are used after a mash user has been created\n\n`mash auth login`\n\nLogin to the mash user account\n\n`mash auth logout`\n\nLog out of the mash user account\n\n`mash auth token`\n\nManage the authentication token\n\n\nMash cloud account commands\n===========================\n\n`mash account <framework> add`\n\nAdd cloud framework account information to the mash user account. Supported <framework>s are azure, ec2, and gce.\n\n`mash account <framework> delete`\n\nRemove cloud framework account information from the mash user account.\n\n`mash account <framework> info`\n\nRetrieve cloud framework account information from the mash user account.\n\n`mash account <framework> list`\n\nList all the framework accounts configured for the mash user.\n\n`mash account <framework> update`\n\nUpdate information for a cloud framework account for the mash user.\n\n\nMash job commands\n=================\n\n`mash job <framework> add [PATH_TO_JOB_DOC]`\n\nSend a job request to the mash server submitting the specified job document.\nThe job document will be validated and a UUID is returned if the job is accepted.\n\n`mash job delete`\n\nDelete a job from the mash server. If the job is a one time job parts of the job may already be executed and created artifacts are not cleaned up.\n\n`mash job info`\n\nRetrieve information about a given job in the pipeline.\n\n`mash job list`\n\nList all the user's job in the mash pipeline.\n\nAll commands and subcommands support the `--help` option to provide command help. For example\n\n`mash account azure add --help`\n\nIssues/Enhancements\n===================\n\nPlease submit issues and requests to\n[Github](https://github.com/SUSE-Enceladus/mash-client/issues).\n\nContributing\n============\n\nContributions to **mash-client** are welcome and encouraged. See\n[CONTRIBUTING](https://github.com/SUSE-Enceladus/mash-client/blob/master/CONTRIBUTING.md)\nfor info on getting started.\n\nLicense\n=======\n\nCopyright (c) 2019 SUSE LLC.\n\nDistributed under the terms of GPL-3.0+ license, see\n[LICENSE](https://github.com/SUSE-Enceladus/mash-client/blob/master/LICENSE)\nfor details.\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "CLI client for interfacing with a MASH server.",
"version": "4.1.0",
"split_keywords": [
"mash-client",
"mash",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "20973d141d046a0135ecfef3d59ecb1c",
"sha256": "062090679d0fbe85ce7218840542533c7675ca1f11e7704833d504d9f52f3b90"
},
"downloads": -1,
"filename": "mash_client-4.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20973d141d046a0135ecfef3d59ecb1c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 50658,
"upload_time": "2022-12-07T19:52:48",
"upload_time_iso_8601": "2022-12-07T19:52:48.423760Z",
"url": "https://files.pythonhosted.org/packages/2e/7d/03d7ddb53ddf7ffef6e02df7b7e09e8aef6a0603ee5e196143c5423e6a7d/mash_client-4.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "cae3935e332b1b608386ffd149a18665",
"sha256": "e2807e986defbc4ac2d9897f354439a977583009707baed624e6d69b828e6233"
},
"downloads": -1,
"filename": "mash-client-4.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cae3935e332b1b608386ffd149a18665",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 36325,
"upload_time": "2022-12-07T19:52:49",
"upload_time_iso_8601": "2022-12-07T19:52:49.815173Z",
"url": "https://files.pythonhosted.org/packages/8c/12/10b09ae6dc9aa32998e99a263262d64e3fa53eec6e35ddbb0aa6551ddcef/mash-client-4.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-07 19:52:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "SUSE-enceladus",
"github_project": "mash-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Click",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "PyYAML",
"specs": []
},
{
"name": "PyJWT",
"specs": []
}
],
"lcname": "mash-client"
}
JSON
