codespector 0.2.0__tar.gz → 1.0.1__tar.gz

{codespector-0.2.0 → codespector-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codespector
-Version: 0.2.0
+Version: 1.0.1
 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
@@ -50,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
@@ -69,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
@@ -77,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.1/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-0.2.0 → codespector-1.0.1}/cicd_examples/.gitlab-ci.yml

@@ -4,8 +4,9 @@ workflow:
 
 variables:
   GIT_DEPTH: 0
-  CODESPECTOR_RESULT_FILE: "codespector/result.md"
-  CODESPECTOR_COMBINED_FILE: "codespector/combined.json"
+  CODESPECTOR_RESULT_FILEPATH: "codespector/result.md"
+  CODESPECTOR_COMBINED_FILEPATH: "codespector/combined.json"
+
 
 stages:
   - codespector
@@ -17,9 +18,17 @@ codespector-job:
     - 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 codestral --compare-branch origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...HEAD
     - |
-      COMMENT_CONTENT=$(cat ${CODESPECTOR_RESULT_FILE} | jq -Rs .)
+      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_FILEPATH} | jq -Rs .)
       echo "Posting comment to MR..."
       curl -X POST \
         --header "PRIVATE-TOKEN: $GITLAB_TOKEN" \
@@ -28,6 +37,6 @@ codespector-job:
         "$CI_API_V4_URL/projects/$CI_PROJECT_ID/merge_requests/$CI_MERGE_REQUEST_IID/notes"
   artifacts:
     paths:
-      - ${CODESPECTOR_RESULT_FILE}
-      - ${CODESPECTOR_COMBINED_FILE}
+      - ${CODESPECTOR_RESULT_FILEPATH}
+      - ${CODESPECTOR_COMBINED_FILEPATH}
     expire_in: 10 minutes

{codespector-0.2.0 → codespector-1.0.1}/codespector/codespector.py

@@ -18,6 +18,7 @@ class CodeSpector:
         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
@@ -30,6 +31,7 @@ class CodeSpector:
         self.pipeline = pipeline
         self.result_file = result_file
         self.chat_model = chat_model
+        self.exclude_file_exc: list[str] | None = (None,)
 
     @classmethod
     def create(
@@ -42,6 +44,7 @@ class CodeSpector:
         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,
@@ -51,6 +54,7 @@ class CodeSpector:
         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,
@@ -77,6 +81,7 @@ class CodeSpector:
             pipeline=pipeline,
             output_dir=output_dir,
             result_file=result_file,
+            exclude_file_ext=exclude_file_ext,
         )
 
     def review(self):

{codespector-0.2.0 → codespector-1.0.1}/codespector/local.py

@@ -10,9 +10,11 @@ class CodeSpectorDataPreparer(BasePipe):
         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'
@@ -61,8 +63,9 @@ class CodeSpectorDataPreparer(BasePipe):
         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:

{codespector-0.2.0 → codespector-1.0.1}/codespector/main.py

@@ -11,6 +11,13 @@ 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,
@@ -50,7 +57,7 @@ env.read_env(path=str(BASE_PATH / '.env'))
     '--chat-agent',
     envvar='CODESPECTOR_CHAT_AGENT',
     show_envvar=True,
-    help='Choose the chat agent to use you can use one from [codestral, chatgpr, deepseek]. Or set yours chat agent',
+    help='Choose the chat agent to use you can use one from [codestral, chatgpt, deepseek]. Or set yours chat agent',
 )
 @click.option(
     '--chat-model',

{codespector-0.2.0 → codespector-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "codespector"
-version = "0.2.0"
+version = "1.0.1"
 authors = [
     { name = "vtitov", email = "v.v.titov94@gmail.com" }
 ]

codespector-0.2.0/README.md

@@ -1,77 +0,0 @@
-# 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.2.0/cicd_examples/.github-ci.yml

@@ -1,64 +0,0 @@
-name: Codespector Review
-
-on:
-  pull_request:
-    types: [opened, synchronize]
-
-env:
-  CODESPECTOR_RESULT_FILE: "codespector/result.md"
-  CODESPECTOR_COMBINED_FILE: "codespector/combined.json"
-
-jobs:
-  codespector:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y jq
-          pip install codespector
-
-      - name: Fetch target branch
-        run: git fetch origin ${{ github.base_ref }}
-
-      - name: Run Codespector
-        env:
-          CODESPECTOR_CHAT_TOKEN: ${{ secrets.CODESPECTOR_CHAT_TOKEN }}
-          CODESPECTOR_SYSTEM_CONTENT: ${{ secrets.CODESPECTOR_SYSTEM_CONTENT }}
-          CODESPECTOR_PROMPT_CONTENT: ${{ secrets.CODESPECTOR_PROMPT_CONTENT }}
-          CODESPECTOR_RESULT_FILE: ${{ secrets.CODESPECTOR_RESULT_FILE }}
-          CODESPECTOR_CHAT_AGENT: ${{ secrets.CODESPECTOR_CHAT_AGENT }}
-        run: |
-          codespector \
-            --chat-token $CODESPECTOR_CHAT_TOKEN \
-            --chat-agent $CODESPECTOR_CHAT_AGENT \
-            --compare-branch origin/${{ github.base_ref }}...HEAD
-            --system-content $CODESPECTOR_SYSTEM_CONTENT
-            --prompt-content $CODESPECTOR_PROMPT_CONTENT
-            --result-file $CODESPECTOR_RESULT_FILE
-
-      - name: Post review comment
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          COMMENT_CONTENT=$(cat ${CODESPECTOR_RESULT_FILE} | jq -Rs .)
-          gh pr comment ${{ github.event.pull_request.number }} --body "${COMMENT_CONTENT}"
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: codespector-results
-          path: |
-            ${{ env.CODESPECTOR_RESULT_FILE }}
-            ${{ env.CODESPECTOR_COMBINED_FILE }}
-          retention-days: 1