commit-maker 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

commit_maker/mistral.py

@@ -0,0 +1,68 @@
+# Класс для использования API Mistral AI
+from typing import Optional
+
+import requests
+import rich.console
+
+console = rich.console.Console()
+
+
+class MistralAI:
+    """Класс для общения с MistralAI.
+    Написан с помощью requests."""
+
+    def __init__(
+        self,
+        api_key: str,
+        model: str = "mistral-small-latest",
+    ):
+        """Инициализация класса
+
+        Args:
+            api_key (str): Апи ключ MistralAI
+        """
+        self.url = "https://api.mistral.ai/v1/chat/completions"
+        self.api_key = api_key
+        self.headers = {
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "Authorization": f"Bearer {api_key}",
+        }
+        self.model = model
+
+    def message(
+        self,
+        messages: list[dict[str]],
+        timeout: Optional[int],
+        temperature: float,
+    ) -> str:
+        """Функция для общения с моделью
+
+        Args:
+            messages (list[dict[str]]): Список сообщений
+            timeout (int): Таймаут(время ожидания, в сек.)
+            role (str, optional): Роль сообщения. Defaults to "user".
+            temperature (float, optional): Температура общения. Defaults to 0.7. #noqa
+
+        Returns:
+            str: _description_
+        """
+        data = {
+            "model": self.model,
+            "messages": messages,
+            "temperature": 0.7,
+        }
+        try:
+            response = requests.post(
+                url=self.url,
+                json=data,
+                headers=self.headers,
+                timeout=timeout,
+            )
+            response.raise_for_status()
+            return response.json()["choices"][0]["message"]["content"]
+
+        except requests.exceptions.RequestException:
+            console.print_exception()
+        except KeyError:
+            console.print_exception()

commit_maker/ollama.py

@@ -0,0 +1,65 @@
+# Класс для использования API Ollama
+from typing import Optional
+
+import requests
+import rich.console
+
+console = rich.console.Console()
+
+
+class Ollama:
+    """Класс для общения с локальными моделями Ollama.
+    Написан с помощью requests."""
+
+    def __init__(
+        self,
+        model: str,
+    ):
+        """Инициализация класса"""
+        self.model = model
+        self.url = "http://localhost:11434/api/chat"
+        self.headers = {
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+        }
+
+    def message(
+        self,
+        messages: list[dict[str]],
+        timeout: Optional[int],
+        temperature: float,
+    ) -> str:
+        """Функция сообщения
+
+        Args:
+            messages (list[dict[str]]): Список сообщений
+            timeout (int): Таймаут ожидания сообщения
+            model (str): Модель, с которой будем общаться
+            temperature (float, optional): Температура общения. Defaults to 0.7
+
+        Returns:
+            str: Json-ответ/Err
+        """
+        data = {
+            "model": self.model,
+            "messages": messages,
+            "options": {
+                "temperature": temperature,
+            },
+            "stream": False,
+        }
+
+        try:
+            response = requests.post(
+                url=self.url,
+                json=data,
+                headers=self.headers,
+                timeout=timeout,
+            )
+            response.raise_for_status()  # выбросит ошибку при плохом статусе
+            return response.json()["message"]["content"]
+
+        except requests.exceptions.RequestException:
+            console.print_exception()
+        except KeyError:
+            console.print_exception()

commit_maker/rich_custom_formatter.py

@@ -0,0 +1,11 @@
+# Кастомный форматтер для --help
+import rich_argparse
+
+
+class CustomFormatter(rich_argparse.RichHelpFormatter):
+    styles = {
+        "argparse.args": "cyan bold",
+        "argparse.groups": "green bold",
+        "argparse.metavar": "dark_cyan",
+        "argparse.prog": "dark_green bold",
+    }

