Skip to main content

Generate AI powered commit messages

Project description

autocommit

AI-Generated Git Commit Messages

Includes two tools: commit.py and scan_repo.py

Install the aicommit command with pip install aicommit

commit

An interactive CLI tool that generates 5 commit message suggestions for all the changes in your current Git repo. After you pick and edit the commit message you want, it performs the commit.

ezgif-1-1425a5f8d5

NOTE: it commits all changes, untracked and unstaged, in your current repo.

On first run, it will prompt you for your OpenAI API key. Sign up for OpenAI if you haven't. Grab your API key by going to the dropdown on the top right, selecting "View API Keys" and creating a new key. Copy this key.

scan_repo

scan_repo runs through all the commits in your repository to generate a CSV with AI-suggested commit messages side-by-side with your original commit messages.

To run scan_repo, copy .env.example to .env and add your OPENAI_KEY.

To update the repo it runs on, modify the GITHUB_REPO_URL variable at the top of scan_repo.py

Publishing to pip

Version bump and clear out dist/

python3 -m build
twine check dist/*
twine upload dist/* --verbose

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

aicommit-0.1.0.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

aicommit-0.1.0-py3-none-any.whl (7.5 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