xai-review 0.17.0__tar.gz → 0.19.0__tar.gz

{xai_review-0.17.0/xai_review.egg-info → xai_review-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xai-review
-Version: 0.17.0
+Version: 0.19.0
 Summary: AI-powered code review tool
 Author-email: Nikita Filonov <nikita.filonov@example.com>
 Maintainer-email: Nikita Filonov <nikita.filonov@example.com>
@@ -9,17 +9,26 @@ Project-URL: Issues, https://github.com/Nikita-Filonov/ai-review/issues
 Project-URL: Homepage, https://github.com/Nikita-Filonov/ai-review
 Project-URL: Repository, https://github.com/Nikita-Filonov/ai-review
 Keywords: ai,code review,llm,openai,claude,gemini
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer
 Requires-Dist: httpx
 Requires-Dist: pyyaml
-Requires-Dist: pytest
 Requires-Dist: loguru
 Requires-Dist: aiofiles
 Requires-Dist: pydantic
 Requires-Dist: pydantic-settings
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
 Dynamic: license-file
 
 # AI Review
@@ -39,6 +48,7 @@ _Made with ❤️ by [@NikitaFilonov](https://t.me/sound_right)_
 ## 📑 Table of Contents
 
 - ✨ [About](#-about)
+- 🧪 [Live Preview](#-live-preview)
 - 🚀 [Quick Start](#-quick-start)
 - ⚙️ [️CI/CD Integration](#-cicd-integration)
     - 🚀 [GitHub Actions](#-github-actions)
@@ -67,6 +77,27 @@ final decision to human reviewers.
 
 ---
 
+## 🧪 Live Preview
+
+Curious how **AI Review** works in practice? Here are three real Pull Requests reviewed entirely by the tool — one per
+mode:
+
+| Mode       | Description                                        | Live Example                                                                  |
+|------------|----------------------------------------------------|-------------------------------------------------------------------------------|
+| 🧩 Inline  | Adds line-by-line comments directly in the diff    | [Try AI Review (inline)](https://github.com/Nikita-Filonov/ai-review/pull/4)  |
+| 🧠 Context | Performs broader analysis across multiple files    | [Try AI Review (context)](https://github.com/Nikita-Filonov/ai-review/pull/5) |
+| 📄 Summary | Posts a concise summary review with key highlights | [Try AI Review (summary)](https://github.com/Nikita-Filonov/ai-review/pull/6) |
+
+👉 Each review was generated automatically via GitHub Actions using the corresponding mode:
+
+```bash
+ai-review run-inline
+ai-review run-summary
+ai-review run-context
+```
+
+---
+
 ## 🚀 Quick Start
 
 Install via **pip**:
@@ -75,12 +106,18 @@ Install via **pip**:
 pip install xai-review
 ```
 
+📦 Available on [PyPI](https://pypi.org/project/xai-review/)
+
+---
+
 Or run directly via Docker:
 
 ```bash
 docker run --rm -v $(pwd):/app nikitafilonov/ai-review:latest run-summary
 ```
 
+🐳 Pull from [DockerHub](https://hub.docker.com/r/nikitafilonov/ai-review)
+
 👉 Before running, create a basic configuration file [.ai-review.yaml](./docs/configs/.ai-review.yaml) in the root of
 your project:
 
@@ -120,8 +157,8 @@ vcs:
 > **Note:** Running `ai-review run` executes the full review (inline + summary).
 > To run only one mode, use the dedicated subcommands:
 > - ai-review run-inline
-> - ai-review run-summary
 > - ai-review run-context
+> - ai-review run-summary
 
 ---
 
@@ -132,7 +169,7 @@ Key things you can customize:
 
 - **LLM provider** — OpenAI, Gemini, or Claude
 - **Model settings** — model name, temperature, max tokens
-- **VCS integration** — GitLab (currently supported) with project/MR context
+- **VCS integration** — works out of the box with **GitLab** and **GitHub**.
 - **Review policy** — which files to include/exclude, review modes
 - **Prompts** — inline/context/summary prompt templates
 
@@ -170,7 +207,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: Nikita-Filonov/ai-review@v0.17.0
+      - uses: Nikita-Filonov/ai-review@v0.19.0
         with:
           review-command: ${{ inputs.review-command }}
         env:

xai_review-0.17.0/PKG-INFO → xai_review-0.19.0/README.md

@@ -1,27 +1,3 @@
-Metadata-Version: 2.4
-Name: xai-review
-Version: 0.17.0
-Summary: AI-powered code review tool
-Author-email: Nikita Filonov <nikita.filonov@example.com>
-Maintainer-email: Nikita Filonov <nikita.filonov@example.com>
-License: Apache-2.0
-Project-URL: Issues, https://github.com/Nikita-Filonov/ai-review/issues
-Project-URL: Homepage, https://github.com/Nikita-Filonov/ai-review
-Project-URL: Repository, https://github.com/Nikita-Filonov/ai-review
-Keywords: ai,code review,llm,openai,claude,gemini
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typer
-Requires-Dist: httpx
-Requires-Dist: pyyaml
-Requires-Dist: pytest
-Requires-Dist: loguru
-Requires-Dist: aiofiles
-Requires-Dist: pydantic
-Requires-Dist: pydantic-settings
-Dynamic: license-file
-
 # AI Review
 
 AI-powered code review tool.
@@ -39,6 +15,7 @@ _Made with ❤️ by [@NikitaFilonov](https://t.me/sound_right)_
 ## 📑 Table of Contents
 
 - ✨ [About](#-about)
+- 🧪 [Live Preview](#-live-preview)
 - 🚀 [Quick Start](#-quick-start)
 - ⚙️ [️CI/CD Integration](#-cicd-integration)
     - 🚀 [GitHub Actions](#-github-actions)
@@ -67,6 +44,27 @@ final decision to human reviewers.
 
 ---
 
+## 🧪 Live Preview
+
+Curious how **AI Review** works in practice? Here are three real Pull Requests reviewed entirely by the tool — one per
+mode:
+
+| Mode       | Description                                        | Live Example                                                                  |
+|------------|----------------------------------------------------|-------------------------------------------------------------------------------|
+| 🧩 Inline  | Adds line-by-line comments directly in the diff    | [Try AI Review (inline)](https://github.com/Nikita-Filonov/ai-review/pull/4)  |
+| 🧠 Context | Performs broader analysis across multiple files    | [Try AI Review (context)](https://github.com/Nikita-Filonov/ai-review/pull/5) |
+| 📄 Summary | Posts a concise summary review with key highlights | [Try AI Review (summary)](https://github.com/Nikita-Filonov/ai-review/pull/6) |
+
+👉 Each review was generated automatically via GitHub Actions using the corresponding mode:
+
+```bash
+ai-review run-inline
+ai-review run-summary
+ai-review run-context
+```
+
+---
+
 ## 🚀 Quick Start
 
 Install via **pip**:
@@ -75,12 +73,18 @@ Install via **pip**:
 pip install xai-review
 ```
 
+📦 Available on [PyPI](https://pypi.org/project/xai-review/)
+
+---
+
 Or run directly via Docker:
 
 ```bash
 docker run --rm -v $(pwd):/app nikitafilonov/ai-review:latest run-summary
 ```
 
+🐳 Pull from [DockerHub](https://hub.docker.com/r/nikitafilonov/ai-review)
+
 👉 Before running, create a basic configuration file [.ai-review.yaml](./docs/configs/.ai-review.yaml) in the root of
 your project:
 
@@ -120,8 +124,8 @@ vcs:
 > **Note:** Running `ai-review run` executes the full review (inline + summary).
 > To run only one mode, use the dedicated subcommands:
 > - ai-review run-inline
-> - ai-review run-summary
 > - ai-review run-context
+> - ai-review run-summary
 
 ---
 
@@ -132,7 +136,7 @@ Key things you can customize:
 
 - **LLM provider** — OpenAI, Gemini, or Claude
 - **Model settings** — model name, temperature, max tokens
-- **VCS integration** — GitLab (currently supported) with project/MR context
+- **VCS integration** — works out of the box with **GitLab** and **GitHub**.
 - **Review policy** — which files to include/exclude, review modes
 - **Prompts** — inline/context/summary prompt templates
 
@@ -170,7 +174,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: Nikita-Filonov/ai-review@v0.17.0
+      - uses: Nikita-Filonov/ai-review@v0.19.0
         with:
           review-command: ${{ inputs.review-command }}
         env:

{xai_review-0.17.0 → xai_review-0.19.0}/ai_review/clients/github/pr/client.py

@@ -11,21 +11,31 @@ from ai_review.clients.github.pr.schema.files import GitHubGetPRFilesResponseSch
 from ai_review.clients.github.pr.schema.pull_request import GitHubGetPRResponseSchema
 from ai_review.clients.github.pr.schema.reviews import GitHubGetPRReviewsResponseSchema
 from ai_review.libs.http.client import HTTPClient
+from ai_review.libs.http.handlers import HTTPClientError, handle_http_error
+
+
+class GitHubPullRequestsHTTPClientError(HTTPClientError):
+    pass
 
 
 class GitHubPullRequestsHTTPClient(HTTPClient):
+    @handle_http_error(client="GitHubPullRequestsHTTPClient", exception=GitHubPullRequestsHTTPClientError)
     async def get_pull_request_api(self, owner: str, repo: str, pull_number: str) -> Response:
         return await self.get(f"/repos/{owner}/{repo}/pulls/{pull_number}")
 
+    @handle_http_error(client="GitHubPullRequestsHTTPClient", exception=GitHubPullRequestsHTTPClientError)
     async def get_files_api(self, owner: str, repo: str, pull_number: str) -> Response:
         return await self.get(f"/repos/{owner}/{repo}/pulls/{pull_number}/files")
 
+    @handle_http_error(client="GitHubPullRequestsHTTPClient", exception=GitHubPullRequestsHTTPClientError)
     async def get_issue_comments_api(self, owner: str, repo: str, issue_number: str) -> Response:
         return await self.get(f"/repos/{owner}/{repo}/issues/{issue_number}/comments")
 
+    @handle_http_error(client="GitHubPullRequestsHTTPClient", exception=GitHubPullRequestsHTTPClientError)
     async def get_review_comments_api(self, owner: str, repo: str, pull_number: str) -> Response:
         return await self.get(f"/repos/{owner}/{repo}/pulls/{pull_number}/comments")
 
+    @handle_http_error(client="GitHubPullRequestsHTTPClient", exception=GitHubPullRequestsHTTPClientError)
     async def create_review_comment_api(
             self,
             owner: str,
@@ -38,6 +48,7 @@ class GitHubPullRequestsHTTPClient(HTTPClient):
             json=request.model_dump(),
         )
 
+    @handle_http_error(client="GitHubPullRequestsHTTPClient", exception=GitHubPullRequestsHTTPClientError)
     async def create_issue_comment_api(
             self,
             owner: str,
@@ -50,6 +61,7 @@ class GitHubPullRequestsHTTPClient(HTTPClient):
             json=request.model_dump(),
         )
 
+    @handle_http_error(client="GitHubPullRequestsHTTPClient", exception=GitHubPullRequestsHTTPClientError)
     async def get_reviews_api(self, owner: str, repo: str, pull_number: str) -> Response:
         return await self.get(f"/repos/{owner}/{repo}/pulls/{pull_number}/reviews")
 
@@ -78,14 +90,8 @@ class GitHubPullRequestsHTTPClient(HTTPClient):
             owner: str,
             repo: str,
             pull_number: str,
-            body: str,
-            commit_id: str,
-            path: str,
-            line: int,
+            request: GitHubCreateReviewCommentRequestSchema
     ) -> GitHubCreateReviewCommentResponseSchema:
-        request = GitHubCreateReviewCommentRequestSchema(
-            body=body, commit_id=commit_id, path=path, line=line
-        )
         response = await self.create_review_comment_api(owner, repo, pull_number, request)
         return GitHubCreateReviewCommentResponseSchema.model_validate_json(response.text)
 

{xai_review-0.17.0 → xai_review-0.19.0}/ai_review/clients/github/pr/schema/pull_request.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 
 class GitHubUserSchema(BaseModel):
@@ -8,13 +8,13 @@ class GitHubUserSchema(BaseModel):
 
 class GitHubLabelSchema(BaseModel):
     id: int
-    name: str
+    name: str | None = None
 
 
 class GitHubBranchSchema(BaseModel):
     ref: str
     sha: str
-    label: str
+    label: str | None = None
 
 
 class GitHubGetPRResponseSchema(BaseModel):
@@ -23,8 +23,8 @@ class GitHubGetPRResponseSchema(BaseModel):
     title: str
     body: str | None = None
     user: GitHubUserSchema
-    labels: list[GitHubLabelSchema]
-    assignees: list[GitHubUserSchema] = []
-    requested_reviewers: list[GitHubUserSchema] = []
+    labels: list[GitHubLabelSchema] = Field(default_factory=list)
+    assignees: list[GitHubUserSchema] = Field(default_factory=list)
+    requested_reviewers: list[GitHubUserSchema] = Field(default_factory=list)
     base: GitHubBranchSchema
     head: GitHubBranchSchema

{xai_review-0.17.0 → xai_review-0.19.0}/ai_review/clients/gitlab/mr/client.py

@@ -1,47 +1,56 @@
 from httpx import Response
 
 from ai_review.clients.gitlab.mr.schema.changes import GitLabGetMRChangesResponseSchema
-from ai_review.clients.gitlab.mr.schema.comments import (
-    GitLabGetMRCommentsResponseSchema,
-    GitLabCreateMRCommentRequestSchema,
-    GitLabCreateMRCommentResponseSchema,
-)
 from ai_review.clients.gitlab.mr.schema.discussions import (
     GitLabGetMRDiscussionsResponseSchema,
     GitLabCreateMRDiscussionRequestSchema,
     GitLabCreateMRDiscussionResponseSchema
 )
+from ai_review.clients.gitlab.mr.schema.notes import (
+    GitLabGetMRNotesResponseSchema,
+    GitLabCreateMRNoteRequestSchema,
+    GitLabCreateMRNoteResponseSchema,
+)
 from ai_review.libs.http.client import HTTPClient
+from ai_review.libs.http.handlers import handle_http_error, HTTPClientError
 
 
-class GitLabMergeRequestsHTTPClient(HTTPClient):
+class GitLabMergeRequestsHTTPClientError(HTTPClientError):
+    pass
 
+
+class GitLabMergeRequestsHTTPClient(HTTPClient):
+    @handle_http_error(client="GitLabMergeRequestsHTTPClient", exception=GitLabMergeRequestsHTTPClientError)
     async def get_changes_api(self, project_id: str, merge_request_id: str) -> Response:
         return await self.get(
             f"/api/v4/projects/{project_id}/merge_requests/{merge_request_id}/changes"
         )
 
-    async def get_comments_api(self, project_id: str, merge_request_id: str) -> Response:
+    @handle_http_error(client="GitLabMergeRequestsHTTPClient", exception=GitLabMergeRequestsHTTPClientError)
+    async def get_notes_api(self, project_id: str, merge_request_id: str) -> Response:
         return await self.get(
             f"/api/v4/projects/{project_id}/merge_requests/{merge_request_id}/notes"
         )
 
+    @handle_http_error(client="GitLabMergeRequestsHTTPClient", exception=GitLabMergeRequestsHTTPClientError)
     async def get_discussions_api(self, project_id: str, merge_request_id: str) -> Response:
         return await self.get(
             f"/api/v4/projects/{project_id}/merge_requests/{merge_request_id}/discussions"
         )
 
-    async def create_comment_api(
+    @handle_http_error(client="GitLabMergeRequestsHTTPClient", exception=GitLabMergeRequestsHTTPClientError)
+    async def create_note_api(
             self,
             project_id: str,
             merge_request_id: str,
-            request: GitLabCreateMRCommentRequestSchema,
+            request: GitLabCreateMRNoteRequestSchema,
     ) -> Response:
         return await self.post(
             f"/api/v4/projects/{project_id}/merge_requests/{merge_request_id}/notes",
             json=request.model_dump(),
         )
 
+    @handle_http_error(client="GitLabMergeRequestsHTTPClient", exception=GitLabMergeRequestsHTTPClientError)
     async def create_discussion_api(
             self,
             project_id: str,
@@ -57,13 +66,13 @@ class GitLabMergeRequestsHTTPClient(HTTPClient):
         response = await self.get_changes_api(project_id, merge_request_id)
         return GitLabGetMRChangesResponseSchema.model_validate_json(response.text)
 
-    async def get_comments(
+    async def get_notes(
             self,
             project_id: str,
             merge_request_id: str
-    ) -> GitLabGetMRCommentsResponseSchema:
-        response = await self.get_comments_api(project_id, merge_request_id)
-        return GitLabGetMRCommentsResponseSchema.model_validate_json(response.text)
+    ) -> GitLabGetMRNotesResponseSchema:
+        response = await self.get_notes_api(project_id, merge_request_id)
+        return GitLabGetMRNotesResponseSchema.model_validate_json(response.text)
 
     async def get_discussions(
             self,
@@ -73,26 +82,26 @@ class GitLabMergeRequestsHTTPClient(HTTPClient):
         response = await self.get_discussions_api(project_id, merge_request_id)
         return GitLabGetMRDiscussionsResponseSchema.model_validate_json(response.text)
 
-    async def create_comment(
+    async def create_note(
             self,
-            comment: str,
+            body: str,
             project_id: str,
             merge_request_id: str,
-    ) -> GitLabCreateMRCommentResponseSchema:
-        request = GitLabCreateMRCommentRequestSchema(body=comment)
-        response = await self.create_comment_api(
+    ) -> GitLabCreateMRNoteResponseSchema:
+        request = GitLabCreateMRNoteRequestSchema(body=body)
+        response = await self.create_note_api(
             request=request,
             project_id=project_id,
             merge_request_id=merge_request_id
         )
-        return GitLabCreateMRCommentResponseSchema.model_validate_json(response.text)
+        return GitLabCreateMRNoteResponseSchema.model_validate_json(response.text)
 
     async def create_discussion(
             self,
             project_id: str,
             merge_request_id: str,
             request: GitLabCreateMRDiscussionRequestSchema
-    ):
+    ) -> GitLabCreateMRDiscussionResponseSchema:
         response = await self.create_discussion_api(
             request=request,
             project_id=project_id,

{xai_review-0.17.0 → xai_review-0.19.0}/ai_review/clients/gitlab/mr/schema/changes.py

@@ -14,9 +14,9 @@ class GitLabDiffRefsSchema(BaseModel):
 
 
 class GitLabMRChangeSchema(BaseModel):
-    diff: str
-    old_path: str
-    new_path: str
+    diff: str | None = None
+    old_path: str | None = None
+    new_path: str | None = None
 
 
 class GitLabGetMRChangesResponseSchema(BaseModel):
@@ -24,12 +24,12 @@ class GitLabGetMRChangesResponseSchema(BaseModel):
     iid: int
     title: str
     author: GitLabUserSchema
-    labels: list[str] = []
+    labels: list[str] = Field(default_factory=list)
     changes: list[GitLabMRChangeSchema]
     assignees: list[GitLabUserSchema] = Field(default_factory=list)
     reviewers: list[GitLabUserSchema] = Field(default_factory=list)
     diff_refs: GitLabDiffRefsSchema
     project_id: int
-    description: str
+    description: str | None = None
     source_branch: str
     target_branch: str

{xai_review-0.17.0 → xai_review-0.19.0}/ai_review/clients/gitlab/mr/schema/discussions.py

@@ -1,9 +1,6 @@
 from pydantic import BaseModel, RootModel
 
-
-class GitLabNoteSchema(BaseModel):
-    id: int
-    body: str
+from ai_review.clients.gitlab.mr.schema.notes import GitLabNoteSchema
 
 
 class GitLabDiscussionSchema(BaseModel):

xai_review-0.19.0/ai_review/clients/gitlab/mr/schema/notes.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, RootModel
+
+
+class GitLabNoteSchema(BaseModel):
+    id: int
+    body: str
+
+
+class GitLabGetMRNotesResponseSchema(RootModel[list[GitLabNoteSchema]]):
+    root: list[GitLabNoteSchema]
+
+
+class GitLabCreateMRNoteRequestSchema(BaseModel):
+    body: str
+
+
+class GitLabCreateMRNoteResponseSchema(BaseModel):
+    id: int
+    body: str

{xai_review-0.17.0 → xai_review-0.19.0}/ai_review/services/llm/factory.py

@@ -15,4 +15,4 @@ def get_llm_client() -> LLMClient:
         case LLMProvider.CLAUDE:
             return ClaudeLLMClient()
         case _:
-            raise ValueError(f"Unsupported provider: {settings.llm.provider}")
+            raise ValueError(f"Unsupported LLM provider: {settings.llm.provider}")

xai_review-0.19.0/ai_review/services/prompt/adapter.py

@@ -0,0 +1,25 @@
+from ai_review.services.prompt.schema import PromptContextSchema
+from ai_review.services.vcs.types import ReviewInfoSchema
+
+
+def build_prompt_context_from_mr_info(review: ReviewInfoSchema) -> PromptContextSchema:
+    return PromptContextSchema(
+        review_title=review.title,
+        review_description=review.description,
+
+        review_author_name=review.author.name,
+        review_author_username=review.author.username,
+
+        review_reviewers=[user.name for user in review.reviewers],
+        review_reviewers_usernames=[user.username for user in review.reviewers],
+        review_reviewer=review.reviewers[0].name if review.reviewers else "",
+
+        review_assignees=[user.name for user in review.assignees],
+        review_assignees_usernames=[user.username for user in review.assignees],
+
+        source_branch=review.source_branch.ref,
+        target_branch=review.target_branch.ref,
+
+        labels=review.labels,
+        changed_files=review.changed_files,
+    )

xai_review-0.19.0/ai_review/services/prompt/schema.py

@@ -0,0 +1,52 @@
+from pydantic import BaseModel, Field
+
+from ai_review.config import settings
+from ai_review.libs.template.render import render_template
+
+
+class PromptContextSchema(BaseModel):
+    review_title: str = ""
+    review_description: str = ""
+
+    review_author_name: str = ""
+    review_author_username: str = ""
+
+    review_reviewer: str = ""
+    review_reviewers: list[str] = Field(default_factory=list)
+    review_reviewers_usernames: list[str] = Field(default_factory=list)
+
+    review_assignees: list[str] = Field(default_factory=list)
+    review_assignees_usernames: list[str] = Field(default_factory=list)
+
+    source_branch: str = ""
+    target_branch: str = ""
+
+    labels: list[str] = Field(default_factory=list)
+    changed_files: list[str] = Field(default_factory=list)
+
+    @property
+    def render_values(self) -> dict[str, str]:
+        return {
+            "review_title": self.review_title,
+            "review_description": self.review_description,
+
+            "review_author_name": self.review_author_name,
+            "review_author_username": self.review_author_username,
+
+            "review_reviewer": self.review_reviewer,
+            "review_reviewers": ", ".join(self.review_reviewers),
+            "review_reviewers_usernames": ", ".join(self.review_reviewers_usernames),
+
+            "review_assignees": ", ".join(self.review_assignees),
+            "review_assignees_usernames": ", ".join(self.review_assignees_usernames),
+
+            "source_branch": self.source_branch,
+            "target_branch": self.target_branch,
+
+            "labels": ", ".join(self.labels),
+            "changed_files": ", ".join(self.changed_files),
+        }
+
+    def apply_format(self, prompt: str) -> str:
+        values = {**self.render_values, **settings.prompt.context}
+        return render_template(prompt, values, settings.prompt.context_placeholder)