commit_maker-0.3.0.dist-info/METADATA

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: commit-maker
+Version: 0.3.0
+Summary: CLI utility that generates commit messages using AI
+Author-email: Alex Bulgakov <sashayerty@ya.ru>
+License: MIT
+Project-URL: Homepage, https://github.com/sashayerty/commit_maker
+Project-URL: Repository, https://github.com/sashayerty/commit_maker
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.3
+Requires-Dist: rich-argparse>=1.7.0
+Dynamic: license-file
+
+# Commit Maker [![Created with Python](https://img.shields.io/badge/Created_with-Python-blue)](https://www.python.org/) [![Created with uv](https://img.shields.io/badge/Created_with-uv-purple)](https://docs.astral.sh/uv/) [![Created with ollama](https://img.shields.io/badge/Created_with-ollama-white)](https://ollama.com/)
+![Demo](./commit_maker.svg)
+
+## All commits in the repository are generated by this program
+This CLI utility automatically creates meaningful git commit messages using local models via ollama/Mistral AI API based on the output of `git status` and `git diff` commands. It is implemented as a single file for easy conversion into an executable.
+
+1. [Features](#features)
+2. [Requirements](#requirements)
+   - [Mistral](#getting-a-mistral-ai-api-key)
+   - [Ollama](#installing-ollama)
+3. [Installation](#installation)
+4. [Setting up environment variables](#setting-up-environment-variables)
+   - [Windows](#windows)
+   - [Linux/MacOS](#linuxmacos)
+5. [Usage](#usage)
+6. [Notes](#notes)
+7. [License](#license)
+
+## Features
+- Automatically generates meaningful commit messages in Russian
+- Interactive confirmation before creating a commit
+- Works with both existing and new Git repositories
+- Uses local models/Mistral AI API to generate commit messages based on repository changes
+
+## Requirements
+- Git installed on your system
+- Mistral API key (for using Mistral AI API)
+- Ollama installed on your system (for using local models)
+
+### Getting a Mistral AI API Key
+To get a key, go to the Mistral console website [Mistral](https://console.mistral.ai/api-keys) and create an API key. You need a [Mistral](https://auth.mistral.ai/ui/login) account to do this.
+
+### Installing Ollama
+To install ollama, go to the [Ollama](https://ollama.com/download) website and choose the method suitable for your system.
+
+## Installation
+
+### From Source
+When installing from source, use the `-e` flag to always have the latest version of the utility after `git pull` **without reinstallation**!
+```bash
+git clone https://github.com/Sashayerty/commit_maker
+cd ./commit_maker
+# Windows
+pip install -r requirements.txt
+# Linux/MacOS
+pip3 install -r requirements.txt
+```
+
+## Setting Up Environment Variables
+After installing the utility, you must add the `MISTRAL_API_KEY` environment variable.
+
+### Windows
+1. Open Command Prompt as Administrator
+2. Set the Mistral API key:
+   ```cmd
+   setx MISTRAL_API_KEY "your_api_key_here"
+   ```
+3. Restart your terminal/IDE to apply the changes
+
+### Linux/macOS
+1. Open the terminal
+2. Add to your shell configuration file (`~/.bashrc`, `~/.zshrc`, or `~/.bash_profile`):
+   ```bash
+   export MISTRAL_API_KEY="your_api_key_here"
+   ```
+3. Reload the configuration:
+   ```bash
+   source ~/.bashrc  # or whichever file you edited
+   ```
+
+## Usage
+```bash
+commit_maker [OPTION] [VALUE]
+```
+
+### Usage Examples
+**-h**, **--help** - display help  
+**-l**, **--local-models** - use local models  
+**-m**, **--max-symbols** - limit the length of the commit message  
+**-M**, **--model** - specify which local model to use (with **-l**)  
+**-d**, **--dry-run** - display the message based on staged changes without creating a commit  
+**-t**, **--temperature** - model temperature when creating the message  
+**-e**, **--exclude** - files to ignore when creating the commit message  
+**-w**, **--wish** - wishes/edits for the message  
+**-L**, **--language** - change language of commits  
+**-V**, **--version** - show version  
+
+1. Use local models, limit commit message length to 300 characters, use qwen2.5:12b
+   ```bash
+   commit_maker -l -m 300 -M qwen2.5:12b
+   ```
+2. Use Mistral, temperature 1.3, dry run
+   ```bash
+   commit_maker -t 1.3 -d
+   ```
+3. Local models, interactive model selection
+   ```bash
+   commit_maker -l
+   ```
+4. Local models, message length 100 characters, ignore `uv.lock`, wish "Mention the README.md change"
+   ```bash
+   commit_maker -l -m 100 -e "./uv.lock" -w "Mention the README.md change"
+   ```
+
+## Notes
+- To view all possible script execution options, add the `--help` flag
+- The script will show the generated commit message before creating it
+- You can regenerate the message by pressing `r` when prompted for confirmation
+- By default, messages are generated in Russian (can be changed in the script)
+
+## License
+Commit Maker is licensed under [MIT](LICENSE)

commit_maker-0.3.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+commit_maker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+commit_maker/colored.py,sha256=yxlMviPaEgBXl3ukEGVdIzRSGtW9CwRLchPkA_FVu6U,1664
+commit_maker/custom_int_prompt.py,sha256=DDqAOaVYYMrudz2goo4N43kVGrox0xtpaBiO4Dvhi-c,183
+commit_maker/cut_think_part.py,sha256=DSp5IRT5tg6wu3rZXhm7R_4muZ3KEdl8eyP3T0Kgrok,143
+commit_maker/main.py,sha256=NSV5gFDf3i4ScY5Z2TYRIkNFw1x7viS1JCaAd1xui78,16874
+commit_maker/mistral.py,sha256=XZrSXFm0ga173KPz91HRSqJ8aiid1XljlE9LonrCJrY,2030
+commit_maker/ollama.py,sha256=J-_5BR9zMDaDWj_VYnlo-wUmKf-kII86wPWQIVj2kJc,1953
+commit_maker/rich_custom_formatter.py,sha256=QFg51c1nTfCUS1bgcaWySjPHMJy2u2IbexNDL_0FgUI,318
+commit_maker-0.3.0.dist-info/licenses/LICENSE,sha256=l88G-hzmKpm5x5R2QG4r_MMJv7PKfr9ubE-VLQ3XMBM,1070
+commit_maker-0.3.0.dist-info/METADATA,sha256=xuwtlIYt6sjttLhvQCCkeW0-OVklsDUUwmbarALittM,4828
+commit_maker-0.3.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+commit_maker-0.3.0.dist-info/entry_points.txt,sha256=Mw8sNx-b56y6XLyq7fw9GWuoiuVcq40M1dNKYphh7us,56
+commit_maker-0.3.0.dist-info/top_level.txt,sha256=yQcvhH10NmLr9i84KxdAMPG7zVQXWTyT6Ev6E3v6UdU,13
+commit_maker-0.3.0.dist-info/RECORD,,

{commit_maker-0.2.2.dist-info → commit_maker-0.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

commit_maker-0.2.2.dist-info/METADATA

@@ -1,154 +0,0 @@
-Metadata-Version: 2.4
-Name: commit-maker
-Version: 0.2.2
-Summary: CLI-утилита для генерации git-коммитов с помощью ИИ
-Author-email: Alex Bulgakov <sashayerty@ya.ru>
-License: MIT
-Project-URL: Homepage, https://github.com/sashayerty/commit_maker
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.32.3
-Requires-Dist: rich-argparse>=1.7.0
-Dynamic: license-file
-
-# Commit Maker [![Created with Python](https://img.shields.io/badge/Created_with-Python-blue)](https://www.python.org/) [![Created with uv](https://img.shields.io/badge/Created_with-uv-purple)](https://docs.astral.sh/uv/) [![Created with ollama](https://img.shields.io/badge/Created_with-ollama-white)](https://ollama.com/) [![PyPi](https://img.shields.io/badge/Available_on-pypi-orange)](https://pypi.org/project/commit-maker/)
-
-![Демонстрация](./commit_maker.svg)
-
-## Все коммиты в репозитории - результат работы программы
-
-Эта CLI-утилита автоматически создает осмысленные сообщения для git-коммитов, используя локальные модели через ollama/Mistral AI API на основе вывода команд `git status` и `git diff`. Реализована в виде одного файла для удобства перевода в исполняемый файл.
-
-1. [Возможности](#возможности)
-2. [Требования](#требования)
-   - [Mistral](#получение-api-ключа-mistral-ai)
-   - [Ollama](#установка-ollama)
-3. [Установка](#установка)
-4. [Настройка переменных окружения](#настройка-переменных-окружения)
-   - [Windows](#windows)
-   - [Linux/MacOS](#linuxmacos)
-5. [Использование](#использование)
-6. [Примечания](#примечания)
-7. [Лицензия](#лицензия)
-
-## Возможности
-
-- Автоматически генерирует содержательные сообщения коммитов на русском языке
-- Интерактивное подтверждение перед созданием коммита
-- Работает как с существующими Git-репозиториями, так и с новыми
-- Использование локальных моделей/Mistral AI API для формирования сообщений коммитов на основе изменений в репозитории.
-
-## Требования
-
-- Установленный Git в системе
-- API-ключ Mistral (для использования Mistral AI API)
-- Установленная ollama в системе (для использования локальных моделей)
-
-### Получение API ключа Mistral AI
-
-Для получения ключа необходимо перейти сайт консоли [Mistral](https://console.mistral.ai/api-keys) и создать API ключ. Для получения необходим аккаунт [Mistral](https://auth.mistral.ai/ui/login).
-
-### Установка ollama
-
-Для установки ollama переходим на сайт [Ollama](https://ollama.com/download) и выбираем способ, подходящий для Вашей системы.
-
-## Установка
-
-### Pip
-
-Установка последнего релиза с pypi.
-```bash
-# Windows
-pip install commit_maker
-# Linux/MacOS
-pip3 install commit_maker
-```
-
-### Из исходников
-
-При установке из исходников используется флаг `-e`, что позволяет после `git pull` иметь сразу же свежую версию утилиты **без переустановки**!
-```bash
-git clone https://github.com/Sashayerty/commit_maker
-cd ./commit_maker
-# Windows
-pip install -r requirements.txt
-# Linux/MacOS
-pip3 install -r requirements.txt
-```
-
-## Настройка переменных окружения
-
-После установки утилиты нужно обязательно добавить переменную окружения `MISTRAL_API_KEY`
-
-### Windows
-
-1. Откройте Командную строку от имени Администратора
-2. Установите API-ключ Mistral:
-
-   ```cmd
-   setx MISTRAL_API_KEY "ваш_api_ключ_здесь"
-   ```
-
-3. Перезапустите терминал/IDE для применения изменений
-
-### Linux/macOS
-
-1. Откройте терминал
-2. Добавьте в файл конфигурации вашей оболочки (`~/.bashrc`, `~/.zshrc` или `~/.bash_profile`):
-
-   ```bash
-   export MISTRAL_API_KEY="ваш_api_ключ_здесь"
-   ```
-
-3. Перезагрузите конфигурацию:
-
-   ```bash
-   source ~/.bashrc  # или другой файл, который вы редактировали
-   ```
-
-## Использование
-
-   ```bash
-   commit_maker [OPTION] [VALUE]
-   ```
-
-### Пример использования
-
-**`-h`**, **`--help`** - вывод помощи  
-**`-l`**, **`--local-models`** - использование локальных моделей  
-**`-m`**, **`--max-symbols`** - ограничение длины сообщения коммита  
-**`-M`**, **`--model`** - какую локальную модель использовать (при **`-l`**)  
-**`-d`**, **`--dry-run`** - вывод сообщения на основе зайстейдженных изменений, без создания коммита  
-**`-t`**, **`--temperature`** - температура модели при создании месседжа  
-**`-e`**, **`--exclude`** - файлы, которые нужно игнорировать при создании сообщения коммита  
-**`--version`** - показывает версию
-
-1. Используем локальные модели, ограничение длины сообщения коммита 300 символов, используем qwen2.5:12b
-
-   ```bash
-   commit_maker -l -m 300 -M qwen2.5:12b 
-   ```
-
-2. Используем Mistral, температура 1.3, dry run
-
-   ```bash
-   commit_maker -t 1.3 -d
-   ```
-
-3. Локальные модели, интерактивный выбор модели
-
-   ```bash
-   commit_maker -l
-   ```
-
-## Примечания
-
-- Для просмотра всех возможных опций выполнения скрипта добавьте флаг `--help`
-- Скрипт покажет сгенерированное сообщение коммита перед его созданием
-- Вы можете повторно сгенерировать сообщение, нажав `r` при запросе подтверждения
-- По умолчанию сообщения генерируются на русском языке (можно изменить в скрипте)
-
-## Лицензия
-
-Commit Maker лицензирован [MIT](LICENSE)

commit_maker-0.2.2.dist-info/RECORD

@@ -1,8 +0,0 @@
-commit_maker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-commit_maker/main.py,sha256=wJJrStnKSMrrGod9vs_yEpN-LYlnHeARCk5NnNc3hSo,21636
-commit_maker-0.2.2.dist-info/licenses/LICENSE,sha256=l88G-hzmKpm5x5R2QG4r_MMJv7PKfr9ubE-VLQ3XMBM,1070
-commit_maker-0.2.2.dist-info/METADATA,sha256=vZMwKZYKhaUcpzg0piWYAzd9GPAZ03DfaFwGiFP1yI4,7238
-commit_maker-0.2.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-commit_maker-0.2.2.dist-info/entry_points.txt,sha256=Mw8sNx-b56y6XLyq7fw9GWuoiuVcq40M1dNKYphh7us,56
-commit_maker-0.2.2.dist-info/top_level.txt,sha256=yQcvhH10NmLr9i84KxdAMPG7zVQXWTyT6Ev6E3v6UdU,13
-commit_maker-0.2.2.dist-info/RECORD,,