lvkit 0.1.0__tar.gz

lvkit-0.1.0/.gitignore

@@ -0,0 +1,103 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.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/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# LabVIEW files (keep these tracked for testing)
+# *.vi
+# *.lvproj
+
+# Sample LabVIEW projects (external test data)
+samples/
+
+# Model files
+models/
+*.gguf
+
+# Test outputs
+outputs/
+.tmp/
+
+# Project-local resolution store. lvkit ships cleanroom — anything in .lvkit/
+# may be derived from licensed LabVIEW sources and must NEVER be committed
+# to lvkit's own repo. (Downstream users decide their own .lvkit/ gitignore
+# policy in their own projects.)
+.lvkit/
+
+# Large binary docs and proprietary references.
+# lvkit is cleanroom — NI's reference manual is not redistributable
+# from this repo. Resolution skills look up function info via web
+# search against ni.com/docs instead.
+docs/*.pdf
+docs/labview_ref_manual.txt
+docs/labview_programming_reference_manual*

lvkit-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.4
+    hooks:
+      - id: ruff
+        args: [--fix]
+
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: python3 -m pyright src/lvkit/
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: pytest
+        name: pytest
+        entry: python3 -m pytest -q
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: sync-skills
+        name: sync skill templates
+        entry: scripts/sync_skills.sh
+        language: system
+        # Trigger on any SKILL.md change under either tree. The script
+        # discovers skills dynamically from src/lvkit/skill_templates/ —
+        # adding a new packaged skill requires no hook-config change.
+        files: '^(\.claude/skills/.*/SKILL\.md|src/lvkit/skill_templates/claude/.*/SKILL\.md)$'
+        pass_filenames: false

lvkit-0.1.0/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 Support. 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 support.
+
+   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 Ryan Friedman
+
+   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.

