https://github.com/nneji123/aicommit
An AI-powered git commit message generator written in python.
https://github.com/nneji123/aicommit
cli command-line-tool git openai package pypi python
Last synced: 6 months ago
JSON representation
An AI-powered git commit message generator written in python.
- Host: GitHub
- URL: https://github.com/nneji123/aicommit
- Owner: Nneji123
- License: mit
- Created: 2023-02-15T19:39:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-16T18:39:54.000Z (over 2 years ago)
- Last Synced: 2025-05-04T21:57:10.257Z (6 months ago)
- Topics: cli, command-line-tool, git, openai, package, pypi, python
- Language: Python
- Homepage: https://pypi.org/project/ai-commits/
- Size: 69.3 KB
- Stars: 20
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
An AI-powered git commit message generator written in python. Inspired by @Nutlope
[](https://pypi.org/project/ai-commits/)
[](https://pypi.org/project/ai-commits/)
[](https://pepy.tech/project/ai-commits)
[](https://raw.githubusercontent.com/Nneji123/aicommit/LICENSE)
# Description
AICommits is a Python script that generates a git commit message using OpenAI's GPT-3 language model. The script takes the git diff of the staged changes and generates a commit message using GPT-3.
The generated commit message is presented to the user who has the option to accept or reject it. If the user accepts the commit message, the script commits the changes using the generated message.
The script requires an OpenAI API key, which can be obtained from the OpenAI website.
# Dependencies
Python 3.6 or higher
openai 0.10.2
inquirer 3.7.0
python-dotenv 0.19.1
# Features
In this version, AICommit provides the following features:
- Automatic generation of commit messages based on the diff of staged changes.
- Support for conventional commit messages.
- Language selection for generated commit messages.
- User selection of generated commit messages.
- Support for specifying diff per file.
# Installation and Usage
To use AICommits, do the following:
1. Export your OpenAI API key as an environment variable by running:
```bash
export OPENAI_API_KEY=YOUR_API_KEY
```
2. install aicommit from pypi by running:
```bash
pip install ai_commits
```
Then, run the script using the command `aicommit`.
This will prompt AICOMMIT to generate up to 5 commit messages based on the diff of staged changes. The user can then select one of the generated commit messages to use as the commit message for their changes.
If the --diff-per-file flag is included, AICOMMIT will generate separate commit messages for each file.
If the --conventional flag is included, AICOMMIT will generate commit messages in conventional commit format.
If the --language flag is included, AICOMMIT will generate commit messages in the specified language.
## Install from Source
To install AICommits from source, follow these steps:
1. Clone the repository using the command git clone https://github.com/nneji123/aicommit.git.
2. Navigate to the project directory using the command `cd aicommit`.
3. Install the required dependencies by running pip install -r requirements.txt.
4. Set your OpenAI API key as an environment variable by running export OPENAI_API_KEY=YOUR_API_KEY.
5. Run the script using the command `python "src/ai_commits.py"`.
The script will prompt you to confirm the generated commit message. If you accept the message, the changes will be committed using the generated message.
# Changelog
## v1.0.0 (2023-02-16)
- Added support for generating commit messages in multiple languages
- Improved performance when generating commit messages for large diffs
- Added ability to select from multiple generated commit messages using the inquirer library
- Fixed various bugs and improved error handling
v0.0.5 (2023-02-15)
- Fixed a bug that caused the script to fail when no changes were staged
v0.0.4 [Initial Release] (2023-02-15)
- Initial release of aicommits
- Supports generating conventional commit messages
- Supports generating commit messages based on the changes in the staged files
- Uses OpenAI's GPT-3 to generate commit messages
# Contributing
Open an issue or submit a pull request if you want to contribute to the project.
# License
[MIT](https://github.com/Nneji123/aicommit/LICENSE.md)