Metadata-Version: 2.5
Name: ktui
Version: 0.2.1
Summary: ktui — an interactive Kubernetes TUI manifest builder
License: # PolyForm Noncommercial License 1.0.0
        
        <https://polyformproject.org/licenses/noncommercial/1.0.0>
        
        ## Acceptance
        
        In order to get any license under these terms, you must agree
        to them as both strict obligations and conditions to all
        your licenses.
        
        ## Copyright License
        
        The licensor grants you a copyright license for the
        software to do everything you might do with the software
        that would otherwise infringe the licensor's copyright
        in it for any permitted purpose.  However, you may
        only distribute the software according to [Distribution
        License](#distribution-license) and make changes or new works
        based on the software according to [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Distribution License
        
        The licensor grants you an additional copyright license
        to distribute copies of the software.  Your license
        to distribute covers distributing the software with
        changes and new works permitted by [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Notices
        
        You must ensure that anyone who gets a copy of any part of
        the software from you also gets a copy of these terms or the
        URL for them above, as well as copies of any plain-text lines
        beginning with `Required Notice:` that the licensor provided
        with the software.  For example:
        
        > Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
        
        ## Changes and New Works License
        
        The licensor grants you an additional copyright license to
        make changes and new works based on the software for any
        permitted purpose.
        
        ## Patent License
        
        The licensor grants you a patent license for the software that
        covers patent claims the licensor can license, or becomes able
        to license, that you would infringe by using the software.
        
        ## Noncommercial Purposes
        
        Any noncommercial purpose is a permitted purpose.
        
        ## Personal Uses
        
        Personal use for research, experiment, and testing for
        the benefit of public knowledge, personal study, private
        entertainment, hobby projects, amateur pursuits, or religious
        observance, without any anticipated commercial application,
        is use for a permitted purpose.
        
        ## Noncommercial Organizations
        
        Use by any charitable organization, educational institution,
        public research organization, public safety or health
        organization, environmental protection organization,
        or government institution is use for a permitted purpose
        regardless of the source of funding or obligations resulting
        from the funding.
        
        ## Fair Use
        
        You may have "fair use" rights for the software under the
        law. These terms do not limit them.
        
        ## No Other Rights
        
        These terms do not allow you to sublicense or transfer any of
        your licenses to anyone else, or prevent the licensor from
        granting licenses to anyone else.  These terms do not imply
        any other licenses.
        
        ## Patent Defense
        
        If you make any written claim that the software infringes or
        contributes to infringement of any patent, your patent license
        for the software granted under these terms ends immediately. If
        your company makes such a claim, your patent license ends
        immediately for work on behalf of your company.
        
        ## Violations
        
        The first time you are notified in writing that you have
        violated any of these terms, or done anything with the software
        not covered by your licenses, your licenses can nonetheless
        continue if you come into full compliance with these terms,
        and take practical steps to correct past violations, within
        32 days of receiving notice.  Otherwise, all your licenses
        end immediately.
        
        ## No Liability
        
        ***As far as the law allows, the software comes as is, without
        any warranty or condition, and the licensor will not be liable
        to you for any damages arising out of these terms or the use
        or nature of the software, under any kind of legal claim.***
        
        ## Definitions
        
        The **licensor** is the individual or entity offering these
        terms, and the **software** is the software the licensor makes
        available under these terms.
        
        **You** refers to the individual or entity agreeing to these
        terms.
        
        **Your company** is any legal entity, sole proprietorship,
        or other kind of organization that you work for, plus all
        organizations that have control over, are under the control of,
        or are under common control with that organization.  **Control**
        means ownership of substantially all the assets of an entity,
        or the power to direct its management and policies by vote,
        contract, or otherwise.  Control can be direct or indirect.
        
        **Your licenses** are all the licenses granted to you for the
        software under these terms.
        
        **Use** means anything you do with the software requiring one
        of your licenses.
License-File: LICENSE
Keywords: cli,k8s,kubernetes,terminal,tui,yaml
Requires-Python: >=3.12
Requires-Dist: pydantic>=2.0.0
Requires-Dist: ruamel-yaml>=0.18.0
Requires-Dist: textual>=0.80.0
Provides-Extra: dev
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pip-audit; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pyinstaller>=6.0.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

<div align="center">
  <h1>🚢 ktui</h1>
  <p><strong>An interactive terminal UI for building Kubernetes YAML manifests.</strong></p>
  
  <p>
    <a href="https://github.com/marceleno1717/ktui/actions/workflows/ci.yml"><img src="https://github.com/marceleno1717/ktui/actions/workflows/ci.yml/badge.svg" alt="CI Status"></a>
    <a href="https://pypi.org/project/ktui/"><img src="https://img.shields.io/pypi/v/ktui" alt="PyPI version"></a>
    <a href="https://www.npmjs.com/package/@ktui/editor"><img src="https://img.shields.io/npm/v/@ktui/editor" alt="npm version"></a>
    <a href="https://pypi.org/project/ktui/"><img src="https://img.shields.io/pypi/pyversions/ktui" alt="Python Versions"></a>
    <a href="LICENSE"><img src="https://img.shields.io/badge/License-PolyForm%20Noncommercial-blue.svg" alt="License"></a>
  </p>
</div>

---

## ⚡ Why ktui?

Tired of memorizing exact YAML structures, indentation rules, and valid fields for every Kubernetes resource? 

`ktui` solves this by giving you a dynamic, schema-driven terminal UI. It behaves like a modern web form inside your terminal. Pick a resource, fill in the fields you care about, use the interactive field picker to search for advanced properties, and preview or save the generated YAML. 

## ✨ Features

- 🏗️ **Schema-driven Forms**: Built-in definitions for core Kubernetes resources (Deployments, Pods, Services, ConfigMaps, RBAC, OpenShift Routes, etc.).
- 🔍 **Interactive Field Picker**: Don't see the field you need? Open the searchable field picker to dynamically mount new properties or entire field groups (like `spec.template.spec.containers`) into your form.
- ♻️ **Smart Merging**: Added fields are intelligently merged into their correct hierarchical sections—no duplicate categories or broken nesting.
- 🗂️ **Multi-Tab Editing**: Open several resources at once (even multiple of the same kind), each in its own tab with independent state. Tabs are titled after `metadata.name`.
- 👁️ **Live YAML Preview**: Press `p` at any time to instantly see the clean, formatted YAML you are building.
- 🎨 **Modern TUI**: Keyboard-first navigation, multiple themes (press `t` to cycle), and a responsive layout powered by [Textual](https://textual.textualize.io/).
- 💾 **Instant Save**: Save your generated manifests directly to your disk with a single keystroke.

## 🚀 Installation

`ktui` is distributed as both a Python package and a self-contained executable via npm.

### Option A: npm / npx (Recommended for JS/TS devs)
You don't even need Python installed! The npm package downloads a pre-compiled native binary for your OS (Linux, macOS, Windows).

```bash
# Run directly without installing
npx @ktui/editor

# Or install globally
npm install -g @ktui/editor
```

### Option B: pipx / pip (Recommended for Python devs)
Install via PyPI using `pipx` (to keep your environment clean):

```bash
pipx install ktui

# Or with pip
pip install ktui
```

## ⌨️ Usage & Keybindings

Simply run `ktui` in your terminal to start the application.

### Global
| Key | Action |
|-----|--------|
| `↑` / `↓` | Navigate focused lists |
| `Tab` / `Shift+Tab` | Move between form fields |
| `Enter` | Select resource / confirm (opens it in a new tab) |
| `Ctrl+W` | Close the active tab |
| `Ctrl+V` | Validate the active tab |
| `p` | Preview YAML |
| `Ctrl+S` | Save YAML to file |
| `t` | Cycle application theme |
| `Esc` | Close modal / Go back |
| `q` | Quit |

### Field Picker (Press `Add Field` in forms)
| Key | Action |
|-----|--------|
| `/` | Focus search bar |
| `↑` / `↓` | Navigate available fields |
| `Enter` (on property) | Toggle individual field selection |
| `Enter` (on 📁 group) | Select / deselect all fields in that group |
| `Esc` | Cancel without adding |

## 🛠️ Development

If you want to contribute or build from source:

```bash
git clone https://github.com/marceleno1717/ktui.git
cd ktui

# Create virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install in editable mode with dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Start the app
ktui
```

## 📄 License

This project is licensed under the [PolyForm Noncommercial License 1.0.0](LICENSE).