lvkit-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: lvkit
+Version: 0.1.0
+Summary: Understand and convert LabVIEW VIs to Python without a LabVIEW license
+Project-URL: Repository, https://github.com/pragmatest-dev/lvkit
+Project-URL: Issues, https://github.com/pragmatest-dev/lvkit/issues
+Author: Pragmatest
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ast,code-generation,labview,mcp,ni,static-analysis,vi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Software Development :: Disassemblers
+Requires-Python: >=3.10
+Requires-Dist: mcp>=0.9.0
+Requires-Dist: networkx
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pylabview
+Description-Content-Type: text/markdown
+
+# lvkit
+
+Read, document, diff, and convert LabVIEW VI files — no LabVIEW license required.
+
+lvkit parses `.vi`, `.ctl`, `.lvclass`, and `.lvlib` files directly into queryable dependency and dataflow graphs. Use it to document code, track changes in CI, feed VI structure to AI tools, or generate equivalent Python.
+
+## Contents
+
+- [Quick Start](#quick-start)
+- [What you can do with it](#what-you-can-do-with-it)
+- [CLI Commands](#cli-commands)
+- [How it works](#how-it-works)
+- [AI and IDE integration](#ai-and-ide-integration)
+- [Cleanroom approach](#cleanroom-approach)
+- [Development](#development)
+
+## Quick Start
+
+```bash
+pip install lvkit
+lvkit init --skills all       # create .lvkit/ + install Claude Code and Copilot skills
+```
+
+* Use `--skills claude` or `--skills copilot` to install for one AI agent only.
+* Use `lvkit init` alone if you don't want any AI agent skills installed.
+
+## What you can do with it
+
+### Describe what a VI does
+Get a human-readable signature, inputs/outputs, operations, and control flow — without opening LabVIEW. Never requires primitive or vi.lib mappings.
+
+```
+lvkit describe <path-to.vi> [--search-path <libraries/>] [--chart]
+```
+
+`--chart` adds a Mermaid flowchart of the block diagram.
+
+### Generate documentation
+Cross-referenced HTML docs for a `.vi`, `.lvlib`, or `.lvclass` — inputs, outputs, operations, wiring diagrams.
+
+```
+lvkit docs <input-path> <output-dir> [--search-path <libraries/>]
+```
+
+### Diff two versions of a VI
+See what changed between two `.vi` files — added/removed terminals, changed operations, rewired connections. Useful in code review and CI.
+
+```
+lvkit diff <vi-a> <vi-b> [--long]
+```
+
+`--long` gives a structured change report instead of a unified diff.
+
+### Generate Python
+Convert a VI, library, or class to Python. Deterministic — same VI in, same Python out, every run, no LLM involved.
+
+```
+lvkit generate <input-path> -o <output-dir> [--search-path <libraries>] [--placeholder-on-unresolved]
+```
+
+`--placeholder-on-unresolved` lets the build succeed when mappings are missing — unresolved calls become inline `raise PrimitiveResolutionNeeded(...)` in the output so you can track them down at runtime.
+
+Coverage is incremental — see [Cleanroom approach](#cleanroom-approach) for what that means in practice.
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `lvkit describe` | Human-readable VI description with signature and operations |
+| `lvkit docs` | Generate cross-referenced HTML documentation |
+| `lvkit diff` | Compare two VI versions — terminals, operations, wiring |
+| `lvkit visualize` | Mermaid flowchart or interactive dependency graph |
+| `lvkit generate` | Generate Python from a VI, library, or class |
+| `lvkit structure` | Inspect `.lvlib` or `.lvclass` structure |
+| `lvkit init` | Create `.lvkit/` resolution store; install AI editor skills |
+| `lvkit mcp` | Start the MCP server for IDE integration |
+
+`lvkit visualize --format interactive` requires `pip install pyvis`. All other commands work on a bare `pip install lvkit`.
+
+## How it works
+
+lvkit reads VI binaries directly — no LabVIEW installation required. The pipeline has three stages:
+
+1. **Parse** — the VI binary is extracted to XML (via [pylabview](https://github.com/mefistotelis/pylabview)), then parsed into a typed representation of the block diagram: nodes, wires, constants, types, and front panel terminals.
+
+2. **Graph** — all loaded VIs are linked into a graph that captures two things: the dependency tree (which VIs call which) and the dataflow within each VI (how data moves between operations). This is what `describe`, `docs`, `diff`, and `visualize` query — no semantic mappings needed.
+
+3. **Generate** — the graph is walked deterministically to produce Python source, HTML documentation, or flowcharts. Code generation is pure AST construction: same VI in, same output every run, no LLM.
+
+See [`docs/graph-reference.md`](docs/graph-reference.md) for the full graph type reference.
+
+## AI and IDE integration
+
+The CLI works standalone from any terminal or CI script. For deeper IDE integration, lvkit ships two optional layers.
+
+**AI editor skills** — install lvkit's built-in workflows into Claude Code or Copilot so your AI can describe VIs, convert them, and resolve unknowns without you writing prompts. All five workflows call the CLI under the hood — no MCP server required.
+
+```bash
+lvkit init --skills claude    # installs .claude/skills/lvkit-*
+lvkit init --skills copilot   # installs .github/prompts/ + router instruction
+lvkit init --skills all       # both
+```
+
+Five workflows ship: `lvkit-describe`, `lvkit-convert`, `lvkit-resolve-primitive`, `lvkit-resolve-vilib`, `lvkit-idiomatic`.
+
+**MCP server** — for interactive IDE sessions where your AI needs to load a graph, walk wires, and ask follow-up questions across multiple VIs:
+
+```json
+{
+  "mcpServers": {
+    "lvkit": { "command": "uvx", "args": ["--from", "lvkit", "lvkit-mcp"] }
+  }
+}
+```
+
+| Tool | Description |
+|------|-------------|
+| `load` | Load VI into the in-memory graph |
+| `list_loaded` | List loaded VIs |
+| `get_context` | Full VI context: inputs, outputs, operations, wires |
+| `generate_ast_code` | Generate Python from a loaded VI |
+| `describe` | Human-readable VI description |
+| `get_operations` | List operations in a VI |
+| `get_dataflow` | Show wire connections |
+| `get_structure` | Inspect a structure node (loop, case, sequence) |
+| `get_constants` | List constant values |
+| `analyze` | Parse and describe VI structure (stateless) |
+| `generate_documents` | Generate HTML docs for VIs/libraries (stateless) |
+| `generate_python` | Generate Python from a VI (stateless) |
+
+## Cleanroom approach
+
+lvkit has no access to LabVIEW source code or runtime. LabVIEW's built-in primitives and standard library VIs are **semantically replaced**: each operation is mapped to an equivalent Python implementation in JSON data files (`src/lvkit/data/primitives.json`, `src/lvkit/data/vilib/`). These mappings are built from published documentation and observed behavior.
+
+Coverage is incremental. When `lvkit generate` encounters an unmapped primitive or vi.lib VI, it raises an error with diagnostic context so the mapping can be added. `describe`, `docs`, `diff`, and `visualize` are unaffected — they work from the graph, not the semantic mappings.
+
+### Project-local resolution store (`.lvkit/`)
+
+If you have a LabVIEW license, you can supplement the bundled mappings with a `.lvkit/` directory derived from your own install. lvkit reads `.lvkit/` first and falls back to its bundled data. The skills installed by `lvkit init` detect whether you're a lvkit maintainer or a downstream user and write mappings to the right destination.
+
+When `lvkit generate` hits an unknown, you have two options:
+
+1. **Resolve up front** — install the resolve skills (`lvkit init --skills claude`) and let your AI editor write the mapping into `.lvkit/`.
+2. **Defer to runtime** — pass `--placeholder-on-unresolved`. lvkit emits an inline `raise PrimitiveResolutionNeeded(...)` in the generated Python with full diagnostic context. The build succeeds; runtime fails at the unresolved call.
+
+## Development
+
+```bash
+uv sync
+pytest
+ruff check .
+python -m pyright src/
+```
+
+See [`CLAUDE.md`](CLAUDE.md) for contributor workflow, code style, and how to add primitive or vi.lib mappings.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).
+
+## Further reading
+
+- [`docs/graph-reference.md`](docs/graph-reference.md) — graph type reference (nodes, VIContext, operations, wires)
+- [`docs/vi-xml-reference.md`](docs/vi-xml-reference.md) — pylabview XML format reference
+- [`docs/highlight-reel.md`](docs/highlight-reel.md) — design narrative and architecture decisions
+- [`docs/demo-script.md`](docs/demo-script.md) — 30-minute demo script / tutorial
+- [pylabview](https://github.com/mefistotelis/pylabview) — the VI binary parser lvkit builds on