kaos-ui 0.1.0a1__tar.gz

kaos_ui-0.1.0a1/.gitignore

@@ -0,0 +1,40 @@
+# Build / dist
+build/
+dist/
+*.egg-info/
+
+# Caches
+.benchmarks/
+.coverage
+.coverage.*
+.kaos-vfs/
+.kaos-vfs-*/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.ty_cache/
+.venv/
+__pycache__/
+coverage.xml
+htmlcov/
+*.pyc
+
+# OS / editor scratch
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# Secrets — never commit
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+*.p12
+*.pfx
+.kaos-credentials.json
+
+# Scaffolder outputs from local testing
+/demo-*/
+/test-scaffold-*/

kaos_ui-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+All notable changes to `kaos-ui` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Fixed
+- `register_kaos_ui_tools()` previously returned the `KaosRuntime`
+  instance and was named with the long form `register_kaos_<name>_tools`.
+  Both broke the `kaos-mcp serve --module ui` loader contract — it
+  expects a function named `register_<name>_tools` (short form) that
+  returns an `int` tool count (matching `kaos-pdf` / `kaos-web` /
+  `kaos-office` / `kaos-reference`). The canonical entry point is now
+  `kaos_ui.register_ui_tools` (returns `int`); the long form remains
+  as a backwards-compatible alias.
+
+### Added
+- Apache-2.0 license metadata in `pyproject.toml`, plus `LICENSE` and
+  `NOTICE` files at the project root.
+- `SECURITY.md` (90-day disclosure window, PVR primary), `CONTRIBUTING.md`,
+  and `CODE_OF_CONDUCT.md` (professional conduct template).
+- `[project.urls]` populated with all 5 entries (Homepage, Documentation,
+  Repository, Issues, Changelog) and keywords for PyPI discovery.
+
+## [0.1.0a1] — 2026-05-14
+
+First public alpha.
+
+### Added
+- **Six shipping templates.** `web:api` (FastAPI), `web:spa`
+  (Vite + React + Tailwind v4 + shadcn + FastAPI + Caddy + Docker,
+  kaos-agents wired), `dashboard:streamlit`, `tui:textual`,
+  `module` (KAOS module package with tools + CLI + serve + tests),
+  `workflow` (single-file Python script).
+- **`kaos-ui` CLI** with `list`, `info`, `new`, and `doctor` subcommands.
+  Every structured command supports `--json` with a stable
+  `command` + payload envelope per `docs/guides/cli-standard.md`.
+- **Four MCP tools** registered onto a `KaosRuntime` via
+  `register_kaos_ui_tools()`: `kaos-ui-list-templates`,
+  `kaos-ui-template-info`, `kaos-ui-scaffold`, `kaos-ui-doctor`. All
+  ship explicit `ToolAnnotations` and structured error envelopes
+  (`what` / `how_to_fix` / `alternative_tool`).
+- **Typed `ScaffoldResult`** dataclass — frozen, slotted, with a
+  `to_dict()` boundary for JSON/MCP serialization.
+- **`kaos_ui.agents` helper module** — `build_chat_runtime()`,
+  `install_tool_bridge_runtime_patch()`, `augment_instructions()`,
+  `NO_TOOLS_PATTERN` — so kaos-agents-on-FastAPI apps don't have to
+  re-discover the same workarounds for kaos-agents 0.1.0a1.
+- **`KaosUISettings`** (`KAOS_UI_` env prefix) — toolchain versions,
+  `templates_dir` override, follows the canonical `ModuleSettings`
+  pattern.
+- **Post-install runner** supports `cd X && y && z` chains via shlex
+  parsing without enabling a shell (refuses shell-builtin tokens).
+- **`single-user-chat` example** under `examples/` — full end-to-end
+  reference for the `web:spa` template, including bearer-token auth,
+  SSE streaming proxy, read-only tool allowlist, persistent VFS, and
+  markdown rendering with sanitized links.
+- 105 tests passing (75 unit + 30 integration; 81% line coverage).
+
+### Notes
+- This is an **alpha**. The public Python API in `kaos_ui/__init__.py`
+  is stable for the duration of the `0.1.x` line; experimental surfaces
+  live under `kaos_ui.mcp.tools` and may evolve.
+
+[Unreleased]: https://github.com/273v/kaos-ui/compare/v0.1.0a1...HEAD
+[0.1.0a1]: https://github.com/273v/kaos-ui/releases/tag/v0.1.0a1

kaos_ui-0.1.0a1/CODE_OF_CONDUCT.md

@@ -0,0 +1,34 @@
+# Professional Conduct
+
+`kaos-ui` is a professional open-source project. Contributors,
+maintainers, and users are expected to keep project spaces focused,
+respectful, and useful.
+
+## Expectations
+
+- Assume good faith.
+- Discuss ideas, code, and tradeoffs directly.
+- Keep disagreement technical and specific.
+- Respect other contributors' time and boundaries.
+- Do not harass, threaten, insult, dox, spam, or deliberately disrupt
+  project spaces.
+- Do not use project spaces for conduct that would be inappropriate in
+  a professional engineering environment.
+
+Different people and organizations bring different values, cultures,
+and communication styles. This project does not require ideological
+alignment. It does require professional behavior.
+
+## Maintainer Action
+
+Maintainers may edit, hide, close, or remove issues, pull requests,
+comments, or other contributions that make the project less useful or
+less safe to participate in. Repeated or serious disruption may lead to
+temporary or permanent loss of participation privileges.
+
+## Reporting
+
+For conduct concerns, contact **conduct@273ventures.com**.
+
+For security vulnerabilities, do not use public issues. Follow
+[SECURITY.md](SECURITY.md).

