cli-root-yo 0.1.0__tar.gz

cli_root_yo-0.1.0/.gitignore

@@ -0,0 +1,210 @@
+# Dynamic version file (generated by setuptools_scm)
+cli_root_yo/_version.py
+
+# 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
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

cli_root_yo-0.1.0/LICENSE

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

cli_root_yo-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include README.md
+include SPEC.md
+recursive-include cli_root_yo py.typed
+prune .ignore
+prune tests
+

cli_root_yo-0.1.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: cli-root-yo
+Version: 0.1.0
+Summary: Reusable CLI kernel for building unified command-line interfaces with consistent behavior, output style, help, and extension semantics.
+Author: Daylily Informatics
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Daylily-Informatics/cli-root-yo
+Project-URL: Repository, https://github.com/Daylily-Informatics/cli-root-yo
+Project-URL: Issues, https://github.com/Daylily-Informatics/cli-root-yo/issues
+Keywords: cli,typer,rich,plugin,xdg,framework
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer<0.22.0,>=0.21.0
+Requires-Dist: rich<15.0.0,>=14.0.0
+Requires-Dist: click<9.0.0,>=8.3.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# cli-root-yo
+
+[![GitHub Release](https://img.shields.io/github/v/release/Daylily-Informatics/cli-root-yo?style=flat-square&label=release)](https://github.com/Daylily-Informatics/cli-root-yo/releases/latest)
+[![GitHub Tag](https://img.shields.io/github/v/tag/Daylily-Informatics/cli-root-yo?style=flat-square&label=tag)](https://github.com/Daylily-Informatics/cli-root-yo/tags)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+
+Reusable CLI kernel for building unified command-line interfaces with consistent behavior, output style, help, and extension semantics. Built on [Typer](https://typer.tiangolo.com/) + [Rich](https://rich.readthedocs.io/).
+
+## What It Does
+
+`cli-root-yo` provides the shared foundation that downstream CLI tools build on:
+
+- **Root app factory** — `create_app()` builds a fully configured Typer app from a declarative spec
+- **Built-in commands** — `version`, `info`, and optional `config`/`env` groups
+- **Plugin system** — explicit callables + `cli_root_yo.plugins` entry-point discovery
+- **XDG paths** — platform-aware config/data/state/cache directory resolution (macOS + Linux)
+- **Output primitives** — `heading`, `success`, `warning`, `error`, `action`, `detail`, `bullet`, `emit_json`
+- **Runtime context** — immutable singleton accessible to all commands during invocation
+- **JSON mode** — `--json`/`-j` flag with deterministic output (indent=2, sorted keys, no ANSI)
+- **NO_COLOR** — respects the [NO_COLOR](https://no-color.org/) convention
+- **Debug mode** — `CLI_ROOT_YO_DEBUG=1` prints tracebacks to STDERR
+
+## Prerequisites
+
+- Python 3.10+
+- pip
+
+## Installation
+
+```bash
+pip install cli-root-yo
+```
+
+For development:
+
+```bash
+git clone https://github.com/Daylily-Informatics/cli-root-yo.git
+cd cli-root-yo
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+from cli_root_yo.spec import CliSpec, XdgSpec
+from cli_root_yo.app import run
+
+spec = CliSpec(
+    prog_name="my-tool",
+    app_display_name="My Tool",
+    dist_name="my-tool",
+    root_help="A CLI built with cli-root-yo.",
+    xdg=XdgSpec(vendor="my-tool"),
+)
+
+exit_code = run(spec)
+```
+
+This gives you `my-tool version`, `my-tool info`, `my-tool --help`, `--json` support, and all the standard behaviors out of the box.
+
+## Adding Commands via Plugin
+
+```python
+# my_tool/plugin.py
+def register(registry, spec):
+    registry.add_command(None, "greet", greet_cmd, help_text="Say hello.")
+
+def greet_cmd():
+    from cli_root_yo import output
+    output.success("Hello, world!")
+```
+
+Register it in your spec:
+
+```python
+from cli_root_yo.spec import PluginSpec
+
+spec = CliSpec(
+    ...,
+    plugins=PluginSpec(explicit=["my_tool.plugin.register"]),
+)
+```
+
+Or via entry points in `pyproject.toml`:
+
+```toml
+[project.entry-points."cli_root_yo.plugins"]
+my-tool = "my_tool.plugin:register"
+```
+
+## Config & Env Groups
+
+Enable optional built-in command groups by providing specs:
+
+```python
+from cli_root_yo.spec import ConfigSpec, EnvSpec
+
+spec = CliSpec(
+    ...,
+    config=ConfigSpec(
+        primary_filename="config.json",
+        template_bytes=b'{"key": "value"}\n',
+    ),
+    env=EnvSpec(
+        env_dir_name=".venv",
+        activate_script_rel="bin/activate",
+    ),
+)
+```
+
+This adds `config path|init|show|validate|edit|reset` and `env status|activate|deactivate|reset`.
+
+## Public API
+
+| Symbol | Module | Description |
+|--------|--------|-------------|
+| `create_app(spec)` | `cli_root_yo.app` | Build a Typer app from a CliSpec |
+| `run(spec, argv)` | `cli_root_yo.app` | Execute CLI, return exit code (never calls `sys.exit()`) |
+| `CommandRegistry` | `cli_root_yo.registry` | Register commands/groups with ordering and conflict detection |
+| `get_context()` | `cli_root_yo.runtime` | Access the current invocation's RuntimeContext |
+| `CliSpec`, `ConfigSpec`, `EnvSpec`, `PluginSpec`, `XdgSpec` | `cli_root_yo.spec` | Frozen dataclass specs |
+| `output.*` | `cli_root_yo.output` | UX primitives + `emit_json()` |
+
+## Exit Codes
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success |
+| 1 | Domain/runtime failure |
+| 2 | Usage error (bad args, unknown command) |
+| 130 | SIGINT |
+
+## Build / Test / Lint
+
+```bash
+# Run tests
+python -m pytest tests/ -v --cov=cli_root_yo
+
+# Lint + format check
+ruff check cli_root_yo tests
+ruff format --check cli_root_yo tests
+
+# Type check
+mypy cli_root_yo --ignore-missing-imports
+
+# Build distribution
+python -m build
+twine check dist/*
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

cli_root_yo-0.1.0/README.md

@@ -0,0 +1,153 @@
+# cli-root-yo
+
+[![GitHub Release](https://img.shields.io/github/v/release/Daylily-Informatics/cli-root-yo?style=flat-square&label=release)](https://github.com/Daylily-Informatics/cli-root-yo/releases/latest)
+[![GitHub Tag](https://img.shields.io/github/v/tag/Daylily-Informatics/cli-root-yo?style=flat-square&label=tag)](https://github.com/Daylily-Informatics/cli-root-yo/tags)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+
+Reusable CLI kernel for building unified command-line interfaces with consistent behavior, output style, help, and extension semantics. Built on [Typer](https://typer.tiangolo.com/) + [Rich](https://rich.readthedocs.io/).
+
+## What It Does
+
+`cli-root-yo` provides the shared foundation that downstream CLI tools build on:
+
+- **Root app factory** — `create_app()` builds a fully configured Typer app from a declarative spec
+- **Built-in commands** — `version`, `info`, and optional `config`/`env` groups
+- **Plugin system** — explicit callables + `cli_root_yo.plugins` entry-point discovery
+- **XDG paths** — platform-aware config/data/state/cache directory resolution (macOS + Linux)
+- **Output primitives** — `heading`, `success`, `warning`, `error`, `action`, `detail`, `bullet`, `emit_json`
+- **Runtime context** — immutable singleton accessible to all commands during invocation
+- **JSON mode** — `--json`/`-j` flag with deterministic output (indent=2, sorted keys, no ANSI)
+- **NO_COLOR** — respects the [NO_COLOR](https://no-color.org/) convention
+- **Debug mode** — `CLI_ROOT_YO_DEBUG=1` prints tracebacks to STDERR
+
+## Prerequisites
+
+- Python 3.10+
+- pip
+
+## Installation
+
+```bash
+pip install cli-root-yo
+```
+
+For development:
+
+```bash
+git clone https://github.com/Daylily-Informatics/cli-root-yo.git
+cd cli-root-yo
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+from cli_root_yo.spec import CliSpec, XdgSpec
+from cli_root_yo.app import run
+
+spec = CliSpec(
+    prog_name="my-tool",
+    app_display_name="My Tool",
+    dist_name="my-tool",
+    root_help="A CLI built with cli-root-yo.",
+    xdg=XdgSpec(vendor="my-tool"),
+)
+
+exit_code = run(spec)
+```
+
+This gives you `my-tool version`, `my-tool info`, `my-tool --help`, `--json` support, and all the standard behaviors out of the box.
+
+## Adding Commands via Plugin
+
+```python
+# my_tool/plugin.py
+def register(registry, spec):
+    registry.add_command(None, "greet", greet_cmd, help_text="Say hello.")
+
+def greet_cmd():
+    from cli_root_yo import output
+    output.success("Hello, world!")
+```
+
+Register it in your spec:
+
+```python
+from cli_root_yo.spec import PluginSpec
+
+spec = CliSpec(
+    ...,
+    plugins=PluginSpec(explicit=["my_tool.plugin.register"]),
+)
+```
+
+Or via entry points in `pyproject.toml`:
+
+```toml
+[project.entry-points."cli_root_yo.plugins"]
+my-tool = "my_tool.plugin:register"
+```
+
+## Config & Env Groups
+
+Enable optional built-in command groups by providing specs:
+
+```python
+from cli_root_yo.spec import ConfigSpec, EnvSpec
+
+spec = CliSpec(
+    ...,
+    config=ConfigSpec(
+        primary_filename="config.json",
+        template_bytes=b'{"key": "value"}\n',
+    ),
+    env=EnvSpec(
+        env_dir_name=".venv",
+        activate_script_rel="bin/activate",
+    ),
+)
+```
+
+This adds `config path|init|show|validate|edit|reset` and `env status|activate|deactivate|reset`.
+
+## Public API
+
+| Symbol | Module | Description |
+|--------|--------|-------------|
+| `create_app(spec)` | `cli_root_yo.app` | Build a Typer app from a CliSpec |
+| `run(spec, argv)` | `cli_root_yo.app` | Execute CLI, return exit code (never calls `sys.exit()`) |
+| `CommandRegistry` | `cli_root_yo.registry` | Register commands/groups with ordering and conflict detection |
+| `get_context()` | `cli_root_yo.runtime` | Access the current invocation's RuntimeContext |
+| `CliSpec`, `ConfigSpec`, `EnvSpec`, `PluginSpec`, `XdgSpec` | `cli_root_yo.spec` | Frozen dataclass specs |
+| `output.*` | `cli_root_yo.output` | UX primitives + `emit_json()` |
+
+## Exit Codes
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success |
+| 1 | Domain/runtime failure |
+| 2 | Usage error (bad args, unknown command) |
+| 130 | SIGINT |
+
+## Build / Test / Lint
+
+```bash
+# Run tests
+python -m pytest tests/ -v --cov=cli_root_yo
+
+# Lint + format check
+ruff check cli_root_yo tests
+ruff format --check cli_root_yo tests
+
+# Type check
+mypy cli_root_yo --ignore-missing-imports
+
+# Build distribution
+python -m build
+twine check dist/*
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).