codespector 0.1.0__py3-none-any.whl

codespector/clients/codestral.py

@@ -0,0 +1,5 @@
+import ujson
+
+
+def chat_completion(diff: str):
+    pass

codespector/controller.py

@@ -0,0 +1,44 @@
+from codespector import local
+from loguru import logger
+
+
+class CodeSpectorController:
+    __slots__ = (
+        'mode',
+        'chat_token',
+        'chat_agent',
+        'compare_branch',
+        'output_dir',
+        'system_content',
+        'chat_model',
+    )
+
+    def __init__(
+        self,
+        mode: str,
+        chat_token: str,
+        chat_agent: str,
+        compare_branch: str,
+        output_dir: str,
+        system_content: str,
+        chat_model: str,
+    ):
+        self.mode = mode
+        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.chat_model = chat_model
+
+    def start(self):
+        codespector = local.LocalCodespector(
+            chat_token=self.chat_token,
+            chat_agent=self.chat_agent,
+            compare_branch=self.compare_branch,
+            output_dir=self.output_dir,
+            system_content=self.system_content,
+            chat_model=self.chat_model,
+        )
+        codespector.review()
+        logger.info('Review completed successfully.See result.txt in {} directory', self.output_dir)

codespector/local/__init__.py

@@ -0,0 +1 @@
+from .main import LocalCodespector

codespector/local/main.py

@@ -0,0 +1,35 @@
+from .prepare import CodeSpectorDataPreparer
+from .reviewer import CodeSpectorReviewer
+
+
+class LocalCodespector:
+    def __init__(
+        self,
+        chat_token: str,
+        chat_agent: str,
+        compare_branch: str,
+        output_dir: str,
+        system_content: str,
+        chat_model: str,
+    ):
+        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.chat_model = chat_model
+
+        self.data_preparer = CodeSpectorDataPreparer(output_dir=self.output_dir, compare_branch=self.compare_branch)
+        self.reviewer = CodeSpectorReviewer(
+            diff_file=self.data_preparer.combined_file,
+            chat_token=self.chat_token,
+            chat_agent=self.chat_agent,
+            system_content=self.system_content,
+            output_dir=self.output_dir,
+            chat_model=self.chat_model,
+        )
+        self.processes = [self.data_preparer, self.reviewer]
+
+    def review(self):
+        for process in self.processes:
+            process.start()

codespector/local/prepare.py

@@ -0,0 +1,81 @@
+import ujson
+import subprocess
+import os
+
+
+class CodeSpectorDataPreparer:
+    def __init__(
+        self,
+        output_dir: str,
+        compare_branch: str,
+    ):
+        self.output_dir = output_dir
+        self.compare_branch = compare_branch
+
+        self.original_files_tmp = 'original_files_tmp.json'
+        self.code_changes_only = 'code_changes_only.txt'
+        self.diff_file = 'diff.json'
+        self.combined_file = 'combined.json'
+
+    def _prepare_dir(self):
+        if not os.path.exists(self.output_dir):
+            os.makedirs(self.output_dir)
+
+    def _prepare_diff_file(self):
+        diff_output = subprocess.run(['git', 'diff', self.compare_branch], stdout=subprocess.PIPE, text=True).stdout
+
+        filtered_diff = [
+            line
+            for line in diff_output.splitlines()
+            if (line.startswith('+') or line.startswith('-'))
+            and not line.startswith('+++')
+            and not line.startswith('---')
+        ]
+
+        with open(os.path.join(self.output_dir, self.code_changes_only), 'w', encoding='utf-8') as f:
+            f.write('\n'.join(filtered_diff))
+
+        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)
+
+        with open(os.path.join(self.output_dir, self.original_files_tmp), 'r', encoding='utf-8') as f:
+            original_files_data = ujson.load(f)
+
+        with open(diff_filepath, 'r', encoding='utf-8') as f:
+            diff_data = ujson.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)
+
+    def _prepare_name_only_file(self):
+        changed_files = subprocess.run(
+            ['git', 'diff', '--name-only', self.compare_branch], stdout=subprocess.PIPE, text=True
+        ).stdout.splitlines()
+
+        result = {'original files': []}
+
+        for file in changed_files:
+            if not file.endswith('.py'):
+                continue
+
+            if os.path.isfile(file):
+                with open(file, 'r', encoding='utf-8') as f:
+                    content = f.read()
+                result['original files'].append({'filename': file, 'content': content})
+
+        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)
+
+    def prepare_data(self) -> str:
+        self._prepare_dir()
+        self._prepare_name_only_file()
+        self._prepare_diff_file()
+
+    def start(self):
+        self.prepare_data()

codespector/local/reviewer.py

