codeanalyzer-python 0.1.1__py3-none-any.whl

codeanalyzer_python-0.1.1.dist-info/METADATA

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: codeanalyzer-python
+Version: 0.1.1
+Summary: Static Analysis on Python source code using Jedi, CodeQL and Treesitter.
+Author-email: Rahul Krishna <i.m.ralk@gmail.com>
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.12
+Requires-Dist: asteroid>=0.7.0
+Requires-Dist: astor>=0.8.1
+Requires-Dist: jedi>=0.19.2
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: networkx>=3.5
+Requires-Dist: pandas>=2.3.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: requests>=2.32.4
+Requires-Dist: rich>=14.0.0
+Requires-Dist: ruff>=0.12.2
+Requires-Dist: toml>=0.10.2
+Requires-Dist: typer>=0.16.0
+Description-Content-Type: text/markdown
+
+![logo](./docs/assets/logo.png)
+
+Python Static Analysis Backend for CLDK
+
+A comprehensive static analysis tool for Python source code that provides symbol table generation, call graph analysis, and semantic analysis using Jedi, CodeQL, and Tree-sitter.
+
+## Installation
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+### Prerequisites
+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/) installed
+- Python 3.12 or higher. You can use `uv` to install Python if it's not already installed:
+  ```bash
+  uv python install 3.12
+  ```
+
+#### System Package Requirements
+
+The tool creates virtual environments internally using Python's built-in `venv` module.
+
+**Ubuntu/Debian systems:**
+```bash
+sudo apt update
+sudo apt install python3.12-venv python3-dev build-essential
+```
+
+**Fedora/RHEL/CentOS systems:**
+```bash
+sudo dnf group install "Development Tools"
+sudo dnf install python3-pip python3-venv python3-devel
+```
+or on older versions:
+```bash
+sudo yum groupinstall "Development Tools"
+sudo yum install python3-pip python3-venv python3-devel
+```
+
+**macOS systems:**
+```bash
+# Install Xcode Command Line Tools (for compilation)
+xcode-select --install
+
+# If using Homebrew Python (recommended)
+brew install python@3.12
+
+# If using pyenv (popular Python version manager)
+# First ensure pyenv is properly installed and configured
+pyenv install 3.12.0  # or latest 3.12.x version
+pyenv global 3.12.0   # or pyenv local 3.12.0 for project-specific
+
+# If using system Python, you may need to install certificates
+/Applications/Python\ 3.12/Install\ Certificates.command
+```
+
+> **Note:** These packages are required as the tool uses Python's built-in `venv` module to create isolated environments for analysis.
+
+### Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/codellm-devkit/codeanalyzer-python
+   cd codeanalyzer-python
+   ```
+
+2. Install dependencies using uv:
+   ```bash
+   uv sync --all-groups
+   ```
+   This will install all dependencies including development and test dependencies.
+
+## Usage
+
+The codeanalyzer provides a command-line interface for performing static analysis on Python projects.
+
+### Basic Usage
+
+```bash
+uv run codeanalyzer --input /path/to/python/project
+```
+
+### Command Line Options
+
+To view the available options and commands, run `uv run codeanalyzer --help`. You should see output similar to the following:
+
+```bash
+❯ uv run codeanalyzer --help
+
+ Usage: codeanalyzer [OPTIONS] COMMAND [ARGS]...
+
+ Static Analysis on Python source code using Jedi, CodeQL and Tree sitter.
+
+
+╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ *  --input           -i                  PATH     Path to the project root directory. [default: None] [required]   │
+│    --output          -o                  PATH     Output directory for artifacts. [default: None]                  │
+│    --analysis-level  -a                  INTEGER  1: symbol table, 2: call graph. [default: 1]                     │
+│    --codeql              --no-codeql              Enable CodeQL-based analysis. [default: no-codeql]               │
+│    --eager               --lazy                   Enable eager or lazy analysis. Defaults to lazy. [default: lazy] │
+│    --cache-dir       -c                  PATH     Directory to store analysis cache. [default: None]               │
+│    --clear-cache         --keep-cache             Clear cache after analysis. [default: clear-cache]               │
+│                      -v                  INTEGER  Increase verbosity: -v, -vv, -vvv [default: 0]                   │
+│    --help                                         Show this message and exit.                                      │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+### Examples
+
+1. **Basic analysis with symbol table:**
+   ```bash
+   uv run codeanalyzer --input ./my-python-project
+   ```
+
+   This will print the symbol table to stdout in JSON format to the standard output. If you want to save the output, you can use the `--output` option.
+
+   ```bash
+   uv run codeanalyzer --input ./my-python-project --output /path/to/analysis-results
+   ```
+
+   Now, you can find the analysis results in `analysis.json` in the specified directory.
+
+2. **Toggle analysis levels with `--analysis-level`:**
+   ```bash
+   uv run codeanalyzer --input ./my-python-project --analysis-level 1 # Symbol table only
+   ```
+   Call graph analysis can be enabled by setting the level to `2`:
+   ```bash
+   uv run codeanalyzer --input ./my-python-project --analysis-level 2 # Symbol table + Call graph
+   ```
+   ***Note: The `--analysis-level=2` is not yet implemented in this version.***
+
+3. **Analysis with CodeQL enabled:**
+   ```bash
+   uv run codeanalyzer --input ./my-python-project --codeql
+   ```
+    This will perform CodeQL-based analysis in addition to the standard symbol table generation. 
+    
+    ***Note: Not yet fully implemented. Please refrain from using this option until further notice.***
+
+4. **Eager analysis with custom cache directory:**
+   ```bash
+   uv run codeanalyzer --input ./my-python-project --eager --cache-dir /path/to/custom-cache
+   ```
+    This will rebuild the analysis cache at every run and store it in `/path/to/custom-cache/.codeanalyzer`. The cache will be cleared by default after analysis unless you specify `--keep-cache`.
+
+    If you provide --cache-dir, the cache will be stored in that directory. If not specified, it defaults to `.codeanalyzer` in the current working directory (`$PWD`).
+
+5. **Quiet mode (minimal output):**
+   ```bash
+   uv run codeanalyzer --input /path/to/my-python-project --quiet
+   ```
+
+### Output
+
+By default, analysis results are printed to stdout in JSON format. When using the `--output` option, results are saved to `analysis.json` in the specified directory.
+
+## Development
+
+### Running Tests
+
+```bash
+uv run pytest --pspec -s 
+```
+
+### Development Dependencies
+
+The project includes additional dependency groups for development:
+
+- **test**: pytest and related testing tools
+- **dev**: development tools like ipdb
+
+Install all groups with:
+```bash
+uv sync --all-groups
+```

