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

is equivalent to:

git commit -m "auto-generated commit message"

You can also use all of the args you normally would with git commit, for example:

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.2.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

semantic_commit-0.1.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: semantic-commit-0.1.2.tar.gz
  • Upload date:
  • Size: 3.5 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.2.tar.gz
Algorithm Hash digest
SHA256 6bd3f4761f479ae4f1d697c1b63602f2a9529d388328ae61135d5468f2e5492b
MD5 629f0d75fcf6ce0f19f1432d3fb669db
BLAKE2b-256 10ab9ecda24d8b3d061e1c4ac8c57cd47b41dc4a7cd58331b5eed49bcd000fec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: semantic_commit-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 527b46596dda353178f78484dc13b77658f9fdbb5d067df431c1f11a1a9fb509
MD5 cc2d653a0e3253d56316dac44b46fdfd
BLAKE2b-256 9f16136e722a42210b2107cb12ea0ffba5edfea7ce812bd6d5be82615395e1e0

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