kiste 0.8.6__tar.gz

kiste-0.8.6/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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 2026 Kiste contributors
+
+   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
+
+       https://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.

kiste-0.8.6/PKG-INFO

@@ -0,0 +1,475 @@
+Metadata-Version: 2.4
+Name: kiste
+Version: 0.8.6
+Summary: Stabilized repo, data, GitOps, cloud, Argo CD, self-hosting, and release inspector
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/KisteBox/kiste-py
+Project-URL: Repository, https://github.com/KisteBox/kiste-py
+Project-URL: Issues, https://github.com/KisteBox/kiste-py/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: github
+Requires-Dist: PyGithub; extra == "github"
+Provides-Extra: hf
+Requires-Dist: huggingface-hub; extra == "hf"
+Provides-Extra: sops
+Requires-Dist: subprocess-tee; extra == "sops"
+Dynamic: license-file
+
+# Kiste
+
+Kiste is a Python CLI for inspecting application repositories and preparing them
+for Kubernetes/GitOps packaging.
+
+It can scan local, GitHub, and Hugging Face repositories; combine many repos into
+one workspace graph; inspect dataset dependencies; check token capabilities;
+generate a GitOps repo; prepare cloud and Argo CD plans; and create SOPS-style
+encrypted Kubernetes Secret manifests.
+
+Kiste is also an importable Python library. The CLI is one interface over the
+same scanner, workspace, GitOps, token, and secret-management APIs.
+
+## Install
+
+Install `uv` first if it is not already available:
+
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+From the repo root:
+
+```bash
+uv sync
+```
+
+Install provider SDK extras when scanning remote repositories:
+
+```bash
+uv sync --extra github
+uv sync --extra hf
+uv sync --extra sops
+uv sync --group dev
+```
+
+The GitHub provider prefers PyGithub when the `github` extra is installed. The
+Hugging Face provider prefers `huggingface_hub` when the `hf` extra is installed.
+Kiste keeps a stdlib HTTP fallback for minimal installs.
+
+If `kiste` is not found after install, either run through Python:
+
+```bash
+uv run python -m kiste.cli --help
+```
+
+or use the uv-managed console script:
+
+```bash
+uv run kiste --help
+```
+
+## Quick Start
+
+Local repo scan:
+
+```bash
+kiste init --name robot-api
+kiste scan .
+kiste repo summary
+kiste check --repo . --target k8s
+```
+
+Remote scans:
+
+```bash
+kiste scan github owner/repo --ref main
+kiste scan github owner/repo --ref main --token github-dev
+kiste scan hf owner/model-name
+kiste scan hf owner/dataset-name --type dataset
+kiste provider hf inspect owner/space-name --type space
+```
+
+Token metadata:
+
+```bash
+kiste token add github --name github-dev --scope repo:read,actions:read,packages:write --expires 2026-08-01 --metadata-only
+kiste token add hf --name hf-dev --scope repo:read --expires 2026-08-01 --metadata-only
+kiste token list
+kiste token check github-dev --need repo:read
+```
+
+Workspace workflow:
+
+```bash
+kiste workspace init --name robot-platform
+kiste workspace add github owner/frontend --name frontend --type frontend --token github-dev
+kiste workspace add github owner/api --name api --type backend --token github-dev
+kiste workspace add hf owner/model --name model --type model --token hf-dev
+kiste connect api model --relation loads-model
+kiste workspace scan
+kiste workspace graph
+kiste workspace token matrix
+kiste workspace check --target k8s
+```
+
+Image and target security planning:
+
+```bash
+kiste image inspect docker.io/owner/api:latest
+kiste image tags docker.io/owner/api
+kiste image check-pull docker.io/owner/api:latest
+kiste link image api docker.io/owner/api:latest
+kiste target plan --service api
+kiste workspace check --include-images --target-plan
+```
+
+Dataset workflow:
+
+```bash
+kiste token add roboflow --name roboflow-dev --scope dataset:read,export:read --expires 2026-08-01 --metadata-only
+kiste data add kaggle owner/dataset --name traffic-data
+kiste data add roboflow workspace/project/1 --name weld-detection --token roboflow-dev
+kiste data add hf owner/dataset --name hf-dataset
+kiste data add dvc ./data.dvc --name training-data
+kiste data add local ./datasets/weld-seams --name weld-seams
+kiste data inspect weld-detection
+kiste data scan
+kiste data connect weld-detection model --relation trains-model
+kiste data check weld-detection
+kiste data card weld-detection --output docs/others/datasets/weld-detection.md
+kiste data export-plan weld-detection --format yolov8
+kiste workspace graph --include-data
+kiste workspace check --include-data
+```
+
+Phase 8 bootstrap, cloud, Argo CD, and self-hosting workflow:
+
+```bash
+kiste module list
+kiste module doctor
+kiste bootstrap core
+kiste bootstrap workspace
+kiste bootstrap gitops
+kiste bootstrap argocd
+kiste cloud plan --provider aws
+kiste cloud check --provider aws
+kiste argocd init --repo-url https://github.com/example/kiste-gitops.git
+kiste argocd generate
+kiste argocd validate
+kiste self init
+kiste self scan
+kiste self check
+kiste self improve
+kiste release check
+kiste release freeze
+kiste release package
+kiste release candidate --version 0.8.5-rc1
+```
+
+GitOps and secrets workflow:
+
+```bash
+kiste gitops init --workspace robot-platform --output ./robot-platform-gitops
+kiste secrets init sops --age
+kiste gitops plan
+kiste gitops generate --env dev
+kiste secrets add api --from-env DATABASE_URL --from-env SECRET_KEY --encrypt sops
+kiste secrets scan
+kiste gitops validate
+kiste review
+```
+
+## Features
+
+- Stable Python API under `kiste.scanner`, `kiste.workspace`, `kiste.gitops`,
+  `kiste.secrets`, and `kiste.tokens`
+- Typed data models under `kiste.models`
+- Local Docker repo scanning
+- GitHub repo scanning through selected important files
+- Hugging Face model, dataset, and Space scanning with type inference
+- App spec extraction: language, framework, ports, services, env vars, GPU hints
+- Token metadata and capability checks
+- Multi-repo workspace registry
+- Workspace dependency graph with auto and manual connections
+- Token access matrix for scan/build/package readiness
+- GitOps repo generation with Kustomize-style folders
+- SOPS-style encrypted Secret manifests
+- Plaintext secret detection before GitOps commit
+- Phase 4.5 architecture, command, data model, security, GitOps, and roadmap reviews
+- Container image reference validation and mutable-tag/digest warnings
+- Source repo to image linking and Kubernetes/serverless target recommendation
+- Dataset registry for Kaggle, Roboflow, Hugging Face Datasets, DVC, local
+  folders, and cloud object-store references
+- Dataset metadata profiling, access checks, lineage connections, dataset-card
+  generation, and export/download planning without automatic bulk downloads
+- Module registry, staged bootstrap, cloud readiness plans, Argo CD
+  Application/AppProject generation, and safe self-improvement reports
+- Release readiness reports, API/command freeze snapshots, package artifacts,
+  release notes, and release candidate checklists
+- CI workflow with tests, lint, type check, and CLI smoke test
+
+## Design Docs
+
+Canonical design references:
+
+- [Getting Started](docs/getting-started.md): install, first scan, remote SDK setup, tokens, workspace, data-safe workflow, GitOps, and release checks.
+- [Technical Design](docs/technical-design.md): architecture, command groups, data flows, storage, security, bootstrap, modules, and release stabilization.
+- [SDK Design](docs/sdk-design.md): Python API, CLI-to-SDK mapping, provider SDK behavior, token API, return types, and SDK extension rules.
+
+## Python API
+
+Scan a repo:
+
+```python
+from kiste.scanner import scan_repo
+
+spec = scan_repo("tests/fixtures/fastapi_docker_repo")
+print(spec.app.framework)
+print(spec.app.port)
+```
+
+Work with a workspace:
+
+```python
+from kiste.workspace import load_workspace, scan_workspace, build_graph
+
+workspace = load_workspace(".")
+scan_workspace(".")
+connections = build_graph(".")
+```
+
+Load and check token metadata:
+
+```python
+from kiste.tokens import add_token, check_token, list_tokens, load_token_store
+
+add_token(
+    "github",
+    name="github-dev",
+    scopes="repo:read,actions:read",
+    expires_at="2026-08-01",
+    token_value="ghp_example",
+    repo_root=".",
+)
+for token in list_tokens("."):
+    print(token.name, token.provider, token.secret_reference)
+
+report = check_token("github-dev", target="scan")
+print(report["status"])
+
+store = load_token_store(".")
+print(store["tokens"])
+```
+
+Work with datasets:
+
+```python
+from kiste.data import add_dataset, check_dataset, inspect_dataset
+
+add_dataset("local", "./datasets/weld-seams", name="weld-seams")
+dataset = inspect_dataset("weld-seams")
+report = check_dataset("weld-seams")
+print(dataset.task_type)
+print(report["status"])
+```
+
+Generate and validate GitOps output:
+
+```python
+from kiste.gitops import generate_gitops_repo, validate_gitops_repo
+from kiste.workspace import load_workspace
+
+workspace = load_workspace(".")
+generate_gitops_repo(workspace, "./robot-platform-gitops", env="dev")
+report = validate_gitops_repo("./robot-platform-gitops")
+print(report.ok)
+```
+
+Encrypt a SOPS-style secret:
+
+```python
+from kiste.secrets import SopsSecretBackend
+
+backend = SopsSecretBackend(config_file=".sops.yaml")
+encrypted = backend.encrypt_secret(
+    name="api-secret",
+    data={"DATABASE_URL": "...", "SECRET_KEY": "..."},
+)
+```
+
+## Generated Files
+
+Single-repo scan:
+
+```text
+kiste.yaml
+.kiste/
+  spec.json
+  scan-report.json
+  tokens.json
+```
+
+Workspace scan:
+
+```text
+.kiste/
+  workspace.json
+  graph.json
+  token-matrix.json
+  workspace-report.json
+  datasets/
+    weld-detection.dataset.json
+  repos/
+    api.spec.json
+    frontend.spec.json
+```
+
+GitOps/SOPS setup:
+
+```text
+.kiste/
+  gitops.json
+  secrets.json
+  review/
+    kiste-phase-4.5-review.md
+  release/
+    release-check.json
+    release-readiness.md
+    api-freeze.md
+    command-freeze.md
+    test-report.md
+    security-report.md
+    packaging-report.md
+    docs-report.md
+    release-notes.md
+    release-candidate-checklist.md
+
+robot-platform-gitops/
+  README.md
+  .sops.yaml
+  clusters/
+  apps/
+  infrastructure/
+    namespaces/
+    network-policies/
+    secrets/
+      api-secret.enc.yaml
+```
+
+## Security Notes
+
+Raw tokens should come from environment variables when possible:
+
+PowerShell:
+
+```powershell
+$env:KISTE_TOKEN_GITHUB_DEV="..."
+$env:KISTE_TOKEN_HF_DEV="..."
+```
+
+Bash/zsh:
+
+```bash
+export KISTE_TOKEN_GITHUB_DEV="..."
+export KISTE_TOKEN_HF_DEV="..."
+```
+
+The local token store is metadata-only and writes `.kiste/tokens.json`. Raw token
+values are not stored; records use `env://KISTE_TOKEN_NAME` references. Do not
+commit token metadata that reveals private account, project, or expiry details.
+
+GitOps secret files must use the `*.enc.yaml` convention. `kiste secrets scan`
+fails on plaintext Kubernetes Secret manifests, `.env` files, `secret.yaml`,
+`*-secret.yaml`, and unencrypted YAML under `infrastructure/secrets/`.
+
+Image references are parsed and validated before registry inspection. Kiste warns
+on mutable tags such as `latest` and recommends digest pinning for deployment
+inputs. Phase 6 planning does not deploy or pull images automatically.
+
+Dataset providers are metadata-first. Kiste records dataset refs, profiles local
+and DVC files, checks declared token scopes, generates dataset cards, and plans
+exports, but it does not download large datasets automatically.
+
+Phase 8 cloud and Argo CD commands are also safe-by-default. They generate plans,
+reports, and YAML only. They do not provision cloud resources, sync production
+apps, enable pruning, delete clusters, rotate secrets, or auto-merge changes.
+
+## Development
+
+Install dev dependencies:
+
+```bash
+uv sync --group dev
+```
+
+Run checks:
+
+```bash
+uv run pytest -q
+uv run ruff check .
+uv run mypy src/kiste
+```
+
+Publish to PyPI:
+
+1. Configure PyPI Trusted Publishing for this repository with workflow
+   `.github/workflows/pypi-publish.yml` and environment `pypi`.
+2. Push a version tag, for example `v0.8.5`.
+3. The workflow runs checks, builds `dist/`, validates metadata, and publishes
+   through GitHub OIDC. No PyPI API token is required.
+
+Dependency updates:
+
+Dependabot is configured in `.github/dependabot.yml` to update both PyPI
+package versions and workflow/action versions weekly:
+
+- PyPI dependencies: `pyproject.toml` and `uv.lock` through the `uv` ecosystem.
+- Workflows: GitHub Actions used by CI and PyPI publishing.
+
+Python dev tools, provider SDK extras, and GitHub Actions are grouped into
+focused PRs with `pypi`, `uv`, `workflow`, and `github-actions` labels.
+
+Phase 4.5 review reports:
+
+```bash
+kiste review
+kiste review architecture
+kiste review commands
+kiste review data-model
+kiste review security
+kiste review gitops
+kiste review roadmap
+```
+
+These write Markdown reports to `.kiste/review/`.
+
+## Current Limits
+
+Kiste still does not:
+
+- Deploy to Kubernetes
+- Apply Terraform
+- Push to a container registry
+- Download large datasets automatically
+- Provision or delete cloud resources automatically
+- Auto-sync Argo CD production apps with pruning
+- Auto-merge self-improvement changes
+- Commit or push the generated GitOps repo
+- Integrate with real SOPS, age, KMS, or Vault cryptography
+- Rotate secrets or fetch runtime credentials
+
+Phase 4 intentionally produces a GitOps source tree and validates secret hygiene,
+but deployment and production secret backends are later phases.
+
+## License
+
+Kiste uses a split license model:
+
+- Source code is licensed under the Apache License 2.0. See [LICENSE](LICENSE).
+- Documentation, including this README and files under [docs/](docs/), is
+  licensed under Creative Commons Attribution 4.0 International. See
+  [docs/LICENSE.md](docs/LICENSE.md).