# ☸️ powerk8s: Powerline Plugin for Kubernetes ☸️
[![Actions Test Workflow Widget](https://github.com/gkze/powerk8s/workflows/CI/badge.svg)](https://github.com/gkze/powerk8s/actions?query=workflow%3Aci)
[![PyPI Version](https://img.shields.io/pypi/v/powerk8s)](https://pypi.org/project/powerk8s/)
[![Pdoc Documentation](https://img.shields.io/badge/pdoc-docs-green)](https://gkze.github.io/powerk8s/powerk8s.html)
This simple plugin is designed to show the Kubernetes cluster configured
for the current context in `$KUBECONFIG`.
This work is inspired by [so0k/powerline-kubernetes](https://github.com/so0k/powerline-kubernetes),
and intends to be a drop-in **replacement** as well as an improvement upon the original work.
## Installation
```bash
$ pip3 install powerk8s
```
## Configuration
Just like with [so0k/powerline-kubernetes](https://github.com/so0k/powerline-kubernetes), you'll need a few things to get going:
* **Colorschemes**
`~/.config/powerline/colorschemes/default.json`:
```json
{
"groups": {
"kubernetes_cluster": { "fg": "gray10", "bg": "darkestblue", "attrs": [] },
"kubernetes_cluster:alert": { "fg": "gray10", "bg": "darkestred", "attrs": [] },
"kubernetes_namespace": { "fg": "gray10", "bg": "darkestblue", "attrs": [] },
"kubernetes_namespace:alert": { "fg": "gray10", "bg": "darkred", "attrs": [] },
"kubernetes:divider": { "fg": "gray4", "bg": "darkestblue", "attrs": [] },
}
}
```
* **`powerk8s` invocation (& arguments)**
Here is a good starting point.
`~/.config/powerline/themes/shell/default.json`:
```json
{
"function": "powerline_kubernetes.kubernetes",
"priority": 30,
"args": {
"show_kube_logo": true,
"show_cluster": true,
"show_namespace": true,
"show_default_namespace": false,
"alerts": [
"live",
"cluster:live"
]
}
}
```
This will add the segment to the shell.
Alternatively, placing this in `~/.config/powerline/colorschemes/default.json`
will make it show up in the Tmux status line.
## Authors
[@gkze](https://github.com/gkze)
## License
[MIT](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/gkze/powerk8s",
"name": "powerk8s",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "kubernetes,powerline,tools",
"author": "George Kontridze",
"author_email": "george.kontridze@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b6/06/9d0046a263bfdfafcf9966a1db746b238563131f871524f4812a03b4d175/powerk8s-0.8.0.tar.gz",
"platform": null,
"description": "# \u2638\ufe0f powerk8s: Powerline Plugin for Kubernetes \u2638\ufe0f\n\n[![Actions Test Workflow Widget](https://github.com/gkze/powerk8s/workflows/CI/badge.svg)](https://github.com/gkze/powerk8s/actions?query=workflow%3Aci)\n[![PyPI Version](https://img.shields.io/pypi/v/powerk8s)](https://pypi.org/project/powerk8s/)\n[![Pdoc Documentation](https://img.shields.io/badge/pdoc-docs-green)](https://gkze.github.io/powerk8s/powerk8s.html)\n\nThis simple plugin is designed to show the Kubernetes cluster configured\nfor the current context in `$KUBECONFIG`.\n\nThis work is inspired by [so0k/powerline-kubernetes](https://github.com/so0k/powerline-kubernetes),\nand intends to be a drop-in **replacement** as well as an improvement upon the original work.\n\n## Installation\n\n```bash\n$ pip3 install powerk8s\n```\n\n## Configuration\n\nJust like with [so0k/powerline-kubernetes](https://github.com/so0k/powerline-kubernetes), you'll need a few things to get going:\n\n* **Colorschemes**\n\n `~/.config/powerline/colorschemes/default.json`:\n\n ```json\n {\n \"groups\": {\n \"kubernetes_cluster\": { \"fg\": \"gray10\", \"bg\": \"darkestblue\", \"attrs\": [] },\n \"kubernetes_cluster:alert\": { \"fg\": \"gray10\", \"bg\": \"darkestred\", \"attrs\": [] },\n \"kubernetes_namespace\": { \"fg\": \"gray10\", \"bg\": \"darkestblue\", \"attrs\": [] },\n \"kubernetes_namespace:alert\": { \"fg\": \"gray10\", \"bg\": \"darkred\", \"attrs\": [] },\n \"kubernetes:divider\": { \"fg\": \"gray4\", \"bg\": \"darkestblue\", \"attrs\": [] },\n }\n }\n ```\n\n* **`powerk8s` invocation (& arguments)**\n\n Here is a good starting point.\n `~/.config/powerline/themes/shell/default.json`:\n\n ```json\n {\n \"function\": \"powerline_kubernetes.kubernetes\",\n \"priority\": 30,\n \"args\": {\n \"show_kube_logo\": true,\n \"show_cluster\": true,\n \"show_namespace\": true,\n \"show_default_namespace\": false,\n \"alerts\": [\n \"live\",\n \"cluster:live\"\n ]\n }\n }\n ```\n\n This will add the segment to the shell.\n Alternatively, placing this in `~/.config/powerline/colorschemes/default.json`\n will make it show up in the Tmux status line.\n\n## Authors\n\n[@gkze](https://github.com/gkze)\n\n## License\n\n[MIT](LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Powerline Segment for Kubernetes",
"version": "0.8.0",
"split_keywords": [
"kubernetes",
"powerline",
"tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a1b041c99c4ca3dfb409dbf2403a099a26a0fb7e57b7612848a81248225e4c7",
"md5": "dc458c8b7dc80eb8fe755b060eda1361",
"sha256": "c104dfcaf1ad766f847915153de597b6c639d26d231dd047a5d4d30bd1015431"
},
"downloads": -1,
"filename": "powerk8s-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc458c8b7dc80eb8fe755b060eda1361",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3965,
"upload_time": "2023-04-13T19:30:05",
"upload_time_iso_8601": "2023-04-13T19:30:05.438636Z",
"url": "https://files.pythonhosted.org/packages/4a/1b/041c99c4ca3dfb409dbf2403a099a26a0fb7e57b7612848a81248225e4c7/powerk8s-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6069d0046a263bfdfafcf9966a1db746b238563131f871524f4812a03b4d175",
"md5": "126b4ef0f0c810476902034e918efaf1",
"sha256": "8811e063c60828944e19f9da0cb7d2e6ef50c583206d2f4287077af9f36093de"
},
"downloads": -1,
"filename": "powerk8s-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "126b4ef0f0c810476902034e918efaf1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3524,
"upload_time": "2023-04-13T19:30:06",
"upload_time_iso_8601": "2023-04-13T19:30:06.833552Z",
"url": "https://files.pythonhosted.org/packages/b6/06/9d0046a263bfdfafcf9966a1db746b238563131f871524f4812a03b4d175/powerk8s-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-13 19:30:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "gkze",
"github_project": "powerk8s",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "powerk8s"
}