| Name | edwh-multipass-plugin JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | An `edwh`plugin to work with multipass instances for local development. |
| upload_time | 2024-04-12 15:52:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| 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
[](https://pypi.org/project/edwh-multipass-plugin)
[](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
pipx inject edwh edwh-multipass-plugin
```
---
## 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/b7/c2/f899e9f2ac2eb56846fb2d448dbb205d500b503854956ddfa60751bfac4b/edwh_multipass_plugin-1.0.2.tar.gz",
"platform": null,
"description": "# edwh-multipass-plugin\n\n[](https://pypi.org/project/edwh-multipass-plugin)\n[](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\npipx inject edwh edwh-multipass-plugin\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.0.2",
"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": "4c5d71e7654ce74ad324e7acae445d8239b5d98245443a7517292a572f4e0fea",
"md5": "6bf7d70f7955d423ae55cfcf90372106",
"sha256": "f7d9b766205330d3a5a5bac47318c835eaa3e14f0d2e6a4fbf9ddd847a9ad14d"
},
"downloads": -1,
"filename": "edwh_multipass_plugin-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bf7d70f7955d423ae55cfcf90372106",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6036,
"upload_time": "2024-04-12T15:52:24",
"upload_time_iso_8601": "2024-04-12T15:52:24.828276Z",
"url": "https://files.pythonhosted.org/packages/4c/5d/71e7654ce74ad324e7acae445d8239b5d98245443a7517292a572f4e0fea/edwh_multipass_plugin-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b7c2f899e9f2ac2eb56846fb2d448dbb205d500b503854956ddfa60751bfac4b",
"md5": "eb7833f37d12deed4dbf0f2391a820f0",
"sha256": "8f1536375c2b4a90c37831212c8585d61df6e5e55e3abf37392a8d4b6639f789"
},
"downloads": -1,
"filename": "edwh_multipass_plugin-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "eb7833f37d12deed4dbf0f2391a820f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5831,
"upload_time": "2024-04-12T15:52:23",
"upload_time_iso_8601": "2024-04-12T15:52:23.573030Z",
"url": "https://files.pythonhosted.org/packages/b7/c2/f899e9f2ac2eb56846fb2d448dbb205d500b503854956ddfa60751bfac4b/edwh_multipass_plugin-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 15:52:23",
"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"
}
