Skip to main content

A tool to generate commit messages using OpenAI models.

Project description

GitScribe

GitScribe is a tool for developers to generate commit message suggestions.

There are two ways to use it:

  • Command Line Interface (CLI) using Python Package Manager
  • Uploading Files on our web-interface on our website GitScribe

CLI Installation

For both Windows and Mac OS systems, install gitscribe on terminal/command prompt/powershell. Make sure you have Python Package Manager installed first.

pip install gtscr

Check you have it installed by entering this in your terminal:

pip --version

Offical pip installation documentation

Using GitScribe in Terminal

  1. First setup gitscribe with
gs setup
  1. Setup your GitHub model personal access token

Quick Start Guide (Part 1)

Personal Access Token Information

  1. First make sure you are in the repository you want to generate a commit message for.

  2. Generate commit message.

gs generate

Optional

To get multiple commit message suggestions use the -nm flag.

Example:

gs generate -nm 3

This will generate three commit messages.

Using Our Website

  1. Go to GitScribe
  2. Log in with your GitHub account
  3. Upload the old version of your file first
  4. Upload the new version of your file under
  5. Enter the amount of suggestions you want to generate
  6. View the generated messages below, copy them with the copy button

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

gtscr-1.1.4.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gtscr-1.1.4-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file gtscr-1.1.4.tar.gz.

File metadata

  • Download URL: gtscr-1.1.4.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for gtscr-1.1.4.tar.gz
Algorithm Hash digest
SHA256 acb00c8d93fdc0ea430cadb79f33f461164f486a42041424ae12d574608b134b
MD5 cb71b378900f93d1827fd6f636851c42
BLAKE2b-256 d578bae79044d4d639c639a5439b2f758984b150a8eb1d531fdcf9197118419a

See more details on using hashes here.

File details

Details for the file gtscr-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: gtscr-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for gtscr-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4d84a75b43895404931d1dc23a1eff7ee7cdc643baf23d608b8dd81c24e9bf6d
MD5 d4bbfa8ed088c2c71497f7d152057cad
BLAKE2b-256 ce11ebf61bbf3f7c5c78ba6e28808761258952a0f0616f9f1a1c6ba440736a2a

See more details on using hashes here.

Supported by

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