Metadata-Version: 2.1
Name: code-savior
Version: 0.2
Summary: code-savior: An AI-powered tool to automatically generate descriptive git commit messages. Supports multiple languages and aims to provide auto-generated code documentation in the future.
Home-page: https://github.com/your_username/code-savior
Author: Yuzhe Wang (GitHub: Orwlit)
Author-email: orwlit31@outlook.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: inquirer
Requires-Dist: rich
Requires-Dist: configparser
Requires-Dist: argparse
Requires-Dist: openai

# code-savior

[English](#english-version) | [中文](#中文版本)

---

## English Version

### Introduction

`code-savior` is a Python package that empowers AI to automatically generate git commit messages. It supports multiple languages and has plans to extend its capabilities to auto-generate code documentation in the future.

### Installation and Usage

1. Install the package via pip:
   ```shell
   pip install code-savior
   ```
2. Add files to the staging area using git:
    ```shell
    git add .
    ```
3. Run `code-savior`:
    ```shell
    code-savior
    ```
The tool will automatically generate a commit message and prompt you for confirmation before committing.

### Configuration Options
Comming soon.

### Auto-generate Code Documentation
Comming soon.


## 中文版本
### 介绍
code-savior 是一个Python包，可以让AI自动生成git commit的描述文字。它支持多种语言，并计划在未来扩展其功能，以自动生成代码文档。

### 安装和使用方法
1. 通过pip安装此包：
    ```shell
    pip install code-savior
    ```
2. 使用git命令将文件添加到暂存区：
    ```shell
    git add .
    ```
3. 运行 `code-savior`：
    ```shell
    code-savior
    ```
工具会自动为您生成commit消息，并在提交前询问您是否确认。

### 相关可选项的配置
敬请期待。

### 自动输出代码文档
敬请期待。
