ai-cr 0.1.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

ai_code_review/report_struct.py

@@ -0,0 +1,108 @@
+import json
+import logging
+from dataclasses import dataclass, field, asdict
+from datetime import datetime
+from enum import StrEnum
+
+import microcore as mc
+
+from .constants import JSON_REPORT_FILE_NAME
+from .project_config import ProjectConfig
+from .utils import syntax_hint
+
+
+@dataclass
+class Issue:
+    @dataclass
+    class AffectedCode:
+        start_line: int = field()
+        end_line: int | None = field(default=None)
+        file: str = field(default="")
+        proposal: str = field(default="")
+        affected_code: str = field(default="")
+
+        @property
+        def syntax_hint(self) -> str:
+            return syntax_hint(self.file)
+
+    id: str = field()
+    title: str = field()
+    details: str = field(default="")
+    severity: int | None = field(default=None)
+    confidence: int | None = field(default=None)
+    tags: list[str] = field(default_factory=list)
+    file: str = field(default="")
+    affected_lines: list[AffectedCode] = field(default_factory=list)
+
+    def __post_init__(self):
+        self.affected_lines = [
+            Issue.AffectedCode(**dict(file=self.file) | i)
+            for i in self.affected_lines
+        ]
+
+    def github_code_link(self, github_env: dict) -> str:
+        url = (
+            f"https://github.com/{github_env['github_repo']}"
+            f"/blob/{github_env['github_pr_sha_or_branch']}"
+            f"/{self.file}"
+        )
+        if self.affected_lines:
+            url += f"#L{self.affected_lines[0].start_line}"
+            if self.affected_lines[0].end_line:
+                url += f"-L{self.affected_lines[0].end_line}"
+        return url
+
+
+@dataclass
+class Report:
+    class Format(StrEnum):
+        MARKDOWN = "md"
+
+    issues: dict = field(default_factory=dict)
+    summary: str = field(default="")
+    number_of_processed_files: int = field(default=0)
+    total_issues: int = field(init=False)
+    created_at: str = field(default_factory=lambda: datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
+    model: str = field(default_factory=lambda: mc.config().MODEL)
+
+    @property
+    def plain_issues(self):
+        return [
+            issue
+            for file, issues in self.issues.items()
+            for issue in issues
+        ]
+
+    def __post_init__(self):
+        issue_id: int = 0
+        for file in self.issues.keys():
+            self.issues[file] = [
+                Issue(
+                    **{
+                        "id": (issue_id := issue_id + 1),
+                        "file": file,
+                    } | issue
+                )
+                for issue in self.issues[file]
+            ]
+        self.total_issues = issue_id
+
+    def save(self, file_name: str = ""):
+        file_name = file_name or JSON_REPORT_FILE_NAME
+        with open(file_name, "w") as f:
+            json.dump(asdict(self), f, indent=4)
+        logging.info(f"Report saved to {mc.utils.file_link(file_name)}")
+
+    @staticmethod
+    def load(file_name: str = ""):
+        with open(file_name or JSON_REPORT_FILE_NAME, "r") as f:
+            data = json.load(f)
+        data.pop("total_issues", None)
+        return Report(**data)
+
+    def render(
+        self, cfg: ProjectConfig = None, format: Format = Format.MARKDOWN
+    ) -> str:
+        cfg = cfg or ProjectConfig.load()
+        template = getattr(cfg, f"report_template_{format}")
+        return mc.prompt(template, report=self, **cfg.prompt_vars)

ai_code_review/utils.py

@@ -0,0 +1,75 @@
+from pathlib import Path
+
+_EXT_TO_HINT: dict[str, str] = {
+    # scripting & languages
+    ".py": "python",
+    ".js": "javascript",
+    ".ts": "typescript",
+    ".java": "java",
+    ".c": "c",
+    ".cpp": "cpp",
+    ".cc": "cpp",
+    ".cxx": "cpp",
+    ".h": "cpp",
+    ".hpp": "cpp",
+    ".cs": "csharp",
+    ".rb": "ruby",
+    ".go": "go",
+    ".rs": "rust",
+    ".swift": "swift",
+    ".kt": "kotlin",
+    ".scala": "scala",
+    ".dart": "dart",
+    ".php": "php",
+    ".pl": "perl",
+    ".pm": "perl",
+    ".lua": "lua",
+    # web & markup
+    ".html": "html",
+    ".htm": "html",
+    ".css": "css",
+    ".scss": "scss",
+    ".less": "less",
+    ".json": "json",
+    ".xml": "xml",
+    ".yaml": "yaml",
+    ".yml": "yaml",
+    ".toml": "toml",
+    ".ini": "ini",
+    ".csv": "csv",
+    ".md": "markdown",
+    ".rst": "rest",
+    # shell & config
+    ".sh": "bash",
+    ".bash": "bash",
+    ".zsh": "bash",
+    ".fish": "bash",
+    ".ps1": "powershell",
+    ".dockerfile": "dockerfile",
+    # build & CI
+    ".makefile": "makefile",
+    ".mk": "makefile",
+    "CMakeLists.txt": "cmake",
+    "Dockerfile": "dockerfile",
+    ".gradle": "groovy",
+    ".travis.yml": "yaml",
+    # data & queries
+    ".sql": "sql",
+    ".graphql": "graphql",
+    ".proto": "protobuf",
+    ".yara": "yara",
+}
+
+
+def syntax_hint(file_name: str) -> str:
+    """
+    Get the syntax hint for a file based on its extension.
+    """
+    p = Path(file_name)
+    ext = p.suffix.lower()
+    if not ext:
+        name = p.name.lower()
+        if name == "dockerfile":
+            return "dockerfile"
+        return ""
+    return _EXT_TO_HINT.get(ext, ext.lstrip("."))

ai_cr-0.4.2.dist-info/METADATA

@@ -0,0 +1,161 @@
+Metadata-Version: 2.3
+Name: ai-cr
+Version: 0.4.2
+Summary: LLM-agnostic GitHub AI Code Review Tool with integration to GitHub actions
+License: MIT
+Keywords: ai,coding,assistant,llm,code review,github,automation,devops,developer tools,github actions,workflows
+Author: Nayjest
+Author-email: mail@vitaliy.in
+Requires-Python: >=3.11,<4.0
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Requires-Dist: GitPython (>=3.1.44,<4.0.0)
+Requires-Dist: ai-microcore (>=4.0.0.dev11,<5.0.0)
+Requires-Dist: anthropic (>=0.49.0,<0.50.0)
+Requires-Dist: async-typer (>=0.1.8,<0.2.0)
+Requires-Dist: google-generativeai (>=0.8.5,<0.9.0)
+Requires-Dist: typer (>=0.9.4,<0.10.0)
+Requires-Dist: unidiff (>=0.7.5,<0.8.0)
+Project-URL: Homepage, https://github.com/Nayjest/github-ai-code-review
+Project-URL: Repository, https://github.com/Nayjest/github-ai-code-review
+Description-Content-Type: text/markdown
+
+<p align="right">
+<a href="https://pypi.org/project/ai-code-review/" target="_blank"><img src="https://badge.fury.io/py/ai-code-review.svg" alt="PYPI Release"></a>
+<a href="https://github.com/Nayjest/ai-code-review/actions/workflows/code-style.yml" target="_blank"><img src="https://github.com/Nayjest/ai-code-review/actions/workflows/code-style.yml/badge.svg" alt="Pylint"></a>
+<a href="https://github.com/Nayjest/ai-code-review/actions/workflows/tests.yml" target="_blank"><img src="https://github.com/Nayjest/ai-code-review/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
+<a href="https://github.com/Nayjest/ai-code-review/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?label=license&message=MIT&color=d08aff" alt="License"></a>
+</p>
+
+# 🤖 AI Code Review Tool
+
+An AI-powered GitHub code review tool that uses LLMs to detect high-confidence, high-impact issues—such as security vulnerabilities, bugs, and maintainability concerns.
+
+## ✨ Features
+
+- Automatically reviews pull requests via GitHub Actions
+- Focuses on critical issues (e.g., bugs, security risks, design flaws)
+- Posts review results as a comment on your PR
+- Can be used locally; works with both local and remote Git repositories
+- Optional, fun AI-generated code awards 🏆
+- Easily configurable via [`.ai-code-review.toml`](ai_code_review/.ai-code-review.toml)
+- Extremely fast, parallel LLM usage
+- Model-agnostic (OpenAI, Anthropic, Google, local PyTorch inference, etc.)
+
+See code review in action: [example](https://github.com/Nayjest/github-ai-code-review/pull/28#issuecomment-2891611236)
+
+## 🚀 Quickstart
+
+### 1. Review Pull Requests via GitHub Actions
+
+Create a `.github/workflows/ai-code-review.yml` file:
+
+```yaml
+name: AI Code Review
+on: { pull_request: { types: [opened, synchronize, reopened] } }
+jobs:
+  review:
+    runs-on: ubuntu-latest
+    permissions: { contents: read, pull-requests: write } # 'write' for leaving the summary comment
+    steps:
+    - uses: actions/checkout@v4
+      with: { fetch-depth: 0 }
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with: { python-version: "3.13" }
+    - name: Install AI Code Review tool
+      run: pip install ai-code-review==0.4.1
+    - name: Run AI code review
+      env:
+        LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
+        LLM_API_TYPE: openai
+        MODEL: "gpt-4.1"
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        ai-code-review
+        ai-code-review github-comment --token ${{ secrets.GITHUB_TOKEN }}
+    - uses: actions/upload-artifact@v4
+      with:
+        name: ai-code-review-results
+        path: |
+          code-review-report.txt
+          code-review-report.json
+```
+
+> ⚠️ Make sure to add `LLM_API_KEY` to your repository’s GitHub secrets.
+
+💪 Done!  
+PRs to your repository will now receive AI code reviews automatically. ✨
+
+### 2. Run Locally
+
+Install and run:
+
+```bash
+# Prerequisites: Python 3.11+
+pip install ai-code-review
+
+# One-time setup using interactive wizard (saves configuration in ~/.env.ai-code-review)
+ai-code-review setup
+
+# Run review on committed changes in current branch vs main
+ai-code-review
+```
+
+To review a remote repository:
+
+```bash
+ai-code-review remote --url https://github.com/owner/repo --branch feature-branch
+```
+
+## 🔧 Configuration
+
+Change behavior via `.ai-code-review.toml`:
+
+- Prompt templates, filtering and post-processing using Python code snippets
+- Tagging, severity, and confidence settings
+- Custom AI awards for developer brilliance
+- Output customization
+
+You can override the default config by placing `.ai-code-review.toml` in your repo root.
+
+
+See default configuration [here](ai_code_review/.ai-code-review.toml).
+
+## 💻 Development Setup
+
+Install dependencies:
+
+```bash
+make install
+```
+
+Format code and check style:
+
+```bash
+make black
+make cs
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+## 🤝 Contributing
+
+We ❤️ contributions! See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## 📝 License
+
+Licensed under the [MIT License](LICENSE).
+
+© 2025 [Vitalii Stepanenko](mailto:mail@vitaliy.in)
+

ai_cr-0.4.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+ai_code_review/.ai-code-review.toml,sha256=MovvzoXNuaV8XsJfwYYde7oT69NNfnN_P_vRvG-dBvk,10332
+ai_code_review/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_code_review/bootstrap.py,sha256=vhAWjrfhkyyA504YusXhBlndsXd_bg2RP9hQbfnvM1M,1280
+ai_code_review/cli.py,sha256=lulkEEUmQ1Fn3j3aQ0ZXc6aPHPcQDsr4YqA_C6gFFH4,3409
+ai_code_review/constants.py,sha256=K9mNxTq9seTG3aVm__3r1lXb5oCOQjH24Cl3hfX9FsE,281
+ai_code_review/core.py,sha256=LhstEanCpMD0rVEYja0EQ4GuwB47RXGJJNOTkD6WqYk,3888
+ai_code_review/project_config.py,sha256=RDbplmncALKw0zgqSG8POofi300z0DPvtF33wt7_1Sk,3651
+ai_code_review/report_struct.py,sha256=N-EnNMwBY9LyJ9sdFHpUzn2fwBvxo5TZYYiJagBl8Po,3488
+ai_code_review/utils.py,sha256=DLzX9kILl5ABAsuwqFJk_3kItjgzzeTUrgZ3RMnDgAY,1713
+ai_cr-0.4.2.dist-info/entry_points.txt,sha256=fQYGUz6CVCClhei9kNCTtJUX6ia-dTca6p1sZ9pnst8,48
+ai_cr-0.4.2.dist-info/LICENSE,sha256=XATf3zv-CppUSJqI18KLhwnPEomUXEl5WbBzFyb9OSU,1096
+ai_cr-0.4.2.dist-info/METADATA,sha256=M8tRAuEfeiNsv4uBFmZGnjbth8nTKDVB_AITLyCpe2U,5302
+ai_cr-0.4.2.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+ai_cr-0.4.2.dist-info/RECORD,,

ai_cr-0.4.2.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ai-cr=ai_code_review.cli:app
+

.git/COMMIT_EDITMSG

@@ -1 +0,0 @@
-missing changes to prev. commit

.git/FETCH_HEAD

@@ -1 +0,0 @@
-70bcd529437b15a83ecc1851515ceb5baee2c968		branch 'main' of github.com:Nayjest/github-ai-code-review

.git/HEAD

@@ -1 +0,0 @@
-ref: refs/heads/distr

.git/ORIG_HEAD

@@ -1 +0,0 @@
-c5a8cf53296097c73cb02ed9b2e1aefb3ff4ccdc

.git/config

@@ -1,57 +0,0 @@
-[core]
-	repositoryformatversion = 0
-	filemode = false
-	bare = false
-	logallrefupdates = true
-	ignorecase = true
-[remote "origin"]
-	url = git@github.com:Nayjest/github-ai-code-review.git
-	fetch = +refs/heads/*:refs/remotes/origin/*
-[branch "main"]
-	remote = origin
-	merge = refs/heads/main
-[branch "github_workflow"]
-	remote = origin
-	merge = refs/heads/github_workflow
-[branch "pr2"]
-	remote = origin
-	merge = refs/heads/pr2
-[branch "pr3"]
-	remote = origin
-	merge = refs/heads/pr3
-[branch "pr4"]
-	remote = origin
-	merge = refs/heads/pr4
-[branch "PR5"]
-	remote = origin
-	merge = refs/heads/PR5
-[branch "pr6"]
-	remote = origin
-	merge = refs/heads/pr6
-[branch "pr8"]
-	remote = origin
-	merge = refs/heads/pr8
-[branch "pr9"]
-	remote = origin
-	merge = refs/heads/pr9
-[branch "pr10"]
-	remote = origin
-	merge = refs/heads/pr10
-[branch "pr12"]
-	remote = origin
-	merge = refs/heads/pr12
-[branch "pr13"]
-	remote = origin
-	merge = refs/heads/pr13
-[branch "pr14"]
-	remote = origin
-	merge = refs/heads/pr14
-[branch "pr15"]
-	remote = origin
-	merge = refs/heads/pr15
-[branch "ISS14"]
-	remote = origin
-	merge = refs/heads/ISS14
-[branch "distr"]
-	remote = origin
-	merge = refs/heads/distr

.git/description

@@ -1 +0,0 @@
-Unnamed repository; edit this file 'description' to name the repository.

.git/hooks/applypatch-msg.sample

@@ -1,15 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to check the commit log message taken by
-# applypatch from an e-mail message.
-#
-# The hook should exit with non-zero status after issuing an
-# appropriate message if it wants to stop the commit.  The hook is
-# allowed to edit the commit message file.
-#
-# To enable this hook, rename this file to "applypatch-msg".
-
-. git-sh-setup
-commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
-test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
-:

.git/hooks/commit-msg.sample

@@ -1,24 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to check the commit log message.
-# Called by "git commit" with one argument, the name of the file
-# that has the commit message.  The hook should exit with non-zero
-# status after issuing an appropriate message if it wants to stop the
-# commit.  The hook is allowed to edit the commit message file.
-#
-# To enable this hook, rename this file to "commit-msg".
-
-# Uncomment the below to add a Signed-off-by line to the message.
-# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
-# hook is more suited to it.
-#
-# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
-# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
-
-# This example catches duplicate Signed-off-by lines.
-
-test "" = "$(grep '^Signed-off-by: ' "$1" |
-	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
-	echo >&2 Duplicate Signed-off-by lines.
-	exit 1
-}

.git/hooks/fsmonitor-watchman.sample

@@ -1,174 +0,0 @@
-#!/usr/bin/perl
-
-use strict;
-use warnings;
-use IPC::Open2;
-
-# An example hook script to integrate Watchman
-# (https://facebook.github.io/watchman/) with git to speed up detecting
-# new and modified files.
-#
-# The hook is passed a version (currently 2) and last update token
-# formatted as a string and outputs to stdout a new update token and
-# all files that have been modified since the update token. Paths must
-# be relative to the root of the working tree and separated by a single NUL.
-#
-# To enable this hook, rename this file to "query-watchman" and set
-# 'git config core.fsmonitor .git/hooks/query-watchman'
-#
-my ($version, $last_update_token) = @ARGV;
-
-# Uncomment for debugging
-# print STDERR "$0 $version $last_update_token\n";
-
-# Check the hook interface version
-if ($version ne 2) {
-	die "Unsupported query-fsmonitor hook version '$version'.\n" .
-	    "Falling back to scanning...\n";
-}
-
-my $git_work_tree = get_working_dir();
-
-my $retry = 1;
-
-my $json_pkg;
-eval {
-	require JSON::XS;
-	$json_pkg = "JSON::XS";
-	1;
-} or do {
-	require JSON::PP;
-	$json_pkg = "JSON::PP";
-};
-
-launch_watchman();
-
-sub launch_watchman {
-	my $o = watchman_query();
-	if (is_work_tree_watched($o)) {
-		output_result($o->{clock}, @{$o->{files}});
-	}
-}
-
-sub output_result {
-	my ($clockid, @files) = @_;
-
-	# Uncomment for debugging watchman output
-	# open (my $fh, ">", ".git/watchman-output.out");
-	# binmode $fh, ":utf8";
-	# print $fh "$clockid\n@files\n";
-	# close $fh;
-
-	binmode STDOUT, ":utf8";
-	print $clockid;
-	print "\0";
-	local $, = "\0";
-	print @files;
-}
-
-sub watchman_clock {
-	my $response = qx/watchman clock "$git_work_tree"/;
-	die "Failed to get clock id on '$git_work_tree'.\n" .
-		"Falling back to scanning...\n" if $? != 0;
-
-	return $json_pkg->new->utf8->decode($response);
-}
-
-sub watchman_query {
-	my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
-	or die "open2() failed: $!\n" .
-	"Falling back to scanning...\n";
-
-	# In the query expression below we're asking for names of files that
-	# changed since $last_update_token but not from the .git folder.
-	#
-	# To accomplish this, we're using the "since" generator to use the
-	# recency index to select candidate nodes and "fields" to limit the
-	# output to file names only. Then we're using the "expression" term to
-	# further constrain the results.
-	my $last_update_line = "";
-	if (substr($last_update_token, 0, 1) eq "c") {
-		$last_update_token = "\"$last_update_token\"";
-		$last_update_line = qq[\n"since": $last_update_token,];
-	}
-	my $query = <<"	END";
-		["query", "$git_work_tree", {$last_update_line
-			"fields": ["name"],
-			"expression": ["not", ["dirname", ".git"]]
-		}]
-	END
-
-	# Uncomment for debugging the watchman query
-	# open (my $fh, ">", ".git/watchman-query.json");
-	# print $fh $query;
-	# close $fh;
-
-	print CHLD_IN $query;
-	close CHLD_IN;
-	my $response = do {local $/; <CHLD_OUT>};
-
-	# Uncomment for debugging the watch response
-	# open ($fh, ">", ".git/watchman-response.json");
-	# print $fh $response;
-	# close $fh;
-
-	die "Watchman: command returned no output.\n" .
-	"Falling back to scanning...\n" if $response eq "";
-	die "Watchman: command returned invalid output: $response\n" .
-	"Falling back to scanning...\n" unless $response =~ /^\{/;
-
-	return $json_pkg->new->utf8->decode($response);
-}
-
-sub is_work_tree_watched {
-	my ($output) = @_;
-	my $error = $output->{error};
-	if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) {
-		$retry--;
-		my $response = qx/watchman watch "$git_work_tree"/;
-		die "Failed to make watchman watch '$git_work_tree'.\n" .
-		    "Falling back to scanning...\n" if $? != 0;
-		$output = $json_pkg->new->utf8->decode($response);
-		$error = $output->{error};
-		die "Watchman: $error.\n" .
-		"Falling back to scanning...\n" if $error;
-
-		# Uncomment for debugging watchman output
-		# open (my $fh, ">", ".git/watchman-output.out");
-		# close $fh;
-
-		# Watchman will always return all files on the first query so
-		# return the fast "everything is dirty" flag to git and do the
-		# Watchman query just to get it over with now so we won't pay
-		# the cost in git to look up each individual file.
-		my $o = watchman_clock();
-		$error = $output->{error};
-
-		die "Watchman: $error.\n" .
-		"Falling back to scanning...\n" if $error;
-
-		output_result($o->{clock}, ("/"));
-		$last_update_token = $o->{clock};
-
-		eval { launch_watchman() };
-		return 0;
-	}
-
-	die "Watchman: $error.\n" .
-	"Falling back to scanning...\n" if $error;
-
-	return 1;
-}
-
-sub get_working_dir {
-	my $working_dir;
-	if ($^O =~ 'msys' || $^O =~ 'cygwin') {
-		$working_dir = Win32::GetCwd();
-		$working_dir =~ tr/\\/\//;
-	} else {
-		require Cwd;
-		$working_dir = Cwd::cwd();
-	}
-
-	return $working_dir;
-}

.git/hooks/post-update.sample

@@ -1,8 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to prepare a packed repository for use over
-# dumb transports.
-#
-# To enable this hook, rename this file to "post-update".
-
-exec git update-server-info

.git/hooks/pre-applypatch.sample

@@ -1,14 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to verify what is about to be committed
-# by applypatch from an e-mail message.
-#
-# The hook should exit with non-zero status after issuing an
-# appropriate message if it wants to stop the commit.
-#
-# To enable this hook, rename this file to "pre-applypatch".
-
-. git-sh-setup
-precommit="$(git rev-parse --git-path hooks/pre-commit)"
-test -x "$precommit" && exec "$precommit" ${1+"$@"}
-: