konfigmapedit


Namekonfigmapedit JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryEdit multi-file Kubernetes configmaps by downloading them into a folder, let you edit in an interactive shell and uploads them after.
upload_time2023-07-31 13:41:13
maintainer
docs_urlNone
author
requires_python>=3.6
licenseMIT License Copyright (c) 2023 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords kubernetes configmap edit editor interactive
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Konfigmapedit

Edit multi-file Kubernetes configmaps by downloading them into a folder, let you edit in a shell and uploads them.

## Installation

You can install the Konfigmapedit from PyPi:

```
pip install konfigmapedit
```

The konfigmapedit is supported on Python 3.6 and above on Linux/MacOS.

## How to use

```
# This creates a temp dir on a local machine and downloads a kubernetes configmap into it and invokes a shell in the temp dir.
# The -n flag is the namespace and the configmap1 is the name of the configmap.
$ konfigmapedit -n app1 configmap1
configmap/configmap1 in namespace app1:
You are now in an interactive shell. Edit the configmap files and exit the shell to upload the changes.
$ konfigmapedit-g6r00xk9
# here you can use shell commands, like ls, vim, nano, etc. or just open it in any editor.
# after you finished the editing you can exit the shell (ctrl+D or exit command) and the konfigmapedit will display the changes and if you accept them it will upload the changes.
```

## k9s plugin

You can use it as a k9s plugin too, where Ctrl-F on configmaps will invoke this tool.

Install instructions: https://k9scli.io/topics/plugins/

```yaml
plugin:
  editConfigMap:
    shortCut: Ctrl-F
    description: Edit as files
    scopes:
    - cm
    command: konfigmapedit
    background: false
    args:
    - '-n'
    - $NAMESPACE
    - $NAME
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "konfigmapedit",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "kubernetes,configmap,edit,editor,interactive",
    "author": "",
    "author_email": "Armin Zentai <armin@zentai.name>",
    "download_url": "https://files.pythonhosted.org/packages/e6/d5/725e5a3bea6e36055dc569185cf86b226028228e4db9452761877884b5d9/konfigmapedit-0.1.0.tar.gz",
    "platform": null,
    "description": "# Konfigmapedit\n\nEdit multi-file Kubernetes configmaps by downloading them into a folder, let you edit in a shell and uploads them.\n\n## Installation\n\nYou can install the Konfigmapedit from PyPi:\n\n```\npip install konfigmapedit\n```\n\nThe konfigmapedit is supported on Python 3.6 and above on Linux/MacOS.\n\n## How to use\n\n```\n# This creates a temp dir on a local machine and downloads a kubernetes configmap into it and invokes a shell in the temp dir.\n# The -n flag is the namespace and the configmap1 is the name of the configmap.\n$ konfigmapedit -n app1 configmap1\nconfigmap/configmap1 in namespace app1:\nYou are now in an interactive shell. Edit the configmap files and exit the shell to upload the changes.\n$ konfigmapedit-g6r00xk9\n# here you can use shell commands, like ls, vim, nano, etc. or just open it in any editor.\n# after you finished the editing you can exit the shell (ctrl+D or exit command) and the konfigmapedit will display the changes and if you accept them it will upload the changes.\n```\n\n## k9s plugin\n\nYou can use it as a k9s plugin too, where Ctrl-F on configmaps will invoke this tool.\n\nInstall instructions: https://k9scli.io/topics/plugins/\n\n```yaml\nplugin:\n  editConfigMap:\n    shortCut: Ctrl-F\n    description: Edit as files\n    scopes:\n    - cm\n    command: konfigmapedit\n    background: false\n    args:\n    - '-n'\n    - $NAMESPACE\n    - $NAME\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Edit multi-file Kubernetes configmaps by downloading them into a folder, let you edit in an interactive shell and uploads them after.",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "kubernetes",
        "configmap",
        "edit",
        "editor",
        "interactive"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6b4a37d6cbd97d5f1f0fadee8981d67dd66da31df542dddb97e7fd715cf6eb2c",
                "md5": "fc35beb30c067cb36d14f5001e5aad22",
                "sha256": "60572dfcec910bc8923c4b1a01ae3af01ea9aa1fc5522c832175abea62514dc2"
            },
            "downloads": -1,
            "filename": "konfigmapedit-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fc35beb30c067cb36d14f5001e5aad22",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 5904,
            "upload_time": "2023-07-31T13:41:11",
            "upload_time_iso_8601": "2023-07-31T13:41:11.938246Z",
            "url": "https://files.pythonhosted.org/packages/6b/4a/37d6cbd97d5f1f0fadee8981d67dd66da31df542dddb97e7fd715cf6eb2c/konfigmapedit-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6d5725e5a3bea6e36055dc569185cf86b226028228e4db9452761877884b5d9",
                "md5": "ea1acea022ac5dcbac5335ba8384cd69",
                "sha256": "09b8ab055358069ab0a7aa346804899ca33ffdf39251dbb9aae809da05b03bf5"
            },
            "downloads": -1,
            "filename": "konfigmapedit-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ea1acea022ac5dcbac5335ba8384cd69",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4627,
            "upload_time": "2023-07-31T13:41:13",
            "upload_time_iso_8601": "2023-07-31T13:41:13.658770Z",
            "url": "https://files.pythonhosted.org/packages/e6/d5/725e5a3bea6e36055dc569185cf86b226028228e4db9452761877884b5d9/konfigmapedit-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-31 13:41:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "konfigmapedit"
}
        
Elapsed time: 0.10299s