Automatically generate commit messages from changes
Project description
Uses the Mistral api to pre-generate a commit message for you.
Features
Uses Retrieval-Augmented Generation (RAG) to give context to the LLM.
Automatically pre-fills commit messages using git hooks.
Optionally uses the mistral function-calling API to let the model access other files in the codebase (disabled by default).
Setup
You can simply install autocommit using pip:
$ pip install git_autocommit_hook
Usage
To use autocommit, simply run the following command in the root of your repository:
$ autocommit setup --key-file <path-to-mistral-api-key>
This will
create a .autocommit_storage_dir (untracked) directory in the root of your repository with the RAG database and the Mistral API key.
add a git hook to your repository to automatically generate commit messages.
add a git hook to your repository to keep the RAG database up-to-date.
Why ?
This is why
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file git_autocommit_hook-0.1.0.tar.gz.
File metadata
- Download URL: git_autocommit_hook-0.1.0.tar.gz
- Upload date:
- Size: 24.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
47ceb9e7cf560bd005b9092e18b36cd9dd670753e8099db18b4481018be7c81e
|
|
| MD5 |
7213e1ffa86e986304a350ef5ef397e9
|
|
| BLAKE2b-256 |
8bc46cbc7f1635caa4d4e18e9b392a793c7d60438cfa9dcb5930dd5c2ab37d26
|
Provenance
The following attestation bundles were made for git_autocommit_hook-0.1.0.tar.gz:
Publisher:
ci_cd.yaml on tbrugere/autocommit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
git_autocommit_hook-0.1.0.tar.gz -
Subject digest:
47ceb9e7cf560bd005b9092e18b36cd9dd670753e8099db18b4481018be7c81e - Sigstore transparency entry: 158032152
- Sigstore integration time:
-
Permalink:
tbrugere/autocommit@56a2a1f492a2106f07b07b6edb849645f7ad5b62 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/tbrugere
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_cd.yaml@56a2a1f492a2106f07b07b6edb849645f7ad5b62 -
Trigger Event:
push
-
Statement type:
File details
Details for the file git_autocommit_hook-0.1.0-py3-none-any.whl.
File metadata
- Download URL: git_autocommit_hook-0.1.0-py3-none-any.whl
- Upload date:
- Size: 31.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4051adc847e1be040d898d4d7bc6abc3cadb3227665d807bacc7fc129b3aab19
|
|
| MD5 |
8a348664216080270fe1874807160f3e
|
|
| BLAKE2b-256 |
f040ac4eefe604213914efd137bb0c1936e2694e514ff0767b7391de29d7ae34
|
Provenance
The following attestation bundles were made for git_autocommit_hook-0.1.0-py3-none-any.whl:
Publisher:
ci_cd.yaml on tbrugere/autocommit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
git_autocommit_hook-0.1.0-py3-none-any.whl -
Subject digest:
4051adc847e1be040d898d4d7bc6abc3cadb3227665d807bacc7fc129b3aab19 - Sigstore transparency entry: 158032166
- Sigstore integration time:
-
Permalink:
tbrugere/autocommit@56a2a1f492a2106f07b07b6edb849645f7ad5b62 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/tbrugere
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_cd.yaml@56a2a1f492a2106f07b07b6edb849645f7ad5b62 -
Trigger Event:
push
-
Statement type: