cldk 0.1.1__tar.gz

cldk-0.1.1/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 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 [yyyy] [name of copyright owner]
+
+   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.

cldk-0.1.1/PKG-INFO

@@ -0,0 +1,306 @@
+Metadata-Version: 2.1
+Name: cldk
+Version: 0.1.1
+Summary: codellm-devkit: A python library for seamless interation with LLMs.
+License: Apache 2.0
+Author: Rahul Krishna
+Author-email: i.m.ralk@gmail.com
+Requires-Python: >=3.11
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: ipdb (>=0.13.13,<0.14.0)
+Requires-Dist: networkx (>=3.2.1,<4.0.0)
+Requires-Dist: pandas (>=2.2.0,<3.0.0)
+Requires-Dist: pyarrow (>=15.0.0,<16.0.0)
+Requires-Dist: pydantic (>=2.6.1,<3.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: tree-sitter (>=0.22.3,<0.23.0)
+Requires-Dist: tree-sitter-c (>=0.21.0,<0.22.0)
+Requires-Dist: tree-sitter-go (>=0.21.0,<0.22.0)
+Requires-Dist: tree-sitter-java (>=0.21.0,<0.22.0)
+Requires-Dist: tree-sitter-javascript (>=0.21.0,<0.22.0)
+Requires-Dist: tree-sitter-languages (>=1.10.2,<2.0.0)
+Requires-Dist: tree-sitter-python (==0.23.2)
+Requires-Dist: wget (>=3.2,<4.0)
+Description-Content-Type: text/markdown
+
+# CodeLLM-Devkit: A Python library for seamless interaction with CodeLLMs
+
+![image](./docs/assets/cldk.png)
+[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
+
+Codellm-devkit (CLDK) is a multilingual program analysis framework that bridges the gap between traditional static analysis tools and Large Language Models (LLMs) specialized for code (CodeLLMs). Codellm-devkit allows developers to streamline the process of transforming raw code into actionable insights by providing a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs.
+
+Codellm-devkit simplifies the complex process of analyzing codebases that span multiple programming languages, making it easier to extract meaningful insights and drive LLM-based code analysis. `CLDK` achieves this through an open-source Python library that abstracts the intricacies of program analysis and LLM interactions. With this library, developer can streamline the process of transforming raw code into actionable insights by providing a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs.
+
+**The purpose of Codellm-devkit is to enable the development and experimentation of robust analysis pipelines that harness the power of both traditional program analysis tools and CodeLLMs.**
+By providing a consistent and extensible framework, Codellm-devkit aims to reduce the friction associated with multi-language code analysis and ensure compatibility across different analysis tools and LLM platforms.
+
+Codellm-devkit is designed to integrate seamlessly with a variety of popular analysis tools, such as WALA, Tree-sitter, LLVM, and CodeQL, each implemented in different languages. Codellm-devkit acts as a crucial intermediary layer, enabling efficient and consistent communication between these tools and the CodeLLMs.
+
+Codellm-devkit is constantly evolving to include new tools and frameworks, ensuring it remains a versatile solution for code analysis and LLM integration.
+
+Codellm-devkit is:
+
+- **Unified**: Provides a single framework for integrating multiple analysis tools and CodeLLMs, regardless of the programming languages involved.
+- **Extensible**: Designed to support new analysis tools and LLM platforms, making it adaptable to the evolving landscape of code analysis.
+- **Streamlined**: Simplifies the process of transforming raw code into structured, LLM-ready inputs, reducing the overhead typically associated with multi-language analysis.
+
+Codellm-devkit is an ongoing project, developed at IBM Research.
+
+## Contact
+
+For any questions, feedback, or suggestions, please contact the authors:
+
+| Name | Email |
+| ---- | ----- |
+| Rahul Krishna | [i.m.ralk@gmail.com](mailto:i.m.ralk@gmail.com) |
+| Rangeet Pan | [rangeet.pan@ibm.com](mailto:rangeet.pan@gmail.com) |
+| Saurabh Sihna | [sinhas@us.ibm.com](mailto:sinhas@us.ibm.com) |
+## Table of Contents
+
+- [CodeLLM-Devkit: A Python library for seamless interaction with CodeLLMs](#codellm-devkit-a-python-library-for-seamless-interaction-with-codellms)
+  - [Contact](#contact)
+  - [Table of Contents](#table-of-contents)
+  - [Architectural and Design Overview](#architectural-and-design-overview)
+  - [Quick Start: Example Walkthrough](#quick-start-example-walkthrough)
+    - [Prerequisites](#prerequisites)
+    - [Step 1:  Set up an Ollama server](#step-1--set-up-an-ollama-server)
+      - [Pull the latest version of Granite 8b instruct model from ollama](#pull-the-latest-version-of-granite-8b-instruct-model-from-ollama)
+    - [Step 2:  Install CLDK](#step-2--install-cldk)
+    - [Step 3:  Build a code summarization pipeline](#step-3--build-a-code-summarization-pipeline)
+
+## Architectural and Design Overview
+
+Below is a very high-level overview of the architectural of CLDK:
+
+
+```mermaid
+graph TD
+User <--> A[CLDK]
+    A --> 15[Retrieval ‡]
+    A --> 16[Prompting ‡]
+    A[CLDK] <--> B[Languages]
+        B --> C[Java, Python, Go ‡, C ‡, JavaScript ‡, TypeScript ‡, Rust ‡]
+            C --> D[Data Models]
+                D --> 13{Pydantic}
+            13 --> 7            
+            C --> 7{backends}
+                7 <--> 9[WALA]
+                    9 <--> 14[Analysis]
+                7 <--> 10[Tree-sitter] 
+                    10 <--> 14[Analysis]
+                7 <--> 11[LLVM ‡]
+                    11 <--> 14[Analysis]
+                7 <--> 12[CodeQL ‡]
+                    12 <--> 14[Analysis]
+
+    
+
+X[‡ Yet to be implemented]
+```
+
+The user interacts by invoking the CLDK API. The CLDK API is responsible for handling the user requests and delegating them to the appropriate language-specific modules. 
+
+Each language comprises of two key components: data models and backends.
+
+1. **Data Models:** These are high level abstractions that represent the various language constructs and componentes in a structured format using pydantic. This confers a high degree of flexibility and extensibility to the models as well as allowing for easy accees of various data components via a simple dot notation. In addition, the data models are designed to be easily serializable and deserializable, making it easy to store and retrieve data from various sources.
+
+
+2. **Analysis Backends:** These are the components that are responsible for interfacing with the various program analysis tools. The core backends are Treesitter, Javaparse, WALA, LLVM, and CodeQL. The backends are responsible for handling the user requests and delegating them to the appropriate analysis tools. The analysis tools perfrom the requisite analysis and return the results to the user. The user merely calls one of several high-level API functions such as `get_method_body`, `get_method_signature`, `get_call_graph`, etc. and the backend takes care of the rest. 
+
+    Some langugages may have multiple backends. For example, Java has WALA, Javaparser, Treesitter, and CodeQL backends. The user has freedom to choose the backend that best suits their needs. 
+
+We are currently working on implementing the retrieval and prompting components. The retrieval component will be responsible for retrieving the relevant code snippets from the codebase for RAG usecases. The prompting component will be responsible for generating the prompts for the CodeLLMs using popular prompting frameworks such as `PDL`, `Guidance`, or `LMQL`.  
+
+
+## Quick Start: Example Walkthrough
+
+In this section, we will walk through a simple example to demonstrate how to use CLDK. We will:
+
+* Set up a local ollama server to interact with CodeLLMs
+* Build a simple code summarization pipeline for a Java and a Python application.
+
+### Prerequisites
+
+Before we begin, make sure you have the following prerequisites installed:
+
+  * Python 3.11 or later
+  * Ollama v0.3.4 or later
+
+
+### Step 1:  Set up an Ollama server
+
+If don't already have ollama, please download and install it from here: [Ollama](https://ollama.com/download). 
+
+Once you have ollama, start the server and make sure it is running.
+
+If you're on MacOS, Linux, or WSL, you can check to make sure the server is running by running the following command:
+
+```bash
+sudo systemctl status ollama
+```
+
+You should see an output similar to the following:
+
+```bash
+➜ sudo systemctl status ollama
+● ollama.service - Ollama Service
+     Loaded: loaded (/etc/systemd/system/ollama.service; enabled; preset: enabled)
+     Active: active (running) since Sat 2024-08-10 20:39:56 EDT; 17s ago
+   Main PID: 23069 (ollama)
+      Tasks: 19 (limit: 76802)
+     Memory: 1.2G (peak: 1.2G)
+        CPU: 6.745s
+     CGroup: /system.slice/ollama.service
+             └─23069 /usr/local/bin/ollama serve
+```
+
+If not, you may have to start the server manually. You can do this by running the following command:
+
+```bash
+sudo systemctl start ollama
+```
+
+#### Pull the latest version of Granite 8b instruct model from ollama
+
+To pull the latest version of the Granite 8b instruct model from ollama, run the following command:
+
+```bash
+ollama pull granite-code:8b-instruct
+```
+
+Check to make sure the model was successfully pulled by running the following command:
+
+```bash
+ollama run granite-code:8b-instruct 'Write a function to print hello world in python'
+```
+
+The output should be similar to the following:
+
+```
+➜ ollama run granite-code:8b-instruct 'Write a function to print hello world in python'
+
+def say_hello():
+    print("Hello World!")
+```
+
+### Step 2:  Install CLDK
+
+You may install the latest version of CLDK from our GitHub repository:
+
+```python
+pip install git+https://github.com/IBM/codellm-devkit.git
+```
+
+Once CLDK is installed, you can import it into your Python code:
+
+```python
+from cldk import CLDK
+```
+
+### Step 3:  Build a code summarization pipeline
+
+Now that we have set up the ollama server and installed CLDK, we can build a simple code summarization pipeline for a Java application.
+
+1. Let's download a sample Java (apache-commons-cli):
+
+    * Download and unzip the sample Java application:
+        ```bash
+        wget https://github.com/apache/commons-cli/archive/refs/tags/rel/commons-cli-1.7.0.zip -O commons-cli-1.7.0.zip && unzip commons-cli-1.7.0.zip
+        ```
+    * Record the path to the sample Java application:
+        ```bash
+        export JAVA_APP_PATH=/path/to/commons-cli-1.7.0 
+      ```
+
+
+Below is a simple code summarization pipeline for a Java application using CLDK. It does the following things:
+
+* Creates a new instance of the CLDK class (see comment `# (1)`)
+* Creates an analysis object over the Java application (see comment `# (2)`)
+* Iterates over all the files in the project (see comment `# (3)`)
+* Iterates over all the classes in the file (see comment `# (4)`)
+* Iterates over all the methods in the class (see comment `# (5)`)
+* Gets the code body of the method (see comment `# (6)`)
+* Initializes the treesitter utils for the class file content (see comment `# (7)`)
+* Sanitizes the class for analysis (see comment `# (8)`)
+* Formats the instruction for the given focal method and class (see comment `# (9)`)
+* Prompts the local model on Ollama (see comment `# (10)`)
+* Prints the instruction and LLM output (see comment `# (11)`)
+
+```python
+# code_summarization_for_java.py
+
+from cldk import CLDK
+
+
+def format_inst(code, focal_method, focal_class):
+    """
+    Format the instruction for the given focal method and class.
+    """
+    inst = f"Question: Can you write a brief summary for the method `{focal_method}` in the class `{focal_class}` below?\n"
+
+    inst += "\n"
+    inst += f"```{language}\n"
+    inst += code
+    inst += "```" if code.endswith("\n") else "\n```"
+    inst += "\n"
+    return inst
+
+def prompt_ollama(message: str, model_id: str = "granite-code:8b-instruct") -> str:
+    """Prompt local model on Ollama"""
+    response_object = ollama.generate(model=model_id, prompt=message)
+    return response_object["response"]
+
+
+if __name__ == "__main__":
+    # (1) Create a new instance of the CLDK class
+    cldk = CLDK(language="java")
+
+    # (2) Create an analysis object over the java application
+    analysis = cldk.analysis(project_path=os.getenv("JAVA_APP_PATH"))
+
+    # (3) Iterate over all the files in the project
+    for file_path, class_file in analysis.get_symbol_table().items():
+        class_file_path = Path(file_path).absolute().resolve()
+        # (4) Iterate over all the classes in the file
+        for type_name, type_declaration in class_file.type_declarations.items():
+            # (5) Iterate over all the methods in the class
+            for method in type_declaration.callable_declarations.values():
+                
+                # (6) Get code body of the method
+                code_body = class_file_path.read_text()
+                
+                # (7) Initialize the treesitter utils for the class file content
+                tree_sitter_utils = cldk.tree_sitter_utils(source_code=code_body)
+                
+                # (8) Sanitize the class for analysis
+                sanitized_class = tree_sitter_utils.sanitize_focal_class(method.declaration)
+
+                # (9) Format the instruction for the given focal method and class
+                instruction = format_inst(
+                    code=sanitized_class,
+                    focal_method=method.declaration,
+                    focal_class=type_name,
+                )
+
+                # (10) Prompt the local model on Ollama
+                llm_output = prompt_ollama(
+                    message=instruction,
+                    model_id="granite-code:20b-instruct",
+                )
+
+                # (11) Print the instruction and LLM output
+                print(f"Instruction:\n{instruction}")
+                print(f"LLM Output:\n{llm_output}")
+```
+
+### Publication (papers and blogs related to CLDK)
+1. Pan, Rangeet, Myeongsoo Kim, Rahul Krishna, Raju Pavuluri, and Saurabh Sinha. "[Multi-language Unit Test Generation using LLMs.](https://arxiv.org/abs/2409.03093)" arXiv preprint arXiv:2409.03093 (2024).
+2. Pan, Rangeet, Rahul Krishna, Raju Pavuluri, Saurabh Sinha, and Maja Vukovic., "[Simplify your Code LLM solutions using CodeLLM Dev Kit (CLDK).](https://www.linkedin.com/pulse/simplify-your-code-llm-solutions-using-codellm-dev-kit-rangeet-pan-vnnpe/?trackingId=kZ3U6d8GSDCs8S1oApXZgg%3D%3D)", Blog.
+