| Name | smart-commit-msg JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Builds a smart commit message using LLMs |
| upload_time | 2024-10-25 19:23:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Smart Commit Msg
<img src="./assets/git-diff.jpeg" height=200 width=300></img>
A tool that creates smart commit messages using the `git diff`.
## Usage
Install the CLI
```sh
$ pip install smart-commit-msg
```
Go to a git repository
```sh
$ git add .
$ smart-commit-msg
```
Smart commit msg gives you a commit message based on the staged changes.
## Tool Help
```sh
NAME
smart-commit-msg - Main function that orchestrates the commit message generation and user interaction.
SYNOPSIS
smart-commit-msg <flags>
DESCRIPTION
Main function that orchestrates the commit message generation and user interaction.
FLAGS
--model=MODEL
Default: 'meta-llama/Llama...
--max_tokens=MAX_TOKENS
Default: 100
```
## Models
This tool uses the `huggingface_hub.InferenceClient` API. So you can use all the models that support
the inference endpoints!
To know more about inference endpoints please read the official [documentation](https://huggingface.co/docs/inference-endpoints/en/index).
## References
* [Andrej Karpathy's Tweet](https://x.com/karpathy/status/1827810695658029262)
* [Andrej Karpathy's Gist](https://gist.github.com/karpathy/1dd0294ef9567971c1e4348a90d69285)
Raw data
{
"_id": null,
"home_page": null,
"name": "smart-commit-msg",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "ariG23498 <aritra.born2fly@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/32/f7/34073653f4320cac395bb581840b213e1af0326b395daab531df147d97ae/smart_commit_msg-0.1.1.tar.gz",
"platform": null,
"description": "## Smart Commit Msg\n\n<img src=\"./assets/git-diff.jpeg\" height=200 width=300></img>\n\nA tool that creates smart commit messages using the `git diff`.\n\n## Usage\n\nInstall the CLI\n\n```sh\n$ pip install smart-commit-msg\n```\n\nGo to a git repository\n\n```sh\n$ git add .\n$ smart-commit-msg\n```\n\nSmart commit msg gives you a commit message based on the staged changes.\n\n## Tool Help\n\n```sh\nNAME\n smart-commit-msg - Main function that orchestrates the commit message generation and user interaction.\n\nSYNOPSIS\n smart-commit-msg <flags>\n\nDESCRIPTION\n Main function that orchestrates the commit message generation and user interaction.\n\nFLAGS\n --model=MODEL\n Default: 'meta-llama/Llama...\n --max_tokens=MAX_TOKENS\n Default: 100\n```\n\n\n## Models\n\nThis tool uses the `huggingface_hub.InferenceClient` API. So you can use all the models that support\nthe inference endpoints!\n\nTo know more about inference endpoints please read the official [documentation](https://huggingface.co/docs/inference-endpoints/en/index).\n\n## References\n\n* [Andrej Karpathy's Tweet](https://x.com/karpathy/status/1827810695658029262)\n* [Andrej Karpathy's Gist](https://gist.github.com/karpathy/1dd0294ef9567971c1e4348a90d69285)",
"bugtrack_url": null,
"license": null,
"summary": "Builds a smart commit message using LLMs",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e034e5177babc4efef46842980c760ed5adc66a94d3cca0b2ca61378147fa9d6",
"md5": "a6808a16ea9fb63e4e1755da7dbe3f5a",
"sha256": "536aa4e2f589083c43b1f861e8dd251cd5385d3a4221bc237e477b090afca024"
},
"downloads": -1,
"filename": "smart_commit_msg-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6808a16ea9fb63e4e1755da7dbe3f5a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3512,
"upload_time": "2024-10-25T19:23:08",
"upload_time_iso_8601": "2024-10-25T19:23:08.358063Z",
"url": "https://files.pythonhosted.org/packages/e0/34/e5177babc4efef46842980c760ed5adc66a94d3cca0b2ca61378147fa9d6/smart_commit_msg-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "32f734073653f4320cac395bb581840b213e1af0326b395daab531df147d97ae",
"md5": "3e5129321ecc99fa46c6067f8d21cbc6",
"sha256": "9d0f7b0701537bd8dbb424fb29f266a94517740a54876f3e939ef1315b11e1fe"
},
"downloads": -1,
"filename": "smart_commit_msg-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3e5129321ecc99fa46c6067f8d21cbc6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 53031,
"upload_time": "2024-10-25T19:23:09",
"upload_time_iso_8601": "2024-10-25T19:23:09.921716Z",
"url": "https://files.pythonhosted.org/packages/32/f7/34073653f4320cac395bb581840b213e1af0326b395daab531df147d97ae/smart_commit_msg-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 19:23:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "smart-commit-msg"
}
