missim-cli

Name	missim-cli JSON
Version	1.11.0 JSON
	download
home_page	https://github.com/Greenroom-Robotics/missim
Summary	A CLI for interacting with the MISSIM platform
upload_time	2024-04-30 02:54:38
maintainer	David Revay
docs_url	None
author	Greenroom Robotics
requires_python	None
license	Copyright (C) 2023, Greenroom Robotics
keywords	colcon
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MISSIM CLI

![MISSIM CLI](./docs/missim_cli.png)

Publicly available on [PyPi](https://pypi.org/project/missim-cli/) for convenience but if you don't work at Greenroom Robotics, you probably don't want to use this.

## Install

* For development:
  * `pip install -e ./packages/missim_config`
  * `pip install -e ./tools/missim_cli`
* For production: `pip install missim-cli`
* You may also need to `export PATH=$PATH:~/.local/bin` if you don't have `~/.local/bin` in your path
* Install autocomplete:
  * bash: `echo 'eval "$(_MISSIM_COMPLETE=bash_source missim)"' >> ~/.bashrc`
  * zsh: `echo 'eval "$(_MISSIM_COMPLETE=zsh_source missim)"' >> ~/.zshrc` (this is much nicer)
  * If using zsh, the git checker plugin make terminal slow. Suggest you run `git config oh-my-zsh.hide-info 1` in the zsh terminal inside the repo

## Usage

* `missim --help` to get help with the CLI

## Dev mode

MISSIM CLI can be ran in dev mode. This will happen if it is installed with `pip install -e ./tools/missim` or if the environment variable `MISSIM_CLI_DEV_MODE` is set to `true`.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Greenroom-Robotics/missim",
    "name": "missim-cli",
    "maintainer": "David Revay",
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "david.revay@greenroomrobotics.com",
    "keywords": "colcon",
    "author": "Greenroom Robotics",
    "author_email": "team@greenroomrobotics.com",
    "download_url": "https://files.pythonhosted.org/packages/f7/d0/47b9927bf4389fe53a6570f7fb9c32647b0ce1abc2091c4dc2d77de25066/missim_cli-1.11.0.tar.gz",
    "platform": null,
    "description": "# MISSIM CLI\n\n![MISSIM CLI](./docs/missim_cli.png)\n\nPublicly available on [PyPi](https://pypi.org/project/missim-cli/) for convenience but if you don't work at Greenroom Robotics, you probably don't want to use this.\n\n## Install\n\n* For development:\n  * `pip install -e ./packages/missim_config`\n  * `pip install -e ./tools/missim_cli`\n* For production: `pip install missim-cli`\n* You may also need to `export PATH=$PATH:~/.local/bin` if you don't have `~/.local/bin` in your path\n* Install autocomplete:\n  * bash: `echo 'eval \"$(_MISSIM_COMPLETE=bash_source missim)\"' >> ~/.bashrc`\n  * zsh: `echo 'eval \"$(_MISSIM_COMPLETE=zsh_source missim)\"' >> ~/.zshrc` (this is much nicer)\n  * If using zsh, the git checker plugin make terminal slow. Suggest you run `git config oh-my-zsh.hide-info 1` in the zsh terminal inside the repo\n\n## Usage\n\n* `missim --help` to get help with the CLI\n\n## Dev mode\n\nMISSIM CLI can be ran in dev mode. This will happen if it is installed with `pip install -e ./tools/missim` or if the environment variable `MISSIM_CLI_DEV_MODE` is set to `true`.\n",
    "bugtrack_url": null,
    "license": "Copyright (C) 2023, Greenroom Robotics",
    "summary": "A CLI for interacting with the MISSIM platform",
    "version": "1.11.0",
    "project_urls": {
        "Homepage": "https://github.com/Greenroom-Robotics/missim"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dce92216020608ea4d17d1c303c41a55d3cc4550307d86b381aa94667a0196e6",
                "md5": "6addb0f2a180ad83a9c66b1d8ca8b167",
                "sha256": "99c6ce265ea2d1bf46f86d72540fdc14b0ec97bbe7cce75156e7ef6842c91193"
            },
            "downloads": -1,
            "filename": "missim_cli-1.11.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6addb0f2a180ad83a9c66b1d8ca8b167",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14545,
            "upload_time": "2024-04-30T02:54:36",
            "upload_time_iso_8601": "2024-04-30T02:54:36.496712Z",
            "url": "https://files.pythonhosted.org/packages/dc/e9/2216020608ea4d17d1c303c41a55d3cc4550307d86b381aa94667a0196e6/missim_cli-1.11.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f7d047b9927bf4389fe53a6570f7fb9c32647b0ce1abc2091c4dc2d77de25066",
                "md5": "a97e63e67849bc3df5e7db2b4fe8e1e6",
                "sha256": "b2a6db9e4154d33a530b00c7255a6f284256eb3e221ab4ab53077261a9f8e4ca"
            },
            "downloads": -1,
            "filename": "missim_cli-1.11.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a97e63e67849bc3df5e7db2b4fe8e1e6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10875,
            "upload_time": "2024-04-30T02:54:38",
            "upload_time_iso_8601": "2024-04-30T02:54:38.413334Z",
            "url": "https://files.pythonhosted.org/packages/f7/d0/47b9927bf4389fe53a6570f7fb9c32647b0ce1abc2091c4dc2d77de25066/missim_cli-1.11.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-30 02:54:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Greenroom-Robotics",
    "github_project": "missim",
    "github_not_found": true,
    "lcname": "missim-cli"
}