@@ -0,0 +1,109 @@
+import os.path
+from dataclasses import dataclass
+from typing import Self
+
+import ujson
+import requests
+
+from loguru import logger
+
+AGENT_URL_MAPPING = {
+    'codestral': 'https://api.mistral.ai/v1/chat/completions',
+    'chatgpt': 'https://api.openai.com/v1/chat/completions',
+}
+
+DEFAULT_AGENT_MODEL = {'codestral': 'codestral-latest', 'chatgpt': 'gpt-4o'}
+
+
+@dataclass
+class AgentInfo:
+    model: str
+    url: str
+    headers: dict
+
+    @classmethod
+    def create(cls, chat_agent: str, chat_token: str, chat_model: str | None = None) -> Self:
+        url = AGENT_URL_MAPPING[chat_agent]
+        model = chat_model if chat_model else DEFAULT_AGENT_MODEL[chat_agent]
+        headers = {'Authorization': f'Bearer {chat_token}'}
+        return cls(
+            url=url,
+            model=model,
+            headers=headers,
+        )
+
+
+class CodeSpectorReviewer:
+    def __init__(
+        self,
+        diff_file: str,
+        chat_token: str,
+        chat_agent: str,
+        chat_model: str | None,
+        system_content: str,
+        output_dir: str,
+    ):
+        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.output_dir = output_dir
+
+        self.request_file = 'request.json'
+        self.response_file = 'response.json'
+        self.result_file = 'result.txt'
+
+    def _request_to_chat_agent(self, prompt: str):
+        agent_info = AgentInfo.create(self.chat_agent, self.chat_token, self.chat_model)
+        request_data = {
+            'model': 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:
+            ujson.dump(request_data, f, indent=4, ensure_ascii=False)
+
+        response = requests.post(
+            agent_info.url,
+            json=request_data,
+            headers=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 = ujson.load(f)
+
+        diff_content = diff_data.get('diff', '')
+        original_files = diff_data.get('original files', [])
+
+        original_files_str = ujson.dumps(original_files, indent=4, ensure_ascii=False)
+
+        prompt = (
+            'Пожалуйста, проверь следующие изменения в коде на наличие очевидных проблем с качеством или безопасностью. '
+            'Предоставь краткий отчет в формате markdown:\n\n'
+            'DIFF:\n'
+            f'{diff_content}\n\n'
+            'ORIGINAL FILES:\n'
+            f'{original_files_str}'
+        )
+        try:
+            response = self._request_to_chat_agent(prompt=prompt)
+        except Exception as e:
+            logger.error('Error while send request: {}', e)
+            raise e
+
+        with open(os.path.join(self.output_dir, self.response_file), 'w', encoding='utf-8') as f:
+            ujson.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/main.py

@@ -0,0 +1,81 @@
+from pathlib import Path
+
+import click
+from environs import Env
+
+from .controller import CodeSpectorController
+from loguru import logger
+
+BASE_PATH = Path(__file__).parent.parent
+
+env = Env()
+env.read_env(path=str(BASE_PATH / '.env'))
+
+
+@click.option(
+    '--system-content',
+    type=str,
+    default='Ты код ревьювер. Отвечай на русском языке.',
+    envvar='CODESPECTOR_SYSTEM_CONTENT',
+    show_envvar=True,
+    help='Content which used in system field for agent',
+)
+@click.option(
+    '--output-dir',
+    type=str,
+    default='codespector',
+    envvar='CODESPECTOR_OUTPUT_DIR',
+    show_envvar=True,
+    help='Select the output directory',
+)
+@click.option(
+    '-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',
+)
+@click.option(
+    '--chat-model',
+    type=str,
+    envvar='CODESPECTOR_CHAT_MODEL',
+    show_envvar=True,
+    help='Choose the chat model to use',
+)
+@click.option(
+    '--chat-token',
+    type=str,
+    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)
+
+
+if __name__ == '__main__':
+    main()

codespector-0.1.0.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: codespector
+Version: 0.1.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
+Author-email: vtitov <v.v.titov94@gmail.com>
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+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
+
+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:
+  --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.
+```
+
+### Example
+
+To run a code review, use the following command:
+
+```sh
+codespector --chat-token YOUR_CHAT_TOKEN --chat-agent codestral --compare-branch develop
+```
+
+## 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_SYSTEM_CONTENT=Ты код ревьювер. Отвечай на русском языке.
+CODESPECTOR_OUTPUT_DIR=codespector
+CODESPECTOR_CHAT_AGENT=codestral
+CODESPECTOR_CHAT_MODEL=codestral-latest
+CODESPECTOR_CHAT_TOKEN=YOUR_CHAT_TOKEN
+```
+
+## 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-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+codespector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codespector/controller.py,sha256=z7TznOY6SBXCirBFpRO4bSh0_XY3gjMjUmnlFDkkc7Q,1211
+codespector/main.py,sha256=y_mij-Tj_LaFQ2DUn8wAKJLKYy60jvb162UBnI1QWGM,1950
+codespector/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codespector/clients/codestral.py,sha256=MV6_m9IMYzTHX5AS9UoPkhGUNHRoOXgIpTZ8uHfwZgQ,56
+codespector/local/__init__.py,sha256=spdqmAUYVjE-6RJUNUQ63ymwBY3svwC1gQp5QHAZdwg,35
+codespector/local/main.py,sha256=JQb8mBQEjxsjNnjpqCOP84ZF92T2DjTzCslRdHQLqlg,1136
+codespector/local/prepare.py,sha256=uqQft4RDH_5Rms3fGROc_fzCCRVcu-BxDzCAVF16buo,2821
+codespector/local/reviewer.py,sha256=3dyopW6Y79M3i5_vruzk6Kf_WfXK1Ac8PLGrPI8meTU,3611
+codespector-0.1.0.dist-info/METADATA,sha256=4ml2ECi_NgJ0siZMd3S9pV_x3v68YszFjDO-fqMNG6U,3160
+codespector-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+codespector-0.1.0.dist-info/entry_points.txt,sha256=QlHn96KY8vzY1sOweKIuZOAQrSVse6h3v57vkwmHmJg,54
+codespector-0.1.0.dist-info/licenses/LICENSE,sha256=Eta34ENUL_dZWy-prVNucMkoA38WIqiO9pKTUYiuT_A,1070
+codespector-0.1.0.dist-info/RECORD,,

codespector-0.1.0.dist-info/WHEEL

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

codespector-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codespector = codespector.main:main

codespector-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vladimir-Titov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.