codespector 0.1.2__tar.gz → 1.0.0__tar.gz

{codespector-0.1.2 → codespector-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codespector
-Version: 0.1.2
+Version: 1.0.0
 Summary: Assistant for reviewing your code
 Project-URL: Repository, https://github.com/Vladimir-Titov/codespector
 Project-URL: Issues, https://github.com/Vladimir-Titov/codespector/issues
@@ -15,7 +15,6 @@ Requires-Dist: click>=8.1.8
 Requires-Dist: environs>=14.1.1
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: requests>=2.32.3
-Requires-Dist: ujson>=5.10.0
 Description-Content-Type: text/markdown
 
 # CodeSpector
@@ -51,18 +50,23 @@ You can use the `codespector` command to start a code review. Below are the avai
 Usage: codespector [OPTIONS]
 
 Options:
-  --system-content TEXT       Content which used in system field for agent
-                              [default: Ты код ревьювер. Отвечай на русском языке.]
-  --output-dir TEXT           Select the output directory [default: codespector]
-  -b, --compare-branch TEXT   Select the branch to compare the current one with
-                              [default: develop]
-  --chat-agent [codestral|chatgpt]
-                              Choose the chat agent to use [default: codestral]
-  --chat-model TEXT           Choose the chat model to use
-  --chat-token TEXT           Chat agent token
-  --mode [local]              Choose the mode of the application [default: local]
-  --version                   Show the version and exit.
-  --help                      Show this message and exit.
+  --chat-token TEXT          Chat agent token  [env var: CODESPECTOR_CHAT_TOKEN]
+  --chat-model TEXT          Choose the chat model to use  [env var: CODESPECTOR_CHAT_MODEL]
+  --chat-agent TEXT          Choose the chat agent to use (codestral, chatgpt, deepseek)
+                            or set your own  [env var: CODESPECTOR_CHAT_AGENT]
+  -b, --compare-branch TEXT  Select the branch to compare the current one with
+  --output-dir TEXT         Select the output directory  [default: codespector]
+                            [env var: CODESPECTOR_OUTPUT_DIR]
+  --system-content TEXT     Content which used in system field for agent
+                            [env var: CODESPECTOR_SYSTEM_CONTENT]
+  --prompt-content TEXT     Prompt content which included to review prompt
+                            [env var: CODESPECTOR_PROMPT_CONTENT]
+  --result-file TEXT        Set file for saving the result
+                            [env var: CODESPECTOR_RESULT_FILE]
+  --exclude-file-ext LIST   Exclude file extensions from the review
+                            [env var: CODESPECTOR_EXCLUDE_FILE_EXT]
+  --version                 Show the version and exit.
+  --help                    Show this message and exit.
 ```
 
 ### Example
@@ -70,7 +74,7 @@ Options:
 To run a code review, use the following command:
 
 ```sh
-codespector --chat-token YOUR_CHAT_TOKEN --chat-agent codestral --compare-branch develop
+codespector --chat-token YOUR_CHAT_TOKEN --chat-agent codestral --compare-branch develop --result-file result.md --system-content "system content" --prompt-content "prompt content"
 ```
 
 ## Configuration
@@ -78,11 +82,14 @@ codespector --chat-token YOUR_CHAT_TOKEN --chat-agent codestral --compare-branch
 You can also configure CodeSpector using environment variables. Create a `.env` file in the root directory of your project with the following content:
 
 ```
-CODESPECTOR_SYSTEM_CONTENT=Ты код ревьювер. Отвечай на русском языке.
+CODESPECTOR_CHAT_TOKEN=your_token
 CODESPECTOR_OUTPUT_DIR=codespector
+CODESPECTOR_SYSTEM_CONTENT="Ты код ревьювер. Отвечай на русском"
+CODESPECTOR_PROMPT_CONTENT="Оцени код на безопасноть, соблюдение лучших техник"
+CODESPECTOR_RESULT_FILE="result.md"
 CODESPECTOR_CHAT_AGENT=codestral
-CODESPECTOR_CHAT_MODEL=codestral-latest
-CODESPECTOR_CHAT_TOKEN=YOUR_CHAT_TOKEN
+CODESPECTOR_CHAT_MODEL=your_model
+CODESPECTOR_EXCLUDE_FILE_EXT=.pyc,.pyo
 ```
 
 ## Makefile Commands

codespector-1.0.0/README.md

@@ -0,0 +1,85 @@
+# CodeSpector
+
+CodeSpector is a Python package designed to review code changes for quality and security issues using AI chat agents. It supports different chat agents like Codestral and ChatGPT.
+
+## Features
+
+- Automated code review using AI chat agents.
+- Supports multiple chat agents and models.
+- Generates detailed review reports in markdown format.
+- Configurable via environment variables and command-line options.
+
+## Installation
+
+To install the package, use the following command:
+
+```sh
+pip install codespector
+```
+
+```sh
+uv add codespector
+```
+
+## Usage
+
+### Command-Line Interface
+
+You can use the `codespector` command to start a code review. Below are the available options:
+
+```sh
+Usage: codespector [OPTIONS]
+
+Options:
+  --chat-token TEXT          Chat agent token  [env var: CODESPECTOR_CHAT_TOKEN]
+  --chat-model TEXT          Choose the chat model to use  [env var: CODESPECTOR_CHAT_MODEL]
+  --chat-agent TEXT          Choose the chat agent to use (codestral, chatgpt, deepseek)
+                            or set your own  [env var: CODESPECTOR_CHAT_AGENT]
+  -b, --compare-branch TEXT  Select the branch to compare the current one with
+  --output-dir TEXT         Select the output directory  [default: codespector]
+                            [env var: CODESPECTOR_OUTPUT_DIR]
+  --system-content TEXT     Content which used in system field for agent
+                            [env var: CODESPECTOR_SYSTEM_CONTENT]
+  --prompt-content TEXT     Prompt content which included to review prompt
+                            [env var: CODESPECTOR_PROMPT_CONTENT]
+  --result-file TEXT        Set file for saving the result
+                            [env var: CODESPECTOR_RESULT_FILE]
+  --exclude-file-ext LIST   Exclude file extensions from the review
+                            [env var: CODESPECTOR_EXCLUDE_FILE_EXT]
+  --version                 Show the version and exit.
+  --help                    Show this message and exit.
+```
+
+### Example
+
+To run a code review, use the following command:
+
+```sh
+codespector --chat-token YOUR_CHAT_TOKEN --chat-agent codestral --compare-branch develop --result-file result.md --system-content "system content" --prompt-content "prompt content"
+```
+
+## Configuration
+
+You can also configure CodeSpector using environment variables. Create a `.env` file in the root directory of your project with the following content:
+
+```
+CODESPECTOR_CHAT_TOKEN=your_token
+CODESPECTOR_OUTPUT_DIR=codespector
+CODESPECTOR_SYSTEM_CONTENT="Ты код ревьювер. Отвечай на русском"
+CODESPECTOR_PROMPT_CONTENT="Оцени код на безопасноть, соблюдение лучших техник"
+CODESPECTOR_RESULT_FILE="result.md"
+CODESPECTOR_CHAT_AGENT=codestral
+CODESPECTOR_CHAT_MODEL=your_model
+CODESPECTOR_EXCLUDE_FILE_EXT=.pyc,.pyo
+```
+
+## Makefile Commands
+
+- `lint`: Run linting and formatting checks.
+- `format`: Format the code.
+- `fix`: Fix linting issues and format the code.
+- `test`: Run the tests.
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for more details.

codespector-1.0.0/cicd_examples/.gitlab-ci.yml

@@ -0,0 +1,41 @@
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+
+variables:
+  GIT_DEPTH: 0
+  CODESPECTOR_RESULT_FILE: "codespector/result.md"
+  CODESPECTOR_COMBINED_FILE: "codespector/combined.json"
+
+stages:
+  - codespector
+
+codespector-job:
+  stage: codespector
+  image: python:3.12
+  script:
+    - apt-get update && apt-get install -y jq
+    - git fetch --no-tags origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
+    - pip install codespector
+    - | 
+      codespector 
+      --chat-token $CODESPECTOR_CHAT_TOKEN 
+      --chat-agent $CODESPECTOR_CHAT_AGENT 
+      --compare-branch origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...HEAD
+      --result-file $CODESPECTOR_RESULT_FILE
+      --system-content $CODESCPECTOR_SYSTEM_CONTENT
+      --prompt-content $CODESPECTOR_PROMPT_CONTENT
+
+    - |
+      COMMENT_CONTENT=$(cat ${CODESPECTOR_RESULT_FILE} | jq -Rs .)
+      echo "Posting comment to MR..."
+      curl -X POST \
+        --header "PRIVATE-TOKEN: $GITLAB_TOKEN" \
+        --header "Content-Type: application/json" \
+        --data "{\"body\": ${COMMENT_CONTENT}}" \
+        "$CI_API_V4_URL/projects/$CI_PROJECT_ID/merge_requests/$CI_MERGE_REQUEST_IID/notes"
+  artifacts:
+    paths:
+      - ${CODESPECTOR_RESULT_FILE}
+      - ${CODESPECTOR_COMBINED_FILE}
+    expire_in: 10 minutes

codespector-1.0.0/codespector/base.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class BasePipe(ABC):
+    @abstractmethod
+    def start(self, *args, **kwargs) -> None:
+        raise NotImplementedError

codespector-1.0.0/codespector/codespector.py

@@ -0,0 +1,89 @@
+from codespector.base import BasePipe
+from codespector.local import CodeSpectorDataPreparer
+from codespector.reviewer import CodeSpectorReviewer
+from codespector.types import AgentInfo
+
+
+class CodeSpector:
+    def __init__(
+        self,
+        chat_token: str,
+        chat_agent: str,
+        compare_branch: str,
+        system_content: str,
+        prompt_content: str,
+        data_preparer: CodeSpectorDataPreparer,
+        reviewer: CodeSpectorReviewer,
+        pipeline: list[BasePipe],
+        result_file: str,
+        output_dir: str,
+        chat_model: str | None = None,
+        exclude_file_ext: list[str] | None = None,
+    ):
+        self.chat_token = chat_token
+        self.chat_agent = chat_agent
+        self.compare_branch = compare_branch
+        self.output_dir = output_dir
+        self.system_content = system_content
+        self.prompt_content = prompt_content
+        self.data_preparer = data_preparer
+        self.reviewer = reviewer
+        self.pipeline = pipeline
+        self.result_file = result_file
+        self.chat_model = chat_model
+        self.exclude_file_exc: list[str] | None = (None,)
+
+    @classmethod
+    def create(
+        cls,
+        chat_token: str,
+        chat_agent: str,
+        compare_branch: str,
+        system_content: str,
+        prompt_content: str,
+        result_file: str,
+        output_dir: str,
+        chat_model: str | None = None,
+        exclude_file_ext: list[str] | None = None,
+    ) -> 'CodeSpector':
+        agent_info = AgentInfo.create(
+            chat_agent=chat_agent,
+            chat_token=chat_token,
+            chat_model=chat_model,
+        )
+        data_preparer = CodeSpectorDataPreparer(
+            output_dir=output_dir,
+            compare_branch=compare_branch,
+            exclude_file_ext=exclude_file_ext,
+        )
+        reviewer = CodeSpectorReviewer(
+            diff_file=data_preparer.combined_file,
+            chat_token=chat_token,
+            chat_agent=chat_agent,
+            system_content=system_content,
+            output_dir=output_dir,
+            chat_model=chat_model,
+            agent_info=agent_info,
+            prompt_content=prompt_content,
+            result_file=result_file,
+        )
+        pipeline = [data_preparer, reviewer]
+
+        return CodeSpector(
+            chat_token=chat_token,
+            chat_agent=chat_agent,
+            chat_model=chat_model,
+            compare_branch=compare_branch,
+            system_content=system_content,
+            prompt_content=prompt_content,
+            data_preparer=data_preparer,
+            reviewer=reviewer,
+            pipeline=pipeline,
+            output_dir=output_dir,
+            result_file=result_file,
+            exclude_file_ext=exclude_file_ext,
+        )
+
+    def review(self):
+        for pipe in self.pipeline:
+            pipe.start()

codespector-1.0.0/codespector/errors.py

@@ -0,0 +1,14 @@
+class NotValidCfgError(Exception):
+    """Exception raised when the configuration is not valid."""
+
+    def __init__(self, message):
+        super().__init__(message)
+        self.message = message
+
+
+class AppError(Exception):
+    """Exception raised for application errors."""
+
+    def __init__(self, message):
+        super().__init__(message)
+        self.message = message

codespector-0.1.2/codespector/local/prepare.py → codespector-1.0.0/codespector/local.py

@@ -1,16 +1,20 @@
-import ujson
+import json
 import subprocess
 import os
 
+from codespector.base import BasePipe
 
-class CodeSpectorDataPreparer:
+
+class CodeSpectorDataPreparer(BasePipe):
     def __init__(
         self,
         output_dir: str,
         compare_branch: str,
+        exclude_file_ext: list[str] | None = None,
     ):
         self.output_dir = output_dir
         self.compare_branch = compare_branch
+        self.exclude_file_ext = exclude_file_ext
 
         self.original_files_tmp = 'original_files_tmp.json'
         self.code_changes_only = 'code_changes_only.txt'
@@ -38,18 +42,18 @@ class CodeSpectorDataPreparer:
         diff_json = {'diff': '\n'.join(filtered_diff)}
         diff_filepath = os.path.join(self.output_dir, self.diff_file)
         with open(diff_filepath, 'w', encoding='utf-8') as f:
-            ujson.dump(diff_json, f, indent=4, ensure_ascii=False)
+            json.dump(diff_json, f, indent=4, ensure_ascii=False)
 
         with open(os.path.join(self.output_dir, self.original_files_tmp), 'r', encoding='utf-8') as f:
-            original_files_data = ujson.load(f)
+            original_files_data = json.load(f)
 
         with open(diff_filepath, 'r', encoding='utf-8') as f:
-            diff_data = ujson.load(f)
+            diff_data = json.load(f)
 
         combined_data = {**original_files_data, **diff_data}
 
         with open(os.path.join(self.output_dir, self.combined_file), 'w', encoding='utf-8') as f:
-            ujson.dump(combined_data, f, indent=4, ensure_ascii=False)
+            json.dump(combined_data, f, indent=4, ensure_ascii=False)
 
     def _prepare_name_only_file(self):
         changed_files = subprocess.run(
@@ -59,8 +63,9 @@ class CodeSpectorDataPreparer:
         result = {'original files': []}
 
         for file in changed_files:
-            if not file.endswith('.py'):
-                continue
+            if self.exclude_file_ext:
+                if file.endswith(tuple(self.exclude_file_ext)):
+                    continue
 
             if os.path.isfile(file):
                 with open(file, 'r', encoding='utf-8') as f:
@@ -70,12 +75,9 @@ class CodeSpectorDataPreparer:
         filepath = os.path.join(self.output_dir, self.original_files_tmp)
 
         with open(filepath, 'w', encoding='utf-8') as f:
-            ujson.dump(result, f, indent=4, ensure_ascii=False)
+            json.dump(result, f, indent=4, ensure_ascii=False)
 
-    def prepare_data(self) -> str:
+    def start(self):
         self._prepare_dir()
         self._prepare_name_only_file()
         self._prepare_diff_file()
-
-    def start(self):
-        self.prepare_data()

{codespector-0.1.2 → codespector-1.0.0}/codespector/main.py

@@ -3,8 +3,7 @@ from pathlib import Path
 import click
 from environs import Env
 
-from .controller import CodeSpectorController
-from loguru import logger
+from codespector.codespector import CodeSpector
 
 BASE_PATH = Path(__file__).parent.parent
 
@@ -12,10 +11,30 @@ env = Env()
 env.read_env(path=str(BASE_PATH / '.env'))
 
 
+@click.option(
+    '--exclude-file-ext',
+    type=list,
+    envvar='CODESPECTOR_EXCLUDE_FILE_EXT',
+    help='Exclude file extensions from the review',
+    show_envvar=True,
+)
+@click.option(
+    '--result-file',
+    type=str,
+    help='Set file for saving the result',
+    envvar='CODESPECTOR_RESULT_FILE',
+    show_envvar=True,
+)
+@click.option(
+    '--prompt-content',
+    type=str,
+    help='Prompt content which included to review prompt',
+    envvar='CODESPECTOR_PROMPT_CONTENT',
+    show_envvar=True,
+)
 @click.option(
     '--system-content',
     type=str,
-    default='Ты код ревьювер. Отвечай на русском языке.',
     envvar='CODESPECTOR_SYSTEM_CONTENT',
     show_envvar=True,
     help='Content which used in system field for agent',
@@ -23,8 +42,8 @@ env.read_env(path=str(BASE_PATH / '.env'))
 @click.option(
     '--output-dir',
     type=str,
-    default='codespector',
     envvar='CODESPECTOR_OUTPUT_DIR',
+    default='codespector',
     show_envvar=True,
     help='Select the output directory',
 )
@@ -32,16 +51,13 @@ env.read_env(path=str(BASE_PATH / '.env'))
     '-b',
     '--compare-branch',
     type=str,
-    default='develop',
     help='Select the branch to compare the current one with',
 )
 @click.option(
     '--chat-agent',
-    type=click.Choice(['codestral', 'chatgpt'], case_sensitive=False),
     envvar='CODESPECTOR_CHAT_AGENT',
     show_envvar=True,
-    default='codestral',
-    help='Choose the chat agent to use',
+    help='Choose the chat agent to use you can use one from [codestral, chatgpt, deepseek]. Or set yours chat agent',
 )
 @click.option(
     '--chat-model',
@@ -56,25 +72,11 @@ env.read_env(path=str(BASE_PATH / '.env'))
     envvar='CODESPECTOR_CHAT_TOKEN',
     show_envvar=True,
 )
-@click.option(
-    '--mode',
-    type=click.Choice(['local'], case_sensitive=False),
-    default='local',
-    help='Choose the mode of the application',
-)
 @click.version_option(message='%(version)s')
 @click.command()
 def main(*args, **kwargs):
-    return start(*args, **kwargs)
-
-
-def start(*args, **kwargs):
-    codespector = CodeSpectorController(*args, **kwargs)
-    try:
-        codespector.start()
-        logger.info('Review completed successfully.See result.txt in {} directory', kwargs['output_dir'])
-    except Exception as e:
-        logger.error('Error while review: {}', e)
+    codespector = CodeSpector.create(*args, **kwargs)
+    codespector.review()
 
 
 if __name__ == '__main__':

codespector-1.0.0/codespector/reviewer.py

@@ -0,0 +1,84 @@
+import os.path
+
+import json
+from urllib.error import HTTPError
+
+import requests
+
+from loguru import logger
+
+from codespector.errors import AppError
+from codespector.types import AgentInfo
+
+
+class CodeSpectorReviewer:
+    def __init__(
+        self,
+        diff_file: str,
+        chat_token: str,
+        chat_agent: str,
+        chat_model: str,
+        system_content: str,
+        prompt_content: str,
+        output_dir: str,
+        result_file: str,
+        agent_info: AgentInfo,
+    ):
+        self.diff_file = diff_file
+        self.chat_token = chat_token
+        self.chat_agent = chat_agent
+        self.chat_model = chat_model
+        self.system_content = system_content
+        self.prompt_content = prompt_content
+        self.output_dir = output_dir
+        self.result_file = result_file
+        self.agent_info = agent_info
+
+        self.request_file = 'request.json'
+        self.response_file = 'response.json'
+
+    def _request_to_chat_agent(self, prompt: str):
+        request_data = {
+            'model': self.agent_info.model,
+            'messages': [{'role': 'system', 'content': self.system_content}, {'role': 'user', 'content': prompt}],
+        }
+
+        with open(os.path.join(self.output_dir, self.request_file), 'w', encoding='utf-8') as f:
+            json.dump(request_data, f, indent=4, ensure_ascii=False)
+
+        response = requests.post(
+            self.agent_info.url,
+            json=request_data,
+            headers=self.agent_info.headers,
+            timeout=100,
+        )
+        response.raise_for_status()
+        return response
+
+    def send_to_review(self):
+        with open(os.path.join(self.output_dir, self.diff_file), 'r', encoding='utf-8') as f:
+            diff_data = json.load(f)
+
+        diff_content = diff_data.get('diff', '')
+        original_files = diff_data.get('original files', [])
+
+        original_files_str = json.dumps(original_files, indent=4, ensure_ascii=False)
+
+        prompt = f'{self.prompt_content}\n\nDIFF:\n{diff_content}\n\nORIGINAL FILES:\n{original_files_str}'
+        try:
+            response = self._request_to_chat_agent(prompt=prompt)
+        except HTTPError as e:
+            logger.error('Error while send request: {}', e)
+            raise AppError('Error while send request') from e
+
+        with open(os.path.join(self.output_dir, self.response_file), 'w', encoding='utf-8') as f:
+            json.dump(response.json(), f, indent=4, ensure_ascii=False)
+
+        resp = response.json()
+        clear_response = resp['choices'][0]['message']['content']
+
+        with open(os.path.join(self.output_dir, self.result_file), 'w', encoding='utf-8') as f:
+            f.write(clear_response)
+
+    def start(self):
+        self.send_to_review()

codespector-1.0.0/codespector/types.py

@@ -0,0 +1,50 @@
+from dataclasses import dataclass
+from loguru import logger
+from codespector.errors import NotValidCfgError
+
+AGENT_URL_MAPPING = {
+    'codestral': 'https://api.mistral.ai/v1/chat/completions',
+    'chatgpt': 'https://api.openai.com/v1/chat/completions',
+    'deepseek': 'https://api.deepseek.com/v1/chat/completions',
+}
+
+DEFAULT_AGENT_MODEL = {
+    'codestral': 'codestral-latest',
+    'chatgpt': 'gpt-4o',
+    'deepseek': 'deepseek-chat',
+}
+
+
+@dataclass
+class AgentInfo:
+    model: str
+    url: str
+    headers: dict
+
+    @classmethod
+    def create(
+        cls,
+        chat_agent: str,
+        chat_token: str,
+        chat_model: str | None = None,
+        completion_url: str | None = None,
+    ) -> 'AgentInfo':
+        if completion_url:
+            url = completion_url
+        else:
+            url = AGENT_URL_MAPPING.get(chat_agent)
+
+        if chat_model:
+            model = chat_model
+        else:
+            model = DEFAULT_AGENT_MODEL.get(chat_agent)
+
+        if model is None or url is None:
+            raise NotValidCfgError('Invalid chat model or completions url')
+
+        headers = {'Authorization': f'Bearer {chat_token}'}
+        return cls(
+            url=url,
+            model=model,
+            headers=headers,
+        )

{codespector-0.1.2 → codespector-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "codespector"
-version = "0.1.2"
+version = "1.0.0"
 authors = [
     { name = "vtitov", email = "v.v.titov94@gmail.com" }
 ]
@@ -12,7 +12,6 @@ dependencies = [
     "environs>=14.1.1",
     "loguru>=0.7.3",
     "requests>=2.32.3",
-    "ujson>=5.10.0",
 ]
 
 classifiers = [