ai-cr 0.6.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

ai_code_review/.ai-code-review.toml

@@ -38,21 +38,23 @@ prompt = """
 ----TASK----
 Review the provided code diff carefully and identify *only* highly confident issues which are relevant to any code context.
 
-----CODE----
+----CODEBASE CHANGES TO REVIEW----
 {{ input }}
 --------
 
 {% if file_lines -%}
-----ADDITIONAL CONTEXT----
+----ADDITIONAL CONTEXT: FULL FILE CONTENT AFTER APPLYING REVIEWED CHANGES----
 {{ file_lines }}
 {%- endif %}
 
 ----TASK GUIDELINES----
 - Only report issues you are **100% confident** are relevant to any context.
+- Never report issues about using software versions that have not yet been released.
 - Only include issues that are **significantly valuable** to the maintainers (e.g., bugs, security flaws, or clear maintainability concerns).
 - Do **not** report vague, theoretical, or overly generic advice.
 - Do **not** report anything with medium or lower confidence.
-- Typographical errors have highest severity
+- Typographical errors have highest severity.
+{{ requirements -}}
 {{ json_requirements }}
 
 Respond with a valid JSON array of issues in the following format:
@@ -124,8 +126,9 @@ If code changes contains exceptional achievements, you may additionally present
 --Available Awards--
 {{ awards }}
 ---
-Your response will be parsed programmatically, so do not include any additional text.
-Use Markdown formatting in your response.
+- Your response will be parsed programmatically, so do not include any additional text.
+- Use Markdown formatting in your response.
+{{ summary_requirements -}}
 """
 
 [prompt_vars]
@@ -303,4 +306,6 @@ restored lost knowledge and now bestow it upon a new generation."
 decorators add depth and texture, and observer masterfully completes the composition.
 The Gang of Four gives a standing ovation from the stalls."
 ```
-"""
+"""
+requirements = ""
+summary_requirements = ""

ai_code_review/cli.py

@@ -32,7 +32,9 @@ def main():
 
 
 @app.callback(invoke_without_command=True)
-def cli(ctx: typer.Context):
+def cli(ctx: typer.Context, verbose: bool = typer.Option(default=False)):
+    if verbose:
+        mc.logging.LoggingConfig.STRIP_REQUEST_LINES = None
     if ctx.invoked_subcommand != "setup":
         bootstrap()
 

ai_code_review/commands/repl.py

@@ -0,0 +1,22 @@
+"""
+Python REPL
+"""
+# flake8: noqa: F401
+import code
+from ema.cli import app
+
+# Imports for usage in REPL
+import os
+import sys
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from time import time
+from rich.pretty import pprint
+
+import microcore as mc
+from microcore import ui
+
+@app.command(help="python REPL")
+def repl():
+    code.interact(local=globals())

{ai_cr-0.6.0.dist-info → ai_cr-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ai-cr
-Version: 0.6.0
+Version: 1.0.0
 Summary: LLM-agnostic GitHub AI Code Review Tool with integration to GitHub actions
 License: MIT
 Keywords: static code analysis,code review,code quality,ai,coding,assistant,llm,github,automation,devops,developer tools,github actions,workflows,git
@@ -70,7 +70,7 @@ jobs:
       uses: actions/setup-python@v5
       with: { python-version: "3.13" }
     - name: Install AI Code Review tool
-      run: pip install ai-code-review==0.5.0
+      run: pip install ai-code-review~=1.0
     - name: Run AI code analysis
       env:
         LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
@@ -84,7 +84,7 @@ jobs:
       with:
         name: ai-code-review-results
         path: |
-          code-review-report.txt
+          code-review-report.md
           code-review-report.json
 ```
 
