cmake2chat 0.1.0a0__py2.py3-none-any.whl

cmake2chat-0.1.0a0.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: cmake2chat
+Version: 0.1.0a0
+Summary: Scans your CMake project directory, builds a tree view of the codebase, and exports the tree view, the paths of all `CMakeLists.txt` files along with their contents to an OpenAI Chat Completions-compatible JSON.
+Author-email: Jifeng Wu <jifengwu2k@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jifengwu2k/cmake2chat
+Project-URL: Bug Tracker, https://github.com/jifengwu2k/cmake2chat/issues
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=2
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: build-filesystem-trie
+Requires-Dist: cowlist
+Dynamic: license-file
+
+# `cmake2chat`
+
+Lost in a huge CMake project? Wish an LLM could just "see" the codebase structure and all build rules? Now they can!
+
+## What's This?
+
+`cmake2chat` scans your CMake project directory, builds a tree view of the codebase, and exports the tree view, the paths of all `CMakeLists.txt` files along with their contents to an OpenAI Chat Completions-compatible JSON.
+
+### Typical Use Cases
+
+- Instant overview: Give an LLM a complete picture of your project's structure (files, folders) plus CMake build logic at every level.
+- Build-system-powered Q&A: Ask questions like "What libraries does this project build?", "Where is the executable defined?", or "What targets/flags are set in this module?" and get relevant, context-based answers!
+- AI onboarding: Drop into a new CMake project and let an LLM guide you using actual high-level structure and build scripts, not just guesses.
+- No manual plumbing: Skip hours of clicking/repeating `find .`, opening dozens of files, or pasting snippets piecemeal. Feed the AI the *whole map* and let it answer or advise precisely.
+
+## Install
+
+```bash
+pip install cmake2chat
+```
+
+## Example
+
+Suppose you have the following CMake project directory structure:
+
+```
+- my_project/
+  - CMakeLists.txt
+  - src/
+    - CMakeLists.txt
+    - main.cpp
+  - lib/
+    - CMakeLists.txt
+```
+
+To generate an OpenAI Chat Completions-compatible JSON describing your project, simply run:
+
+```bash
+python -m cmake2chat my_project -o my_project.json
+```
+
+An example of the beginning of the output might look like:
+
+```json
+[
+  {
+    "role": "user",
+    "content": "- my_project/\n  - CMakeLists.txt\n  - src/\n    - CMakeLists.txt\n    - main.cpp\n  - lib/\n    - CMakeLists.txt"
+  },
+  {
+    "role": "user",
+    "content": "CMakeLists.txt"
+  },
+  {
+    "role": "user",
+    "content": "# Top-level build logic goes here\ncmake_minimum_required(VERSION 3.10)\nproject(MyProject)\n..."
+  },
+  {
+    "role": "user",
+    "content": "src/CMakeLists.txt"
+  },
+  {
+    "role": "user",
+    "content": "# Build logic for src directory\nadd_executable(main main.cpp)\n..."
+  }
+]
+```
+
+You can now use this JSON directly as input to an LLM API for a powerful, context-aware understanding of your CMake project!
+
+## How it works
+
+- **Scan**: Recursively walks your project directory.
+- **Map**: Extracts the structure (files & folders) as a tree.
+- **Collect**: For each `CMakeLists.txt`, grabs its path and full content.
+- **Export**: Outputs everything as an OpenAI Chat Completions-compatible JSON.
+
+## Contributing
+
+Contributions are welcome! Please submit pull requests or open issues on the GitHub repository.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

cmake2chat-0.1.0a0.dist-info/RECORD