kaos_ui-0.1.0a1/CONTRIBUTING.md

@@ -0,0 +1,102 @@
+# Contributing to kaos-ui
+
+`kaos-ui` is the project scaffolder for KAOS user-facing applications:
+FastAPI APIs, web SPAs, Streamlit dashboards, Textual TUIs, and
+standalone module/workflow packages. Contributions are welcome as
+issues, evidence reports, and code changes — particularly ones that
+tighten the link between what the scaffolder advertises and what the
+scaffolded project actually does at runtime.
+
+## Ground rules
+
+1. **Templates ship working code.** Every shipping template must pass
+   the per-template smoke matrix (`tests/integration/test_scaffold_*`).
+   A template that scaffolds but doesn't boot is a release blocker.
+2. **One source of truth per operation.** The CLI, the MCP tools, and
+   the scaffolded `doctor` command all delegate to the same Python
+   functions. Don't fork logic across layers.
+3. **No AGPL/GPL dependencies — ever.** Either in `kaos-ui` itself or
+   in any shipping template's `pyproject.toml`/`package.json`.
+4. **Settings load at the edge.** `KaosUISettings` (and per-template
+   env vars like `KAOS_UI_PYTHON_VERSION`) are resolved at the CLI or
+   MCP tool boundary, not inside scaffolder internals.
+5. **Errors are agent prompts.** Every tool / CLI / scaffolder error
+   ships a `what` / `how_to_fix` / `alternative_tool` triple.
+
+## How to contribute
+
+### Reporting an issue
+
+If a scaffold renders broken output, or a `kaos-ui doctor` check
+returns a false negative, please open an issue with:
+
+- The exact command you ran (e.g., `kaos-ui new web:spa myproj`)
+- The kaos-ui version (`uv pip show kaos-ui`)
+- The OS + Python version (`uname -a && python --version`)
+- The unexpected output (stderr from the command, or the broken file)
+- The expected output (what a working scaffold of the same kind should produce)
+
+### Proposing a new template kind
+
+New templates are welcome. Before opening a PR:
+
+1. Confirm the kind has a clear use-case that's not covered by an
+   existing kind. "Just like web:spa but with a different css framework"
+   is usually a configuration switch on `web:spa`, not a new kind.
+2. Build the template against the latest stable major of every external
+   dependency. Pin to the minor in `pyproject.toml.tmpl` so consumers
+   get bug-fix updates by default.
+3. Add a per-template smoke test under `tests/integration/`. The
+   test must scaffold the kind into a tmp directory, run the manifest's
+   `post_install` chain, and exercise at least one user-facing path
+   (e.g., for a web template: boot the dev server and curl /health).
+4. Run the local quality gate (below) before pushing.
+
+### Code contributions
+
+1. Run the local quality gate before pushing:
+
+   ```bash
+   uv sync --group dev
+   uv run ruff format kaos_ui tests
+   uv run ruff check kaos_ui tests
+   uv run ty check kaos_ui tests
+   uv run pytest tests/ -q
+   ```
+
+2. New scaffolder features need a unit test (`tests/unit/`) covering
+   the success path AND at least one error path.
+3. New MCP tools need explicit `ToolAnnotations`, structured error
+   envelopes (`_error_info`), and unit tests covering metadata +
+   execute success + execute error.
+4. Sign commits with `git commit -s` for the Developer Certificate
+   of Origin.
+5. Use conventional-commit-style messages (`feat:`, `fix:`, `chore:`,
+   `docs:`, `ci:`, `test:`).
+6. PR descriptions: state what changed, why, how it was tested, and
+   whether the change affects shipping templates (those have a higher
+   bar for backwards-compatibility).
+
+## Reviewing template changes
+
+A change to `kaos_ui/templates/<kind>/` is a soft-public-API change:
+every consumer who scaffolds that kind picks up the change on their
+next `kaos-ui new`. Test it the same way you'd test a function with
+unknown callers.
+
+The per-template smoke test (`tests/integration/test_scaffold_*.py`)
+is the regression net. Keep it green.
+
+## Security disclosures
+
+See [`SECURITY.md`](SECURITY.md). Do not open public issues for
+suspected vulnerabilities — use the private reporting channel.
+
+## License
+
+By submitting a contribution, you agree to license it under the
+project's Apache 2.0 license (see [`LICENSE`](LICENSE)) and certify
+that you have the right to do so under the
+[Developer Certificate of Origin](https://developercertificate.org/),
+which is signaled by the `Signed-off-by` trailer added by
+`git commit -s`.

kaos_ui-0.1.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 2026 273 Ventures LLC
+
+   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.

kaos_ui-0.1.0a1/NOTICE

@@ -0,0 +1,8 @@
+kaos-ui
+Copyright 2026 273 Ventures LLC.
+
+This product includes software developed at 273 Ventures LLC
+(https://273ventures.com).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file
+distributed with this software for the full text of the license.