edwh-multipass-plugin


Nameedwh-multipass-plugin JSON
Version 1.2.1 PyPI version JSON
download
home_pageNone
SummaryAn `edwh`plugin to work with multipass instances for local development.
upload_time2024-09-03 14:52:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords edwh invoke multipass plugin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # edwh-multipass-plugin

[![PyPI - Version](https://img.shields.io/pypi/v/edwh-multipass-plugin.svg)](https://pypi.org/project/edwh-multipass-plugin)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/edwh-multipass-plugin.svg)](https://pypi.org/project/edwh-multipass-plugin)

-----

**Table of Contents**

- [Installation](#installation)
- [License](#license)
- [mp.fix-host](#mpfix-host)
- [mp.install](#mpinstall)
- [mp.prepare](#mpprepare)

## Installation

Install just this plugin:

```console
pip install edwh-multipass-plugin
```

But probably you want to install the whole `edwh` package:

```console
pipx install edwh[plugins,omgeving]
# or
pipx install edwh[multipass]
```

if you want to use the `edwh` command line tool with just the `multipass` plugin:

```console
pipx install edwh
edwh plugin.add multipass
```

---

## mp.fix-host
>  aka `mp.fix-dns`

Fixes the ip adres in the hosts file for a multipass instance.

When issuing on the first run fix-host will add an entry to your hosts file, and you can enter 
different hostnames you want to register for the instance.

```
mp.fix-host dockers -h dockers.local -h delen.dockers.local -h web2py.dockers.local ... 
```

After this initial registration, you can update the ip address of the instance by running `mp.fix-host dockers` again.
Be aware that you cannot register new hostnames after the initial registration. Update your 
`/etc/hosts` file instead. 

---
## mp.install 
Installs multipass on an ubuntu based machine if not already installed. 


---
## mp.prepare 
Allows you to ssh into a multipass instance, so you are able to run fabric commands against it. 


`mp.prepare` will generate a multipass_keyfile `~/.ssh/multipass.key` (if not already present) 
and add the public key to the multipass instance's `authorized_keys` file. 

`mp.prepares` automatically runs `mp.install`. 

---
## License

`edwh-multipass-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
See [the license](LICENSE.txt) for details. 

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "edwh-multipass-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "edwh, invoke, multipass, plugin",
    "author": null,
    "author_email": "Remco <remco@educationwarehouse.nl>",
    "download_url": "https://files.pythonhosted.org/packages/eb/f9/2a214825047ea518465f6c27768a86c01bc78ec03933060abe46d33ba6ae/edwh_multipass_plugin-1.2.1.tar.gz",
    "platform": null,
    "description": "# edwh-multipass-plugin\n\n[![PyPI - Version](https://img.shields.io/pypi/v/edwh-multipass-plugin.svg)](https://pypi.org/project/edwh-multipass-plugin)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/edwh-multipass-plugin.svg)](https://pypi.org/project/edwh-multipass-plugin)\n\n-----\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [License](#license)\n- [mp.fix-host](#mpfix-host)\n- [mp.install](#mpinstall)\n- [mp.prepare](#mpprepare)\n\n## Installation\n\nInstall just this plugin:\n\n```console\npip install edwh-multipass-plugin\n```\n\nBut probably you want to install the whole `edwh` package:\n\n```console\npipx install edwh[plugins,omgeving]\n# or\npipx install edwh[multipass]\n```\n\nif you want to use the `edwh` command line tool with just the `multipass` plugin:\n\n```console\npipx install edwh\nedwh plugin.add multipass\n```\n\n---\n\n## mp.fix-host\n>  aka `mp.fix-dns`\n\nFixes the ip adres in the hosts file for a multipass instance.\n\nWhen issuing on the first run fix-host will add an entry to your hosts file, and you can enter \ndifferent hostnames you want to register for the instance.\n\n```\nmp.fix-host dockers -h dockers.local -h delen.dockers.local -h web2py.dockers.local ... \n```\n\nAfter this initial registration, you can update the ip address of the instance by running `mp.fix-host dockers` again.\nBe aware that you cannot register new hostnames after the initial registration. Update your \n`/etc/hosts` file instead. \n\n---\n## mp.install \nInstalls multipass on an ubuntu based machine if not already installed. \n\n\n---\n## mp.prepare \nAllows you to ssh into a multipass instance, so you are able to run fabric commands against it. \n\n\n`mp.prepare` will generate a multipass_keyfile `~/.ssh/multipass.key` (if not already present) \nand add the public key to the multipass instance's `authorized_keys` file. \n\n`mp.prepares` automatically runs `mp.install`. \n\n---\n## License\n\n`edwh-multipass-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\nSee [the license](LICENSE.txt) for details. \n",
    "bugtrack_url": null,
    "license": null,
    "summary": "An `edwh`plugin to work with multipass instances for local development.",
    "version": "1.2.1",
    "project_urls": {
        "Documentation": "https://github.com/educationwarehouse/edwh-multipass-plugin#readme",
        "Issues": "https://github.com/educationwarehouse/edwh-multipass-plugin/issues",
        "Source": "https://github.com/educationwarehouse/edwh-multipass-plugin"
    },
    "split_keywords": [
        "edwh",
        " invoke",
        " multipass",
        " plugin"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c5ba3763a1a81077e85e146dda6d4c471cbc387981aebc4e824f9fc228cfe53b",
                "md5": "b1882e5fed46ac72de36f2d7c73dc02d",
                "sha256": "9ca2010020e6ae2ad0d1e75e6eb8ba852e108a4c77786b97f8477b1acc535c84"
            },
            "downloads": -1,
            "filename": "edwh_multipass_plugin-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b1882e5fed46ac72de36f2d7c73dc02d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 7681,
            "upload_time": "2024-09-03T14:52:41",
            "upload_time_iso_8601": "2024-09-03T14:52:41.406652Z",
            "url": "https://files.pythonhosted.org/packages/c5/ba/3763a1a81077e85e146dda6d4c471cbc387981aebc4e824f9fc228cfe53b/edwh_multipass_plugin-1.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ebf92a214825047ea518465f6c27768a86c01bc78ec03933060abe46d33ba6ae",
                "md5": "edba0854dd7fb5d11c9eeb837e4ae92b",
                "sha256": "107da81fea4a1f32d2b2210c79a148663a3b4815b2ad461c8c63237f9503fb84"
            },
            "downloads": -1,
            "filename": "edwh_multipass_plugin-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "edba0854dd7fb5d11c9eeb837e4ae92b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 8586,
            "upload_time": "2024-09-03T14:52:42",
            "upload_time_iso_8601": "2024-09-03T14:52:42.882031Z",
            "url": "https://files.pythonhosted.org/packages/eb/f9/2a214825047ea518465f6c27768a86c01bc78ec03933060abe46d33ba6ae/edwh_multipass_plugin-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-03 14:52:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "educationwarehouse",
    "github_project": "edwh-multipass-plugin#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "edwh-multipass-plugin"
}
        
Elapsed time: 2.00671s