codeanalyzer_python-0.1.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+codeanalyzer_python-0.1.1.dist-info/METADATA,sha256=tSMiuaj8MK9W1k-ZS1wVGXMd2R8QURWtWgF_6qGQxqY,7394
+codeanalyzer_python-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+codeanalyzer_python-0.1.1.dist-info/entry_points.txt,sha256=eUrB7Jq5Oav6RblMX_RYfVLSw_h15NbzC3fNSnGsPuM,59
+codeanalyzer_python-0.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+codeanalyzer_python-0.1.1.dist-info/licenses/NOTICE,sha256=YU0Z9NDWqKY-2jfFcbxeZ6fbnzz0oZeKmnUcO8a-bcQ,901
+codeanalyzer_python-0.1.1.dist-info/RECORD,,

codeanalyzer_python-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

codeanalyzer_python-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codeanalyzer = codeanalyzer.__main__:app

codeanalyzer_python-0.1.1.dist-info/licenses/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.

codeanalyzer_python-0.1.1.dist-info/licenses/NOTICE

@@ -0,0 +1,18 @@
+This project includes components that are subject to additional license terms.
+
+--- CodeQL License Notice ---
+
+This project uses CodeQL, a product of GitHub, Inc.
+
+CodeQL is licensed under the GitHub CodeQL Terms and Conditions:
+https://securitylab.github.com/tools/codeql/license
+
+Unless you have a separate agreement with GitHub, you may only use CodeQL under one of the following conditions:
+
+- You are an individual using CodeQL for **personal, non-commercial research**.
+- You are using CodeQL as part of an **open source project** hosted on GitHub.com, and your project is not directed by a for-profit company or intended for commercial use.
+
+Any other use of CodeQL, including its use on proprietary code or in closed-source or commercial projects, requires a separate commercial license from GitHub.
+
+You can view the full CodeQL license at:
+https://github.com/github/codeql/blob/main/LICENSE