commitgpt assists developers in generating high-quality commit messages for their version control systems, such as git.
Project description
commitgpt
commitgpt assists developers in generating high-quality commit messages for their version control systems, such as git.
Features
- Generate commit messages from OpenAI's GPT-3 API based on the changes in the diff
- Configurable commit message guidelines
- Configurable OpenAI GPT-3 agent role
Prerequisites
- An OpenAI API key
- Python 3.6 or higher
- Pip
- Git
Installation
pip install commitgpt
Usage
commitgpt setup
Example
Make a change to a file, then run git diff to see the changes. Then, run commitgpt to generate a commit message.
commitgpt
Contributing
See CONTRIBUTING.md
License
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
commitgpt-1.1.0.tar.gz
(20.7 kB
view details)
Built Distribution
commitgpt-1.1.0-py3-none-any.whl
(23.0 kB
view details)
File details
Details for the file commitgpt-1.1.0.tar.gz.
File metadata
- Download URL: commitgpt-1.1.0.tar.gz
- Upload date:
- Size: 20.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.6 Linux/6.6.2-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cf3237f0c77653989c6914c9691cc88cfbae92cf3bb416c755ca0a232b42b6dc |
|
| MD5 | 048d3bc64774ebb0e9e547e4cadeb35b |
|
| BLAKE2b-256 | 08f50d71aacc3821878c2f6aa8f115e1970b451d812df95bc07f654c290b68f2 |
File details
Details for the file commitgpt-1.1.0-py3-none-any.whl.
File metadata
- Download URL: commitgpt-1.1.0-py3-none-any.whl
- Upload date:
- Size: 23.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.6 Linux/6.6.2-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c26864c56000e1a6981c041afc610c094f8cdb7df8863a3ddf28b7972718efc1 |
|
| MD5 | 396a64f62ba7efa13d07146e74f53e1f |
|
| BLAKE2b-256 | a47576331025094ac4cd4abdb8abdbe317c92d9c05bb4193d221569550b1d9bd |
