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.
Project description
code-savior
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
- Install the package via pip:
pip install code-savior
- Add files to the staging area using git:
git add .
- Run
code-savior
: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的描述文字。它支持多种语言,并计划在未来扩展其功能,以自动生成代码文档。
安装和使用方法
- 通过pip安装此包:
pip install code-savior
- 使用git命令将文件添加到暂存区:
git add .
- 运行
code-savior
:code-savior
工具会自动为您生成commit消息,并在提交前询问您是否确认。
相关可选项的配置
敬请期待。
自动输出代码文档
敬请期待。
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file code-savior-0.2.tar.gz
.
File metadata
- Download URL: code-savior-0.2.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69cf5f26e3a617e8fb6dee44fe0aa62c51b0079bdcf9e902d22a12d4c69c23dd |
|
MD5 | 794af9be03514622cea6dbc60ec0e5b3 |
|
BLAKE2b-256 | cdb7d8ab38e2230452e217c4d1c4bf8f3fa23bf0f68f086dd1276c14f66efb64 |
File details
Details for the file code_savior-0.2-py3-none-any.whl
.
File metadata
- Download URL: code_savior-0.2-py3-none-any.whl
- Upload date:
- Size: 12.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82fd563053cfc5bebca13140ffa8d7306e7d1b801ebb63df88c5a44f36ad8c0a |
|
MD5 | 722ef11259029f59ad97fb1059b54b0b |
|
BLAKE2b-256 | 8ecbbedef7e6f339b43ba1e6edd611bb0f33ebe61b08e0d5501b18f508416375 |