@@ -94,25 +94,56 @@ jobs:
 PRs to your repository will now receive AI code reviews automatically. ✨  
 See [GitHub Setup Guide](https://github.com/Nayjest/ai-code-review/blob/main/documentation/github_setup.md) for more details.
 
-### 2. Run Code Analysis Locally
+### 2. Running Code Analysis Locally
 
-Install and run:
+#### Initial Local Setup
 
+**Prerequisites:** [Python](https://www.python.org/downloads/) 3.11 / 3.12 / 3.13  
+
+**Step1:** Install [ai-code-review](https://github.com/Nayjest/ai-code-review) using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)).
 ```bash
-# Prerequisites: Python 3.11+
 pip install ai-code-review
+```
+
+> **Troubleshooting:**  
+> pip may be also available via cli as `pip3` depending on your Python installation.
+
+**Step2:** Perform initial setup
 
-# One-time setup using interactive wizard (saves configuration in ~/.env.ai-code-review)
+The following command will perform one-time setup using an interactive wizard.
+You will be prompted to enter LLM configuration details (API type, API key, etc).
+Configuration will be saved to ~/.env.ai-code-review.
+
+```bash
 ai-code-review setup
+```
+
+> **Troubleshooting:**  
+> On some systems, `ai-code-review` command may not became available immediately after installation.  
+> Try restarting your terminal or running `python -m ai_code_review` instead.
 
-# Run review on committed changes in current branch vs main
+
+#### Perform your first AI code review locally
+
+**Step1:** Navigate to your repository root directory.  
+**Step2:** Switch to the branch you want to review.  
+**Step3:** Run following command
+```bash
 ai-code-review
 ```
 
-To review a remote repository:
+> **Note:** This will analyze the current branch against the repository main branch by default.  
+> Files that are not staged for commit will be ignored.  
+> See `ai-code-review --help` for more options.
+
+**Reviewing remote repository**
 
 ```bash
-ai-code-review remote --url https://github.com/owner/repo --branch feature-branch
+ai-code-review remote git@github.com:owner/repo.git <FEATURE_BRANCH>..<MAIN_BRANCH>
+```
+Use interactive help for details:
+```bash
+ai-code-review remote --help
 ```
 
 ## 🔧 Configuration
@@ -129,6 +160,8 @@ You can override the default config by placing `.ai-code-review.toml` in your re
 
 See default configuration [here](https://github.com/Nayjest/ai-code-review/blob/main/ai_code_review/.ai-code-review.toml).
 
+More details can be found in [📖 Configuration Cookbook](https://github.com/Nayjest/ai-code-review/blob/main/documentation/config_cookbook.md)
+
 ## 💻 Development Setup
 
 Install dependencies:

{ai_cr-0.6.0.dist-info → ai_cr-1.0.0.dist-info}/RECORD

@@ -1,15 +1,16 @@
-ai_code_review/.ai-code-review.toml,sha256=z-3iliCvkkpdAr9l_yUyM-IbgRm9hbAA3CIV6ocuurY,10378
+ai_code_review/.ai-code-review.toml,sha256=sIQt7VJWl937VLocF2Vg6bC4qGbHeBgyKF6Bj3XKwIk,10640
 ai_code_review/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ai_code_review/__main__.py,sha256=EClCwCzb6h6YBpt0hrnG4h0mlNhNePyg_xBNNSVm1os,65
 ai_code_review/bootstrap.py,sha256=jqioR_UtTsn5nXezmjMLU3aB8tzlVz73ZRBk33ud5F4,2336
-ai_code_review/cli.py,sha256=1wrF-s6U_f8BjwCl70G7IXIBEhmMUbQDvij5AMDxQ5M,7318
+ai_code_review/cli.py,sha256=9OWQP2voQOfrhVfJsCzP-nQ9RtLU1cHhMi81QY56vzc,7441
+ai_code_review/commands/repl.py,sha256=Ms5p6vgcf0EBAUUWKQfJu3X9XFvzJXB018qcvSiJ-oI,396
 ai_code_review/constants.py,sha256=K9mNxTq9seTG3aVm__3r1lXb5oCOQjH24Cl3hfX9FsE,281
 ai_code_review/core.py,sha256=BJNs4ZER2-bMulXY2apY6B6hI0nvRCOrLqsJ7L8Bizc,6693
 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=vlzU3M89qK6_mVkBMnppZaOFsXddVsIBVdfmbN3cxDY,2939
-ai_cr-0.6.0.dist-info/entry_points.txt,sha256=u0N5NroPYEGqmDGaGqFmiijJ5swzpe7EyKBupnkp1FY,49
-ai_cr-0.6.0.dist-info/LICENSE,sha256=XATf3zv-CppUSJqI18KLhwnPEomUXEl5WbBzFyb9OSU,1096
-ai_cr-0.6.0.dist-info/METADATA,sha256=poIlyrRUJQEKwRN7JIgKGOjgL1DR291tw6jibTi4EMs,5835
-ai_cr-0.6.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-ai_cr-0.6.0.dist-info/RECORD,,
+ai_cr-1.0.0.dist-info/entry_points.txt,sha256=u0N5NroPYEGqmDGaGqFmiijJ5swzpe7EyKBupnkp1FY,49
+ai_cr-1.0.0.dist-info/LICENSE,sha256=XATf3zv-CppUSJqI18KLhwnPEomUXEl5WbBzFyb9OSU,1096
+ai_cr-1.0.0.dist-info/METADATA,sha256=SPJm5aNOWFdwCI7KxtDE2AspsP2Kdn5NLwV6DeBJIeg,7109
+ai_cr-1.0.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+ai_cr-1.0.0.dist-info/RECORD,,