@@ -0,0 +1,6 @@
+cmake2chat.py,sha256=63ZxPlgMOdJ0AZJcnYf-Jb6-xdmzn3wW3JQuATJ74Hg,2952
+cmake2chat-0.1.0a0.dist-info/licenses/LICENSE,sha256=hvfX-ADssuMYgrXDUAjMMut4l8W3meA31ZAYfpdlJKY,1066
+cmake2chat-0.1.0a0.dist-info/METADATA,sha256=60H5zPMgGsgzRUwMasusM3Hb2532z6Eb8aCziGKyDlI,3498
+cmake2chat-0.1.0a0.dist-info/WHEEL,sha256=Q6xS052dXadQWXcEVKSI037R6NoyqhUlJ5BcYz2iMP4,110
+cmake2chat-0.1.0a0.dist-info/top_level.txt,sha256=v7faZZAJmfj58H-gjMj5LHIKR6vm3d5a9D54u7wOnbs,11
+cmake2chat-0.1.0a0.dist-info/RECORD,,

cmake2chat-0.1.0a0.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

cmake2chat-0.1.0a0.dist-info/licenses/LICENSE

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

cmake2chat-0.1.0a0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cmake2chat

cmake2chat.py

@@ -0,0 +1,90 @@
+# Copyright (c) 2026 Jifeng Wu
+# Licensed under the MIT License. See LICENSE file in the project root for full license information.
+import argparse
+import codecs
+import json
+import os.path
+import sys
+
+from build_filesystem_trie import (
+    build_filesystem_trie,
+    iterate_relative_path_components_is_dir_tuples
+)
+from cowlist import COWList
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('path', help='Path to cmake project root')
+    parser.add_argument('-o', '--output', default='-', help='Output JSON file (default: - for stdout)')
+    parser.add_argument('--recurse-dotted', action='store_true', help='Include hidden files/directories')
+    args = parser.parse_args()
+
+    prefix, trie = build_filesystem_trie(args.path, recurse_dotted=args.recurse_dotted)
+
+    cmake_files_json = [
+        {'role': 'user', 'content': filesystem_trie_to_filesystem_tree_view(trie)}
+    ]
+
+    for (
+        cmakelists_path_components,
+        cmakelists_content
+    ) in find_cmakelists_paths_and_contents(prefix, trie, COWList((trie.value,))):
+        cmake_files_json.append(
+            {'role': 'user', 'content': os.path.join(*cmakelists_path_components)}
+        )
+        cmake_files_json.append(
+            {'role': 'user', 'content': cmakelists_content}
+        )
+
+    if args.output != '-':
+        with codecs.open(args.output, 'w', encoding='utf-8') as f:
+            json.dump(cmake_files_json, f, indent=2)
+            f.write('\n')
+    else:
+        json.dump(cmake_files_json, sys.stdout, indent=2)
+        sys.stdout.write('\n')
+
+
+def filesystem_trie_to_filesystem_tree_view(
+        filesystem_trie,
+):
+    # type: (...) -> str
+    lines = []
+    for relative_path_components, is_dir in iterate_relative_path_components_is_dir_tuples(
+        filesystem_trie
+    ):
+        lines.append(
+            '%s- %s%s' % (
+                '  ' * (len(relative_path_components) - 1),
+                relative_path_components[-1],
+                '/' if is_dir else '',
+            )
+        )
+    return '\n'.join(lines)
+
+
+def find_cmakelists_paths_and_contents(prefix, trie, relative_path_components):
+    """
+    Yield (relative_path_components, file_contents) 
+    for every CMakeLists.txt under prefix.
+    relative_path_components is relative to prefix.
+    """
+    # If this is a file named CMakeLists.txt
+    if trie.is_end and trie.value == 'CMakeLists.txt':
+        path = os.path.join(*prefix.extend(relative_path_components))
+        with codecs.open(path, 'r', encoding='utf-8') as f:
+            yield relative_path_components, f.read()
+    # If this is a directory, search children:
+    elif trie.children:
+        for child_name, child in trie.children.items():
+            for _ in find_cmakelists_paths_and_contents(
+                prefix,
+                child,
+                relative_path_components.append(child_name)
+            ):
+                yield _
+
+
+if __name__ == '__main__':
+    main()