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.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aicommit-0.1.0.tar.gz
.
File metadata
- Download URL: aicommit-0.1.0.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7369dea26d5594285e13c8b4b8297bf3d0992f1c7b3a09aa1273e9604afc536f |
|
MD5 | 9353b2b4d9df581cc8977f45b55f0c49 |
|
BLAKE2b-256 | 12d262190b07724f7e18cb1d33b849ad55b0ca9ef318a266d7cdd8db1cb3cd4f |
File details
Details for the file aicommit-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: aicommit-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d1a51d2b661fe745d4cdf7dcc174c3054092be0c7cd1439262bf70c80d59b0c |
|
MD5 | 3f059e275d53cdc18aaaf753e5f3fd39 |
|
BLAKE2b-256 | 6e2cc24c11c31d712a8ae1b5126d07fbf65faded10d5fdf671893a253416111c |