configui 1.0.0__tar.gz

configui-1.0.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @ChenchaoZhao

configui-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        run: pip install uv
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build
+        run: hatch build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

configui-1.0.0/.github/workflows/tests.yml

@@ -0,0 +1,44 @@
+name: unit tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: pip install uv
+
+      - name: Install hatch
+        run: pip install hatch
+      
+      - name: Install pip compile
+        run: pip install hatch-pip-compile
+
+      - name: Run tests with coverage
+        run: hatch run release
+
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.python-version }}
+          path: .coverage*
+          include-hidden-files: true
+          if-no-files-found: warn

configui-1.0.0/.gitignore

@@ -0,0 +1,225 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# macOS
+.DS_Store
+
+# Hatch
+.lock
+hatch.lock
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

configui-1.0.0/AGENTS.md

@@ -0,0 +1,253 @@
+# AGENTS.md
+
+## Initial Exploration
+
+Before writing any code, explore the project structure and understand the conventions:
+
+### Read First (Priority Order)
+
+1. **`pyproject.toml`** — Single source of truth for all configuration
+2. **`README.md`** — Project overview and setup instructions
+3. **`AGENTS.md`** — Agent-specific instructions if it exists
+
+### Extract Key Configuration
+
+From `pyproject.toml`, identify:
+
+| Setting          | Location                              |
+| ---------------- | ------------------------------------- |
+| Package name     | `[project].name`                      |
+| Python version   | `[project].requires-python`           |
+| Source directory | `[tool.hatch.build.targets.wheel]`    |
+| Test directory   | `[tool.pytest.ini_options].testpaths` |
+| Max line length  | `[tool.ruff].line-length`             |
+| Mypy config      | `[tool.mypy]`                         |
+
+### Common Patterns to Match
+
+- Import style and organization
+- Type annotation conventions
+- Naming conventions (modules, classes, functions)
+- Error handling patterns
+- Documentation approach
+
+## Toolchain Standard
+
+Standard development commands (verify in `pyproject.toml`):
+
+- `hatch fmt` — Format + lint (ruff)
+- `hatch test` — Run tests (pytest)
+- `hatch run typing` — Type check (mypy)
+- `hatch run release` — fmt + typing + test
+
+### Tool Purposes
+
+Ask human to install those tools if they are not installed yet.
+
+| Tool | Purpose |
+|------|---------|
+| **hatch** | Project and environment management |
+| **uv** | Fast dependency resolution |
+| **ruff** | Linting and formatting |
+| **mypy** | Static type checking |
+| **pytest** | Test execution |
+
+## Behavioral Guidelines
+
+### Think Before Coding
+
+- State assumptions explicitly. If uncertain, ask.
+- If multiple interpretations exist, present them — don't pick silently.
+- If a simpler approach exists, say so.
+- If something is unclear, stop and ask.
+
+### Simplicity First
+
+- No features beyond what was asked.
+- No abstractions for single-use code.
+- No "flexibility" that wasn't requested.
+- If you write 200 lines and it could be 50, rewrite it.
+
+### Surgical Changes
+
+- Touch only what you must.
+- Don't "improve" adjacent code.
+- Match existing style, even if you'd do it differently.
+- Clean up only YOUR changes' orphans.
+
+### Goal-Driven Execution
+
+- Define verifiable success criteria:
+- "Add validation" → "Write tests for invalid inputs, then make them pass"
+- "Fix the bug" → "Write a test that reproduces it, then make it pass"
+- "Refactor X" → "Ensure tests pass before and after"
+
+### Additional Pythonic Behaviors
+
+- Follow the **Zen of Python** (`import this`):
+- Explicit is better than implicit.
+- Simple is better than complex.
+- Readability counts.
+- If the implementation is hard to explain, it's a bad idea.
+- **Flat over nested.** Prefer early returns and guard clauses over deeply indented logic.
+- **One thing per function.** A function should do exactly what its name says.
+- **Name things well.** A good name is worth more than a comment.
+
+## Code Conventions
+
+### No Magic Numbers
+
+Define default constants at module top in `UPPER_SNAKE_CASE` with explicit types. Use these constants in function signatures, `dataclass` defaults or doc strings instead of hard-coding values.
+
+```python
+DEFAULT_INIT_TIMEOUT_SECONDS: int = 300
+
+def init(timeout: int = DEFAULT_INIT_TIMEOUT_SECONDS) -> None: ...
+```
+
+In tests, import constants to assert default values:
+
+```python
+from mypackage.some_module import DEFAULT_BATCH_SIZE
+
+def test_default_batch_size():
+    assert config.batch_size == DEFAULT_BATCH_SIZE
+```
+
+### Docstring Defaults
+
+Use string templating to keep docstrings in sync with defaults:
+
+```python
+DEFAULT_LR: float = 8e-4
+
+_OPTIMIZER_CONFIG_DOC = f"Learning rate (Defaults to {DEFAULT_LR})"
+
+@dataclass
+class OptimizerConfig:
+    __doc__ = _OPTIMIZER_CONFIG_DOC
+```
+
+### Magic and One-Liners
+
+Occasional clever code is acceptable when it meaningfully improves performance or reduces boilerplate — but it **must** have a docstring or inline comment explaining what it does and why.
+
+```python
+# Good — magic with explanation
+class Registry:
+  """
+  Uses __init_subclass__ to auto-register subclasses by name.
+  This avoids manual registration boilerplate in every subclass.
+  """
+  _registry: dict[str, type] = {}
+
+  def __init_subclass__(cls, **kwargs: object) -> None:
+    super().__init_subclass__(**kwargs)
+    Registry._registry[cls.__name__] = cls
+
+# Bad — clever with no explanation
+return {k: v for d in maps for k, v in d.items() if v is not None}
+
+```
+
+### Enum is Preferred
+
+Enums are better than arbitrary string inputs
+
+```python
+class SchedulerNameEnum(StrEnum):
+    LINEAR = auto()
+    COSINE = auto()
+    CONSTANT = auto()
+
+# automatic validation
+string_input = "linear"
+scheduler_name = SchedulerNameEnum(string_input)
+```
+
+### Type Annotations
+
+- Annotate ALL function signatures (parameters and return types)
+- Use `TypeAlias` and `NewType` over bare primitives when semantic meaning matters
+- Fix `mypy` errors; do not silence with `# type: ignore` without explanation
+- Prefer `TypeAlias` and `NewType` over bare primitives when the semantic meaning matters.
+
+## Testing Rules
+
+### Structure: Arrange / Act / Assert
+
+```python
+def test_invoice_total_includes_tax() -> None:
+    # Arrange
+    invoice = Invoice(subtotal=100.0, tax_rate=0.1)
+
+    # Act
+    total = invoice.total()
+
+    # Assert
+    assert total == 110.0
+```
+
+### Naming Conventions
+
+- Test file: `test_<module>.py`
+- Test function: `test_<what>_<condition>_<expected_outcome>`
+
+```python
+def test_parse_date_with_invalid_string_raises_value_error() -> None: ...
+def test_user_is_active_after_email_verification() -> None: ...
+```
+
+### Rules
+
+- **One assertion concept per test**
+- **No logic in tests** — No loops, no conditionals. Use `@pytest.mark.parametrize`
+- **Fixtures over setUp** — Use pytest fixtures for shared setup
+- **Test behavior, not implementation** — Tests must survive refactoring
+
+### Parametrize for Variations
+
+```python
+@pytest.mark.parametrize(("raw", "expected"), [
+    ("2024-01-01", date(2024, 1, 1)),
+    ("2024-12-31", date(2024, 12, 31)),
+])
+def test_parse_date_returns_correct_date(raw: str, expected: date) -> None:
+    assert parse_date(raw) == expected
+```
+
+## CI Pipeline Setup
+
+Typical CI pipeline stages:
+
+1. **Typing** — `hatch run typing` (mypy)
+2. **Test** — `hatch test` (pytest)
+
+Note: Lint is typically NOT run in CI (ran locally).
+
+## Pre-Commit Checklist
+
+Before submitting changes:
+
+- [ ] `hatch fmt` passes with no changes
+- [ ] `hatch test` passes
+- [ ] `hatch run typing` passes
+- [ ] All functions have type annotations
+- [ ] No silenced errors without explanation
+- [ ] No unexplained magic or one-liners
+
+## Common Gotchas
+
+- Do NOT install pytest directly; use `hatch test`
+- `requirements.txt` is auto-generated — do not edit manually
+- Dependencies go in `pyproject.toml`, not in `requirements.txt`
+- Never leave project in state where `hatch fmt` or `hatch test` fails
+
+## For This Project
+
+- Read project management files in `PM/`
+- The project design doc is `PM/design_doc.md`
+- The task tickets are `PM/tasks/CUI-*.md`
+- When a subtask is finished, remember to check the box
+- You MUST draft your plan first and update the ticket before doing anything
+- You MUST NOT write code before formulating the plan

