klotse 0.1.0__tar.gz

klotse-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

klotse-0.1.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: klotse
+Version: 0.1.0
+Summary: A native Kubernetes desktop manager built with Python and Qt
+Author: Marcelo H. Bartsch
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/mbartsch/klotse
+Project-URL: Repository, https://github.com/mbartsch/klotse
+Project-URL: Issues, https://github.com/mbartsch/klotse/issues
+Project-URL: Releases, https://github.com/mbartsch/klotse/releases
+Keywords: kubernetes,k8s,kubectl,desktop,gui,qt,pyside6,cluster
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PySide6-Essentials>=6.6
+Requires-Dist: kubernetes>=29
+Requires-Dist: PyYAML>=6
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-qt; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/mbartsch/klotse/master/src/klotse/assets/klotse_logo.png" alt="Klotse logo" width="200">
+</p>
+
+# Klotse
+
+A native Kubernetes desktop manager for Windows, macOS and Linux. Browse clusters, workloads, nodes and custom
+resources; read logs; open shells; scale, cordon and drain, all from one window.
+
+Built with Python, PySide6 (Qt Widgets) and the official Kubernetes Python client. It uses your existing
+kubeconfig and authentication helpers, so there is nothing to sign in to and no server component.
+
+> **Status:** early (version 0.1.0). Read-only use against real clusters has been tried; most of the
+> mutating actions (cordon, drain, delete, scale) are covered by automated tests with fake services, not yet by
+> live-cluster runs. Try them on a non-production cluster first.
+
+## Features
+
+- **Multiple clusters.** Every context in your kubeconfig is listed on the left; each open cluster gets its own
+  tab and its own connection.
+- **Resources.** Overview, Workloads, Nodes, Namespaces, Pods, Deployments, ReplicaSets, StatefulSets, DaemonSets,
+  Jobs, CronJobs, ConfigMaps, Secrets, Services, Ingresses, NetworkPolicies, PVCs, PVs, StorageClasses, Events,
+  CustomResourceDefinitions, and read-only browsing of custom resource instances.
+- **Always fresh.** The visible tab refreshes every 10 s (5/10/30/60 s selectable) and immediately when the
+  cluster reports a change. Hidden tabs and clusters are not polled.
+- **Details.** YAML view for any resource, with Secret values masked until you pick the keys to decode.
+  `managedFields` are hidden by default (View → Show managedFields in details).
+- **Pods and containers.** Logs (streaming, search, follow), Shell, Attach, terminate and force terminate.
+  Double-click a pod for its own tab with every regular, init and ephemeral container.
+- **Nodes.** Cordon/uncordon, drain (with the usual kubectl options), a privileged nsenter shell, delete. Double-click
+  a node for its pods, with the node actions in a bar above them. Pod counts per node.
+- **Bulk actions.** Select several rows (Ctrl/Shift) to scale, terminate, cordon or delete them in one confirmed
+  step. Scale accepts a number or a relative change such as `*2`, `/2`, `+1`, `-1`.
+- **Usage.** CPU and memory in use (from metrics-server, when present) on Nodes and Pods, plus optional request,
+  limit and percent-of-request/limit columns on Pods.
+- **Your columns.** The **Columns…** button on every list lets you hide and reorder built-in columns and add label
+  columns with short headings. Saved per resource kind.
+- **Edit menu and Preferences.** Undo/redo/cut/copy/paste/select all (Copy in a table copies the selected rows as
+  tab-separated text). Preferences lets you choose a custom kubeconfig and open the settings folder.
+- **macOS.** Choose Terminal or iTerm2 for shells (Settings → Terminal…).
+
+## Requirements
+
+- Python 3.10 or newer
+- A kubeconfig with at least one context (or pick one in Edit → Preferences)
+- [`kubectl`](https://kubernetes.io/docs/tasks/tools/) on your `PATH`, for drain, shells and attach
+- Python dependencies (installed by the launchers): `PySide6-Essentials`, `kubernetes`, `PyYAML`
+
+## Install
+
+Native packages are built for Windows (an installer and a portable `.zip`) and macOS (a `.dmg` for Apple Silicon and
+one for Intel). None has been published yet; once they are, they will be on the project's
+[Releases](https://github.com/mbartsch/klotse/releases) page. Until then, run Klotse from source (below) or build the
+packages yourself (see [Development](#development)).
+
+- The Windows installer has been tested (install, run, uninstall). The macOS apps are built and self-tested in CI but
+  have not been run on a real Mac yet.
+- The packages are not signed yet, so expect a warning on first start: on Windows choose **More info → Run anyway**,
+  on macOS right-click the app and choose **Open**.
+- `kubectl` is not included and has to be installed separately.
+
+### Linux, or anywhere with Python 3.10+: pipx
+
+There is no native Linux package yet. Install with [pipx](https://pipx.pypa.io), which keeps Klotse and its
+dependencies in their own environment and puts a `klotse` command on your `PATH`:
+
+```sh
+pipx install git+https://github.com/mbartsch/klotse   # straight from GitHub (works today)
+pipx install klotse                                   # from PyPI, once the first release is published
+klotse --install-desktop-entry                        # optional, Linux: add Klotse to the application menu
+```
+
+`klotse --uninstall-desktop-entry` removes the menu entry again. On a minimal Debian/Ubuntu install Qt may also need
+these libraries for its X11 support (the project's CI installs exactly this list on Ubuntu and starts Klotse under
+X11); most desktops already have them:
+
+```sh
+sudo apt install libegl1 libxkbcommon-x11-0 libxcb-cursor0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 \
+  libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xinerama0 libxcb-xkb1
+```
+
+On other distributions install the equivalent packages. If Klotse stops with "could not load the Qt platform plugin
+xcb", run `QT_DEBUG_PLUGINS=1 klotse` to see which library is missing.
+
+## Run
+
+macOS / Linux:
+
+```sh
+./run.sh              # creates .venv and installs dependencies on first run
+./run.sh --check      # check that the imports work, without opening the window
+./run.sh --install    # reinstall dependencies
+```
+
+Windows:
+
+```bat
+run.bat               # starts without a console window
+run.bat --console     # keeps tracebacks visible
+run.bat --check
+run.bat --install
+```
+
+Or, in an existing environment:
+
+```sh
+pip install -r requirements.txt
+PYTHONPATH=src python -m klotse
+```
+
+## Configuration
+
+Settings are stored as a plain INI file, one section per resource kind and one entry per line:
+
+```ini
+[columns.Pod]
+order.0=name
+order.1=namespace
+order.2=ready
+hidden.0=cpu_req
+hidden.1=cpu_lim
+labels.0=app.kubernetes.io/name
+labels_name.0=App
+labels.1=example.com/team
+```
+
+`order` is the order of the built-in columns, `hidden` lists the ones that are hidden, and `labels` the label
+columns; `labels_name.N` gives `labels.N` a short heading. A key that is missing means the default; an empty key
+(`hidden=`) means none. You can edit the file by hand while Klotse is closed.
+
+Open its folder from **Edit → Preferences… → Open config folder**. The same file holds the custom kubeconfig path
+and the macOS terminal choice. A custom kubeconfig is passed both to the Kubernetes client and, as `--kubeconfig`,
+to every `kubectl` command Klotse starts.
+
+Settings from the earlier name of the project (Kubeman) are copied over on the first start.
+
+## Development
+
+```sh
+pip install -r requirements-dev.txt
+PYTHONPATH=src QT_QPA_PLATFORM=offscreen python -m pytest -q
+```
+
+Tests run offscreen with fake services and synthetic Kubernetes objects; they never touch a real cluster or your
+real settings. `run_tests.sh` / `run_tests.bat` wrap the same command.
+
+After all tests pass the pytest process can still exit non-zero (a crash during Qt teardown in some test orders).
+This is a known, unresolved issue that predates recent work, so check the pass count and the exit status separately.
+
+To build the native packages (details, signing and releases in [`packaging/README.md`](https://github.com/mbartsch/klotse/blob/master/packaging/README.md)):
+
+```sh
+powershell -ExecutionPolicy Bypass -File packaging\windows\build.ps1   # Windows: zip, plus installer if Inno Setup is installed
+packaging/macos/build.sh                                               # macOS: Klotse.app and a .dmg
+```
+
+A packaged app can check itself: `Klotse --version` and `Klotse --self-test [REPORT_FILE]`. GitHub Actions builds
+everything on a version tag (`v0.1.0`) or on demand and drafts a release.
+
+[`AGENTS.md`](https://github.com/mbartsch/klotse/blob/master/AGENTS.md) documents the architecture, file map and behavior to preserve; read it before larger
+changes. Work goes through pull requests from a branch; do not commit to `master` directly.
+
+## Roadmap
+
+Klotse is written in Python with PySide6 today. The idea is to move to Qt/C++ (or a similar language) at some
+point. Nothing is decided and there is no timeline; the Python version is the one being developed in the meantime.
+
+## License
+
+Klotse is released under the [Apache License 2.0](https://github.com/mbartsch/klotse/blob/master/LICENSE).
+
+Kubernetes is a registered trademark of The Linux Foundation. Klotse is an independent project and is not
+affiliated with or endorsed by The Linux Foundation or the Kubernetes project.
+
+## Author
+
+Marcelo H. Bartsch · https://github.com/mbartsch/klotse

klotse-0.1.0/README.md

@@ -0,0 +1,177 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/mbartsch/klotse/master/src/klotse/assets/klotse_logo.png" alt="Klotse logo" width="200">
+</p>
+
+# Klotse
+
+A native Kubernetes desktop manager for Windows, macOS and Linux. Browse clusters, workloads, nodes and custom
+resources; read logs; open shells; scale, cordon and drain, all from one window.
+
+Built with Python, PySide6 (Qt Widgets) and the official Kubernetes Python client. It uses your existing
+kubeconfig and authentication helpers, so there is nothing to sign in to and no server component.
+
+> **Status:** early (version 0.1.0). Read-only use against real clusters has been tried; most of the
+> mutating actions (cordon, drain, delete, scale) are covered by automated tests with fake services, not yet by
+> live-cluster runs. Try them on a non-production cluster first.
+
+## Features
+
+- **Multiple clusters.** Every context in your kubeconfig is listed on the left; each open cluster gets its own
+  tab and its own connection.
+- **Resources.** Overview, Workloads, Nodes, Namespaces, Pods, Deployments, ReplicaSets, StatefulSets, DaemonSets,
+  Jobs, CronJobs, ConfigMaps, Secrets, Services, Ingresses, NetworkPolicies, PVCs, PVs, StorageClasses, Events,
+  CustomResourceDefinitions, and read-only browsing of custom resource instances.
+- **Always fresh.** The visible tab refreshes every 10 s (5/10/30/60 s selectable) and immediately when the
+  cluster reports a change. Hidden tabs and clusters are not polled.
+- **Details.** YAML view for any resource, with Secret values masked until you pick the keys to decode.
+  `managedFields` are hidden by default (View → Show managedFields in details).
+- **Pods and containers.** Logs (streaming, search, follow), Shell, Attach, terminate and force terminate.
+  Double-click a pod for its own tab with every regular, init and ephemeral container.
+- **Nodes.** Cordon/uncordon, drain (with the usual kubectl options), a privileged nsenter shell, delete. Double-click
+  a node for its pods, with the node actions in a bar above them. Pod counts per node.
+- **Bulk actions.** Select several rows (Ctrl/Shift) to scale, terminate, cordon or delete them in one confirmed
+  step. Scale accepts a number or a relative change such as `*2`, `/2`, `+1`, `-1`.
+- **Usage.** CPU and memory in use (from metrics-server, when present) on Nodes and Pods, plus optional request,
+  limit and percent-of-request/limit columns on Pods.
+- **Your columns.** The **Columns…** button on every list lets you hide and reorder built-in columns and add label
+  columns with short headings. Saved per resource kind.
+- **Edit menu and Preferences.** Undo/redo/cut/copy/paste/select all (Copy in a table copies the selected rows as
+  tab-separated text). Preferences lets you choose a custom kubeconfig and open the settings folder.
+- **macOS.** Choose Terminal or iTerm2 for shells (Settings → Terminal…).
+
+## Requirements
+
+- Python 3.10 or newer
+- A kubeconfig with at least one context (or pick one in Edit → Preferences)
+- [`kubectl`](https://kubernetes.io/docs/tasks/tools/) on your `PATH`, for drain, shells and attach
+- Python dependencies (installed by the launchers): `PySide6-Essentials`, `kubernetes`, `PyYAML`
+
+## Install
+
+Native packages are built for Windows (an installer and a portable `.zip`) and macOS (a `.dmg` for Apple Silicon and
+one for Intel). None has been published yet; once they are, they will be on the project's
+[Releases](https://github.com/mbartsch/klotse/releases) page. Until then, run Klotse from source (below) or build the
+packages yourself (see [Development](#development)).
+
+- The Windows installer has been tested (install, run, uninstall). The macOS apps are built and self-tested in CI but
+  have not been run on a real Mac yet.
+- The packages are not signed yet, so expect a warning on first start: on Windows choose **More info → Run anyway**,
+  on macOS right-click the app and choose **Open**.
+- `kubectl` is not included and has to be installed separately.
+
+### Linux, or anywhere with Python 3.10+: pipx
+
+There is no native Linux package yet. Install with [pipx](https://pipx.pypa.io), which keeps Klotse and its
+dependencies in their own environment and puts a `klotse` command on your `PATH`:
+
+```sh
+pipx install git+https://github.com/mbartsch/klotse   # straight from GitHub (works today)
+pipx install klotse                                   # from PyPI, once the first release is published
+klotse --install-desktop-entry                        # optional, Linux: add Klotse to the application menu
+```
+
+`klotse --uninstall-desktop-entry` removes the menu entry again. On a minimal Debian/Ubuntu install Qt may also need
+these libraries for its X11 support (the project's CI installs exactly this list on Ubuntu and starts Klotse under
+X11); most desktops already have them:
+
+```sh
+sudo apt install libegl1 libxkbcommon-x11-0 libxcb-cursor0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 \
+  libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xinerama0 libxcb-xkb1
+```
+
+On other distributions install the equivalent packages. If Klotse stops with "could not load the Qt platform plugin
+xcb", run `QT_DEBUG_PLUGINS=1 klotse` to see which library is missing.
+
+## Run
+
+macOS / Linux:
+
+```sh
+./run.sh              # creates .venv and installs dependencies on first run
+./run.sh --check      # check that the imports work, without opening the window
+./run.sh --install    # reinstall dependencies
+```
+
+Windows:
+
+```bat
+run.bat               # starts without a console window
+run.bat --console     # keeps tracebacks visible
+run.bat --check
+run.bat --install
+```
+
+Or, in an existing environment:
+
+```sh
+pip install -r requirements.txt
+PYTHONPATH=src python -m klotse
+```
+
+## Configuration
+
+Settings are stored as a plain INI file, one section per resource kind and one entry per line:
+
+```ini
+[columns.Pod]
+order.0=name
+order.1=namespace
+order.2=ready
+hidden.0=cpu_req
+hidden.1=cpu_lim
+labels.0=app.kubernetes.io/name
+labels_name.0=App
+labels.1=example.com/team
+```
+
+`order` is the order of the built-in columns, `hidden` lists the ones that are hidden, and `labels` the label
+columns; `labels_name.N` gives `labels.N` a short heading. A key that is missing means the default; an empty key
+(`hidden=`) means none. You can edit the file by hand while Klotse is closed.
+
+Open its folder from **Edit → Preferences… → Open config folder**. The same file holds the custom kubeconfig path
+and the macOS terminal choice. A custom kubeconfig is passed both to the Kubernetes client and, as `--kubeconfig`,
+to every `kubectl` command Klotse starts.
+
+Settings from the earlier name of the project (Kubeman) are copied over on the first start.
+
+## Development
+
+```sh
+pip install -r requirements-dev.txt
+PYTHONPATH=src QT_QPA_PLATFORM=offscreen python -m pytest -q
+```
+
+Tests run offscreen with fake services and synthetic Kubernetes objects; they never touch a real cluster or your
+real settings. `run_tests.sh` / `run_tests.bat` wrap the same command.
+
+After all tests pass the pytest process can still exit non-zero (a crash during Qt teardown in some test orders).
+This is a known, unresolved issue that predates recent work, so check the pass count and the exit status separately.
+
+To build the native packages (details, signing and releases in [`packaging/README.md`](https://github.com/mbartsch/klotse/blob/master/packaging/README.md)):
+
+```sh
+powershell -ExecutionPolicy Bypass -File packaging\windows\build.ps1   # Windows: zip, plus installer if Inno Setup is installed
+packaging/macos/build.sh                                               # macOS: Klotse.app and a .dmg
+```
+
+A packaged app can check itself: `Klotse --version` and `Klotse --self-test [REPORT_FILE]`. GitHub Actions builds
+everything on a version tag (`v0.1.0`) or on demand and drafts a release.
+
+[`AGENTS.md`](https://github.com/mbartsch/klotse/blob/master/AGENTS.md) documents the architecture, file map and behavior to preserve; read it before larger
+changes. Work goes through pull requests from a branch; do not commit to `master` directly.
+
+## Roadmap
+
+Klotse is written in Python with PySide6 today. The idea is to move to Qt/C++ (or a similar language) at some
+point. Nothing is decided and there is no timeline; the Python version is the one being developed in the meantime.
+
+## License
+
+Klotse is released under the [Apache License 2.0](https://github.com/mbartsch/klotse/blob/master/LICENSE).
+
+Kubernetes is a registered trademark of The Linux Foundation. Klotse is an independent project and is not
+affiliated with or endorsed by The Linux Foundation or the Kubernetes project.
+
+## Author
+
+Marcelo H. Bartsch · https://github.com/mbartsch/klotse

klotse-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=77"]  # 77+ understands the SPDX license field
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "klotse"
+dynamic = ["version"]
+description = "A native Kubernetes desktop manager built with Python and Qt"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Marcelo H. Bartsch" }]
+keywords = ["kubernetes", "k8s", "kubectl", "desktop", "gui", "qt", "pyside6", "cluster"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: X11 Applications :: Qt",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development",
+    "Topic :: System :: Systems Administration",
+]
+requires-python = ">=3.10"
+dependencies = ["PySide6-Essentials>=6.6", "kubernetes>=29", "PyYAML>=6"]
+
+[project.urls]
+Homepage = "https://github.com/mbartsch/klotse"
+Repository = "https://github.com/mbartsch/klotse"
+Issues = "https://github.com/mbartsch/klotse/issues"
+Releases = "https://github.com/mbartsch/klotse/releases"
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-qt"]
+
+[project.gui-scripts]
+klotse = "klotse.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = {attr = "klotse.__version__"}
+
+[tool.setuptools.package-data]
+klotse = ["assets/*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

klotse-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

klotse-0.1.0/src/klotse/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"  # single source of truth: pyproject.toml reads it, and About shows it