Skip to main content

scommit: ChatGPT-generated commit messages

Project description

Semantic Commit (scommit)

Semantic Commit (scommit) is a Python script that uses the ChatGPT API to auto-generate commit messages for your git commits. You can use it exactly like git commit:

scommit -a

is equivalent to:

git commit -a -m "auto-generated commit message"

Think of scommit as an alias for git commit that appends -m "message" with an auto-generated message. That's it! I recommend using this when you don't actually care about commit messages, but want them to be slightly more informative than "sdflskdjafks". Plus, it uses more GPU's than regular commits, and we all know GPU usage is a proxy for agency.

Installation

pip install semantic-commit

You should get command-line tool called scommit that you can use just like git commmit.

You also need to set your OpenAI API key as an environment variable named OPENAI_API_KEY for scommit to work. Add this line in your .bashrc or .zshrc:

export OPENAI_API_KEY=your-api-key

License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.

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

semantic-commit-0.1.1.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

semantic_commit-0.1.1-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

Details for the file semantic-commit-0.1.1.tar.gz.

File metadata

  • Download URL: semantic-commit-0.1.1.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/40.0 requests/2.28.1 requests-toolbelt/1.0.0 urllib3/1.26.2 tqdm/4.64.1 importlib-metadata/6.7.0 keyring/24.2.0 rfc3986/1.5.0 colorama/0.4.6 CPython/3.9.18

File hashes

Hashes for semantic-commit-0.1.1.tar.gz
Algorithm Hash digest
SHA256 95e05e4666633ec78a5f09c596134adaf79407331564d7a811c180dd4410b8dc
MD5 bf8b32dedd4fc176606d171b56e1284e
BLAKE2b-256 6de57f4965251f1e72952ccffe63b71807db97f2931891655277133326179990

See more details on using hashes here.

File details

Details for the file semantic_commit-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: semantic_commit-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 2.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/40.0 requests/2.28.1 requests-toolbelt/1.0.0 urllib3/1.26.2 tqdm/4.64.1 importlib-metadata/6.7.0 keyring/24.2.0 rfc3986/1.5.0 colorama/0.4.6 CPython/3.9.18

File hashes

Hashes for semantic_commit-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 376fe45d7399a94d052e521bcc4f40d179f0769fc74adb1cf40e91e41768c544
MD5 c5702c6e4d5bac0583177a37c0070448
BLAKE2b-256 634df73e2b88db2f6a5257ca42186d70fc3e1cceaf3ac6aebd018240325b6d80

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