Skip to main content

commitgpt assists developers in generating high-quality commit messages for their version control systems, such as git.

Project description

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

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

commitgpt-1.1.0.tar.gz (20.7 kB view hashes)

Uploaded Source

Built Distribution

commitgpt-1.1.0-py3-none-any.whl (23.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page