Skip to main content

Automatically generate a changelog using GPT-3

Project description

GPT Changelog

GPT Changelog is a tool to automatically generate a changelog using OpenAI's GPT-3 based on commit messages since the most recent tag. It will generate a changelog in Markdown format and prepend it to the CHANGELOG.md file.

Installation

Using pip

pip install gptchangelog

Configuration

Before using GPT Changelog, you need to create a configuration file named config.ini in the $HOME/.config/gptchangelog directory.

[openai]
api_key = your_openai_api_key_here

Replace your_openai_api_key_here with your actual OpenAI API key. Usage

To generate a changelog and prepend it to the CHANGELOG.md file, navigate to your Git repository directory and run the following command:

gptchangelog

The script will fetch commit messages since the most recent tag, determine the next version based on semantic versioning, generate a changelog using OpenAI's GPT-3, and prepend the changelog to the CHANGELOG.md file. If the CHANGELOG.md file does not exist, the script will create it.

License

This project is licensed under the MIT 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

gptchangelog-0.1.0.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

gptchangelog-0.1.0-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

Details for the file gptchangelog-0.1.0.tar.gz.

File metadata

  • Download URL: gptchangelog-0.1.0.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.9

File hashes

Hashes for gptchangelog-0.1.0.tar.gz
Algorithm Hash digest
SHA256 990f1bfb096ebd994a916b4df644a2c725e6a084f8e6f340293006307eb8f2e7
MD5 0ea7c6f7d9095d5a29ba6a4882433ce3
BLAKE2b-256 6d76c1e6989a75c58083d8d2414b22e4410bf6ef238abc2f78dee786649af21f

See more details on using hashes here.

File details

Details for the file gptchangelog-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gptchangelog-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 947f229758f3298734affa1c25f333c59bd097f40850e25b02d27db6f468c341
MD5 b7642abbe85778779a0b1faa400fe4fa
BLAKE2b-256 2fc8a2b664bbb9f8b5ab62d9de5acd9de847bf820c86724e95018b570b322946

See more details on using hashes here.

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