{
    "info": {
        "author": "Matt Wiens",
        "author_email": "mwiens91@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "License :: OSI Approved :: MIT License",
            "Natural Language :: English",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "[![Build Status](https://travis-ci.com/saltant-org/saltant-cli.svg?branch=master)](https://travis-ci.com/saltant-org/saltant-cli)\n[![codecov](https://codecov.io/gh/saltant-org/saltant-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/saltant-org/saltant-cli)\n[![PyPI](https://img.shields.io/pypi/v/saltant-cli.svg)](https://pypi.org/project/saltant-cli/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/saltant-cli.svg)](https://pypi.org/project/saltant-cli/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n\n# saltant CLI\n\nsaltant-cli is a CLI for\n[saltant](https://github.com/saltant-org/saltant) written on top of\n[saltant-py](https://github.com/saltant-org/saltant-py).  It lets you\ninterface with a saltant API conveniently from a terminal.\n\n## Installation\n\nUsing pip,\n\n```\npip install saltant-cli\n```\n\nor, from source, after cloning this repository, run\n\n```\npython setup.py install\n```\n\nwhere `python` is in versions 2.7 or 3.5+.\n\nHowever you chose to install saltant-cli, make sure that the binary\nresulting from the above commands are somewhere on your `$PATH`. On some\nsystems, this may involve running the above commands as root.\n\n### Running from source\n\nAlternatively, instead of installing saltant-cli you can run it directly\nfrom source using the script [`run_saltant_cli.py`](run_saltant_cli.py).\n\n### Setting up a configuration file\n\nIn order to run saltant-cli, it needs to know where your saltant server\nis and how to authenticate your user. To get this information,\nsaltant-cli looks for a config file located at\n`$XDG_CONFIG_HOME/saltant-cli/config.yaml`; if `$XDG_CONFIG_HOME` isn't\ndefined, `$HOME/.config` is used instead. Alternatively, you can use a\n`config.yaml` file at the root of the project's repository, which is\nuseful when running from source.\n\nThe easiest way to set up a config file is to run\n\n```\nsaltant-cli --setup\n```\n\nwhich interactively constructs and writes a config file to\n`$XDG_CONFIG_HOME/saltant-cli/config.yaml`.\n\nAlternatively, you can copy the example config file,\n[`config.yaml.example`](config.yaml.example), to where it needs to go,\nand fill in the file with your favourite text editor:\n\n```\nmkdir -p $XDG_CONFIG_HOME/saltant-cli\ncp config.yaml.example $XDG_CONFIG_HOME/saltant-cli/config.yaml\n```\n\nThere may be times where it is advantageous to juggle multiple config\nfiles; to do so, you can specify the `--config-path` option, like so:\n\n```\nsaltant-cli --config-path /path/to/config.yaml mycommandhere\n```\n\n### Shell command completion\n\nAssuming you installed normally, i.e., you aren't running from source,\nsaltant-cli supports command completion for\n[Bash](https://www.gnu.org/software/bash/), [Zsh](https://www.zsh.org/),\n[fish](https://fishshell.com/), and\n[PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/powershell-scripting?view=powershell-6).\n\nTo install any of these, run\n\n```\nsaltant-cli completion install my-shell-type\n```\n\nwhere `my-shell-type` is either `bash`, `zsh`, `fish`, or `powershell`\n(or blank if you want to use the current shell type).\n\n## Usage\n\nHere you're going to find `--help` your best friend. Run this at any\nstage of the command tree to learn more about what to do!\n\n### Commmand tree\n\nHere's a sketch of what you can do. Again, supply `--help` at any point\nto figure out how to use a given command.\n\n```\nsaltant-cli\n\u251c\u2500\u2500 completion\n\u2502   \u2514\u2500\u2500 install\n\u251c\u2500\u2500 container-task-instances\n\u2502   \u251c\u2500\u2500 clone\n\u2502   \u251c\u2500\u2500 create\n\u2502   \u251c\u2500\u2500 get\n\u2502   \u251c\u2500\u2500 list\n\u2502   \u251c\u2500\u2500 terminate\n\u2502   \u2514\u2500\u2500 wait\n\u251c\u2500\u2500 container-task-types\n\u2502   \u251c\u2500\u2500 create\n\u2502   \u251c\u2500\u2500 get\n\u2502   \u251c\u2500\u2500 list\n\u2502   \u2514\u2500\u2500 put\n\u251c\u2500\u2500 executable-task-instances\n\u2502   \u251c\u2500\u2500 clone\n\u2502   \u251c\u2500\u2500 create\n\u2502   \u251c\u2500\u2500 get\n\u2502   \u251c\u2500\u2500 list\n\u2502   \u251c\u2500\u2500 terminate\n\u2502   \u2514\u2500\u2500 wait\n\u251c\u2500\u2500 executable-task-types\n\u2502   \u251c\u2500\u2500 create\n\u2502   \u251c\u2500\u2500 get\n\u2502   \u251c\u2500\u2500 list\n\u2502   \u2514\u2500\u2500 put\n\u251c\u2500\u2500 task-queues\n\u2502   \u251c\u2500\u2500 create\n\u2502   \u251c\u2500\u2500 get\n\u2502   \u251c\u2500\u2500 list\n\u2502   \u2514\u2500\u2500 put\n\u251c\u2500\u2500 task-whitelists\n\u2502   \u251c\u2500\u2500 create\n\u2502   \u251c\u2500\u2500 get\n\u2502   \u251c\u2500\u2500 list\n\u2502   \u2514\u2500\u2500 put\n\u2514\u2500\u2500 users\n    \u251c\u2500\u2500 get\n    \u2514\u2500\u2500 list\n```\n\n### Examples\n\nLet's go through a few examples. First, let's list some container task\ntypes using some API filters:\n\n```\nsaltant-cli container-task-types list --filters '{\"user_username_in\": [\"matt\", \"daniel\"]}'\n```\n\nGreat! This will show us the container task types created by Matt and\nDaniel! Secondly, let's create a task queue:\n\n```\nsaltant-cli task-queues create --name \"amazing-task-queue\" --description \"Seriously best task queue ever.\"\n```\n\nIf we got confused about how to use this command, all we need to do is\ndrop in `--help`. Thirdly: let's do just that:\n\n```\nsaltant-cli task-queues create --help\n```\n\nwhich will give us\n\n```\n$ saltant-cli task-queues create --help\nUsage: saltant-cli task-queues create [OPTIONS]\n\n  Create a task queue.\n\nOptions:\n  --name TEXT         The name of the task queue.  [required]\n  --description TEXT  A description of the task queue.\n  --private BOOLEAN   Whether the task queue is exclusive to the creator.\n                      [default: False]\n  --active BOOLEAN    Whether the task queue is active.  [default: True]\n  --help              Show this message and exit.\n```\n\n## See also\n\n[saltant-py](https://github.com/saltant-org/saltant-py/), a saltant SDK\nfor Python.",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/saltant-org/saltant-cli",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "saltant-cli",
        "package_url": "https://pypi.org/project/saltant-cli/",
        "platform": "",
        "project_url": "https://pypi.org/project/saltant-cli/",
        "project_urls": {
            "Homepage": "https://github.com/saltant-org/saltant-cli"
        },
        "release_url": "https://pypi.org/project/saltant-cli/0.3.1/",
        "requires_dist": null,
        "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
        "summary": "saltant CLI",
        "version": "0.3.1"
    },
    "last_serial": 4897711,
    "releases": {
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ab928c4347cd097278b1b3f26f5b18dd",
                    "sha256": "657b8768df22000501484db44c1ba743e516bd65048735c0a778653d76e87a35"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "ab928c4347cd097278b1b3f26f5b18dd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 8409,
                "upload_time": "2018-10-08T23:05:36",
                "url": "https://files.pythonhosted.org/packages/3c/16/c156f6c7d8e6d1fdd68654a1f072eb149f5cb674dda1a50af7f5130b09f9/saltant-cli-0.0.4.tar.gz"
            }
        ],
        "0.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d92c43c144007256c0ca7e1e57f46bb9",
                    "sha256": "f6599f68b07e7d6dfa565d81333aaba985428eed2830daac361ca99da14dd499"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "d92c43c144007256c0ca7e1e57f46bb9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 8775,
                "upload_time": "2018-10-08T23:58:25",
                "url": "https://files.pythonhosted.org/packages/18/a0/618daf9e091ecc795c415c014d8fd5e6df525573ef33630554d391f19626/saltant-cli-0.0.5.tar.gz"
            }
        ],
        "0.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "315985ab8868e0da4f8d7691af9728ab",
                    "sha256": "a1f7fd682157b554f131185d93643888d63214dbfc711546928a558b90f81d89"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "315985ab8868e0da4f8d7691af9728ab",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 8791,
                "upload_time": "2018-10-09T00:17:03",
                "url": "https://files.pythonhosted.org/packages/a0/55/747f2486b59481144461a554021cba371c7ce4917f2d4970a7c0bdadedb1/saltant-cli-0.0.6.tar.gz"
            }
        ],
        "0.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a66aec165c009f973317586bd3bfef3a",
                    "sha256": "83b8e7112dee50515684c03706ec09671971c592b571ccd8e850dfd8867137db"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.0.7.tar.gz",
                "has_sig": false,
                "md5_digest": "a66aec165c009f973317586bd3bfef3a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 8816,
                "upload_time": "2018-10-09T00:20:03",
                "url": "https://files.pythonhosted.org/packages/8d/f1/73e96d7c37c9d89b62ff0ca9046147d84bc1cf69daf0aad08d4fb6884b03/saltant-cli-0.0.7.tar.gz"
            }
        ],
        "0.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ec4b90f46ef2a18daf10bb19b9420cc3",
                    "sha256": "38adfbc99e59c83c9b29089e22044dbbcb64eb0b4aacf09ffffa91287e0bce1a"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "ec4b90f46ef2a18daf10bb19b9420cc3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 9129,
                "upload_time": "2018-10-09T03:09:32",
                "url": "https://files.pythonhosted.org/packages/cb/61/61523d26fafe596dedb7ffb9cfe43a66a27d6fed073c647caa4a141ec0d9/saltant-cli-0.0.8.tar.gz"
            }
        ],
        "0.0.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4aa47bbafef6e2f61ec134c8188e5cef",
                    "sha256": "449a725ea27247ee52b65277bb604204d92e7bf96203de79aeeaa60acdf3f8d3"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.0.9.tar.gz",
                "has_sig": false,
                "md5_digest": "4aa47bbafef6e2f61ec134c8188e5cef",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 10088,
                "upload_time": "2018-10-09T22:30:57",
                "url": "https://files.pythonhosted.org/packages/1f/73/3bb86c7e67fe8d3d984ab11fba9e353ecd9fd942cf75dfca65c9bb53b5ab/saltant-cli-0.0.9.tar.gz"
            }
        ],
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "02a58192d53d37c0b0f3ce2f9dfe4c0e",
                    "sha256": "577865f7c52ae355ad8b70122e4a3ce916581ebbb5c5680f5c389d704d42d497"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "02a58192d53d37c0b0f3ce2f9dfe4c0e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 10332,
                "upload_time": "2018-10-10T18:00:06",
                "url": "https://files.pythonhosted.org/packages/bb/dd/016c3dbf0ff4497a538fdcee6635fba34eed649bc93af1568702bf404ecc/saltant-cli-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "dca257b27735f31c5f0cdb6ea6bc1a63",
                    "sha256": "6c5e43491e6198420ecea97bac918e96c868a5b80e876fd20bd8aa1f4e08d192"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "dca257b27735f31c5f0cdb6ea6bc1a63",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 10370,
                "upload_time": "2018-10-22T19:29:38",
                "url": "https://files.pythonhosted.org/packages/f2/0a/a5bd3ec11fcd4b5b73f821585cb86be267bb208edf65cb8660a6f2eb9765/saltant-cli-0.1.1.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "14c8a3d82529454d152478f70f170f17",
                    "sha256": "660cf7102cfa5eba217367014c14c11cbd9c3df042717c6e439c11f762d512b0"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "14c8a3d82529454d152478f70f170f17",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 10470,
                "upload_time": "2018-12-12T19:55:37",
                "url": "https://files.pythonhosted.org/packages/f8/21/dd64d8b1e647cd5749a2d7e3f6c300ce4a5aa945ba97ac1e3e788b57157a/saltant-cli-0.2.0.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f0245624053ac622cc45c5bc3bd2b550",
                    "sha256": "8d495ac21322177f83987ad9dd1833e00f6c8cecc9bafe2365faa51229d1bf45"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f0245624053ac622cc45c5bc3bd2b550",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 10466,
                "upload_time": "2018-12-12T20:00:37",
                "url": "https://files.pythonhosted.org/packages/6a/7c/0b6032fd6137859a5013b809826240081ef073fc556488c8a515ce535dab/saltant-cli-0.2.1.tar.gz"
            }
        ],
        "0.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a7d0eb0c71ba7183af3e9dbb90d7172d",
                    "sha256": "6d6f8f290de7bde998749677eb9fa1a6e17cd051a9d5b7281288f1016faf80e9"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.2.2.tar.gz",
                "has_sig": false,
                "md5_digest": "a7d0eb0c71ba7183af3e9dbb90d7172d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 10561,
                "upload_time": "2018-12-12T20:23:35",
                "url": "https://files.pythonhosted.org/packages/4e/98/57d4cfa09e067706d7ceb0ad2a1ae88a93fc4ae7b2b85f7c473a565efbe5/saltant-cli-0.2.2.tar.gz"
            }
        ],
        "0.2.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0cf180bad0b1225e361135fad0fec541",
                    "sha256": "35e154f77961a2c5753628553899eec1d8c3cfd8bc1c18342bcb0d72d4d80bff"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.2.3.tar.gz",
                "has_sig": false,
                "md5_digest": "0cf180bad0b1225e361135fad0fec541",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 10767,
                "upload_time": "2018-12-19T00:34:43",
                "url": "https://files.pythonhosted.org/packages/c1/cb/0159354194da396e1f98e99d5a69f2a8334a4af373b2bbe29b6406436bbb/saltant-cli-0.2.3.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b73216fd38f4308f22618e781df189db",
                    "sha256": "8ce7c2acb47392ce878cddea9e96f3e9d2cd30b9ae5384335514caeb15976031"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "b73216fd38f4308f22618e781df189db",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 11050,
                "upload_time": "2018-12-19T00:54:14",
                "url": "https://files.pythonhosted.org/packages/8f/e6/fe47355b1c9d4a8788d1f6abd2945c4fbafab747c31758f92408c79e6636/saltant-cli-0.3.0.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bf6c568b14a54faad20d2cc912a6fe90",
                    "sha256": "bb89298239d12f3f99f98eaba210ca874454cbd4084a5578545b9783f78c6ea0"
                },
                "downloads": -1,
                "filename": "saltant-cli-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "bf6c568b14a54faad20d2cc912a6fe90",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 11079,
                "upload_time": "2019-03-05T06:42:11",
                "url": "https://files.pythonhosted.org/packages/8a/a8/4194b8ff458849865e4ee8ca6ae7301ef9958ad80a6275a95bf7a6a784e9/saltant-cli-0.3.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "bf6c568b14a54faad20d2cc912a6fe90",
                "sha256": "bb89298239d12f3f99f98eaba210ca874454cbd4084a5578545b9783f78c6ea0"
            },
            "downloads": -1,
            "filename": "saltant-cli-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "bf6c568b14a54faad20d2cc912a6fe90",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
            "size": 11079,
            "upload_time": "2019-03-05T06:42:11",
            "url": "https://files.pythonhosted.org/packages/8a/a8/4194b8ff458849865e4ee8ca6ae7301ef9958ad80a6275a95bf7a6a784e9/saltant-cli-0.3.1.tar.gz"
        }
    ]
}