configui-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chenchao Zhao
+
+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.

configui-1.0.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: configui
+Version: 1.0.0
+Dynamic: License
+Dynamic: License-Expression
+Summary: A tool that turns any yaml or json configs into tui
+Author-email: Chenchao Zhao <chenchao.zhao.dev+github@gmail.com>
+License-File: LICENSE
+Requires-Python: <3.14,>=3.12
+Requires-Dist: click>=8.1.0
+Requires-Dist: ruamel-yaml>=0.18.0
+Requires-Dist: textual>=1.0.0
+Requires-Dist: tomlkit>=0.13.0
+Description-Content-Type: text/markdown
+
+# ConfigUI
+
+[![CI](https://github.com/chenchaozhao/configui/actions/workflows/tests.yml/badge.svg)](https://github.com/chenchaozhao/configui/actions/workflows/tests.yml)
+[![PyPI version](https://img.shields.io/pypi/v/configui)](https://pypi.org/project/configui/)
+[![Python](https://img.shields.io/badge/python-3.12%20|%203.13-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+Turn YAML, JSON, and TOML configuration files into a terminal user interface (TUI) — no IDE required.
+
+---
+
+## Installation
+
+```bash
+# Install from PyPI
+uv tool install configui
+
+# Or with pip
+pip install configui
+```
+
+## Quickstart
+
+```bash
+configui path/to/config.yaml
+```
+
+Open a configuration file in the interactive TUI editor. Edit values, toggle booleans, navigate nested structures — everything stays type-aware. Try it with the sample configs in `samples/`:
+
+```bash
+configui samples/training_config.yaml
+configui samples/training_config.json
+configui samples/training_config.toml
+```
+
+```bash
+configui path/to/config.yaml -r  # Read-only mode
+```
+
+![ConfigUI screenshot](_assets/ConfigUI_screenshot.svg)
+
+## Features
+
+- **Type-aware editing** — booleans become checkboxes, numbers get numeric inputs, nested objects become collapsible sections.
+- **Multi-format** — YAML (with comment preservation via `ruamel.yaml`), JSON, and TOML (with `tomlkit`).
+- **Read-only mode** — inspect configs without accidental edits (`-r` flag).
+- **Save or Save As** — overwrite the original or write to a new path.
+- **Comment preservation** — your YAML and TOML comments stay intact.
+
+## Supported Formats
+
+| Format | Library | Comments preserved |
+|--------|---------|-------------------|
+| YAML   | ruamel.yaml | ✅ |
+| JSON   | stdlib json | ❌ (not supported by format) |
+| TOML   | tomlkit     | ✅ |
+
+## Development
+
+```bash
+uv tool install hatch
+hatch run release   # fmt → typing → test with coverage
+```
+
+## License
+
+MIT