Skip to main content

commitgpt

Coverage Status Continuous Integration Continuous Deployment

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

asciicast

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

GNU GENERAL PUBLIC LICENSE

Metadata

Release files for commitgpt 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for commitgpt 1.1.0
File Size Uploaded
commitgpt-1.1.0.tar.gz 20.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for commitgpt 1.1.0
File Interpreter ABI Platform
commitgpt-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 43.7 kB

Release files / commitgpt-1.1.0.tar.gz

Download URL commitgpt-1.1.0.tar.gz
Size 20.7 kB
Tags Source
SHA-256 checksum
How to use checksums
cf3237f0c77653989c6914c9691cc88cfbae92cf3bb416c755ca0a232b42b6dc
BLAKE2b-256 checksum
How to use checksums
08f50d71aacc3821878c2f6aa8f115e1970b451d812df95bc07f654c290b68f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.6 Linux/6.6.2-arch1-1

Release files / commitgpt-1.1.0-py3-none-any.whl

Download URL commitgpt-1.1.0-py3-none-any.whl
Size 23.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c26864c56000e1a6981c041afc610c094f8cdb7df8863a3ddf28b7972718efc1
BLAKE2b-256 checksum
How to use checksums
a47576331025094ac4cd4abdb8abdbe317c92d9c05bb4193d221569550b1d9bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.6 Linux/6.6.2-arch1-1

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page