komit 0.1.0__tar.gz

komit-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

komit-0.1.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: komit
+Version: 0.1.0
+Summary: AI-powered git commit message generator using local LLMs
+Author-email: Vlad Digori <digorivlad59@gmail.com>
+License: Apache 2.0
+Keywords: git,commit,ai,llm,ollama,developer-tools
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ollama>=0.4.0
+Dynamic: license-file
+
+# 🤖 komit
+
+AI-powered git commit message generator using local LLMs via Ollama. No API keys, no internet required — runs completely locally and privately.
+
+---
+
+![PyPI](https://img.shields.io/pypi/v/komit)
+![Python](https://img.shields.io/badge/python-3.13+-blue)
+![License](https://img.shields.io/github/license/glemiu6/komit)
+![Downloads](https://img.shields.io/pypi/dm/komit)
+
+---
+
+## Features
+
+- 🧠 **Local LLM** — uses Ollama, no API keys needed
+- 📝 **Multiple commit styles** — conventional, simple, detailed
+- 🔄 **Regenerate** — not happy? generate a new message instantly
+- ✏️ **Edit before commit** — open your editor to tweak the message
+- 🌍 **Universal** — works via pip, binary, or shell script
+- ⚡ **Fast** — runs on your machine, no network calls to external APIs
+
+---
+
+## Requirements
+
+- [Ollama](https://ollama.com) installed and running
+- A local model pulled (e.g. `ollama pull qwen2.5:7b`)
+
+---
+
+## Installation
+
+### Option 1 — One line install (no Python required)
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/glemiu6/komit/master/scripts/install.sh | bash
+```
+
+### Option 2 — pip
+
+```bash
+pip install komit
+```
+
+### Option 3 — Download binary
+
+Download the binary for your platform from [GitHub Releases](https://github.com/glemiu6/komit/releases/latest):
+
+| Platform            | Binary                      |
+|---------------------|-----------------------------|
+| Linux x86_64        | `komit-linux-x86_64`        |
+| macOS Apple Silicon | `komit-macos-arm64`         |
+| Windows             | `komit-windows-x86_64.exe`  |
+> Intel Mac users: use `pip install komit` instead.
+
+```bash
+# Linux/Mac
+chmod +x komit-*
+sudo mv komit-* /usr/local/bin/komit
+```
+
+---
+
+## Setup
+
+### Git alias (recommended)
+
+```bash
+git config --global alias.ai '!komit'
+```
+
+Now you can use `git ai` as a shortcut.
+
+---
+
+## Usage
+
+```bash
+# stage your changes
+git add .
+
+# generate commit message
+komit
+
+# or via git alias
+git ai
+
+# or via shell script
+./scripts/commit.sh
+```
+
+### Interactive prompt
+
+```
+Staged files (3):
+  - src/auth.py
+  - tests/test_auth.py
+  - README.md
+
+Generating commit message...
+
+Suggested message:
+  feat: add JWT authentication with refresh token support
+
+Use this message? (y/n/e to edit/r to regenerate): 
+```
+
+- `y` — commit with the suggested message
+- `n` — cancel
+- `e` — open editor to modify the message
+- `r` — regenerate a new message
+
+---
+
+## Commit Styles
+
+Configure in `komitconfig.py` or pass as argument:
+
+**Conventional** (default):
+```
+feat: add user authentication
+fix: resolve null pointer in login flow
+docs: update API reference
+```
+
+**Simple:**
+```
+Add user authentication
+Fix null pointer in login flow
+Update API reference
+```
+
+**Detailed:**
+```
+feat: add user authentication
+
+- Add JWT token generation
+- Add password hashing with bcrypt
+- Add refresh token support
+```
+
+---
+
+## Configuration
+
+Edit `komit/komitconfig.py`:
+
+```python
+@dataclass
+class KomitConfig:
+    model: str = "qwen2.5:7b"       # any Ollama model
+    style: str = "conventional"      # conventional, simple, detailed
+    max_diff_length: int = 4000      # truncate large diffs
+    ollama_url: str = "http://localhost:11434"
+```
+
+---
+
+## Recommended Models
+
+| Model | Size | Best for |
+|-------|------|----------|
+| `qwen2.5:7b` | 4.7GB | Best quality |
+| `llama3.2:3b` | 2.0GB | Fastest |
+| `mistral:7b` | 4.1GB | Good balance |
+
+```bash
+ollama pull qwen2.5:7b
+```
+
+---
+
+## Uninstall
+
+```bash
+./scripts/uninstall.sh
+# or
+pip uninstall komit
+```
+
+---
+
+## Contributing
+
+1. Fork the repo
+2. Create a feature branch (`git checkout -b feature-name`)
+3. Commit your changes (`komit` 😉)
+4. Push to the branch (`git push origin feature-name`)
+5. Open a Pull Request
+
+---
+
+## License
+
+[Apache License](LICENSE)

komit-0.1.0/README.md

@@ -0,0 +1,196 @@
+# 🤖 komit
+
+AI-powered git commit message generator using local LLMs via Ollama. No API keys, no internet required — runs completely locally and privately.
+
+---
+
+![PyPI](https://img.shields.io/pypi/v/komit)
+![Python](https://img.shields.io/badge/python-3.13+-blue)
+![License](https://img.shields.io/github/license/glemiu6/komit)
+![Downloads](https://img.shields.io/pypi/dm/komit)
+
+---
+
+## Features
+
+- 🧠 **Local LLM** — uses Ollama, no API keys needed
+- 📝 **Multiple commit styles** — conventional, simple, detailed
+- 🔄 **Regenerate** — not happy? generate a new message instantly
+- ✏️ **Edit before commit** — open your editor to tweak the message
+- 🌍 **Universal** — works via pip, binary, or shell script
+- ⚡ **Fast** — runs on your machine, no network calls to external APIs
+
+---
+
+## Requirements
+
+- [Ollama](https://ollama.com) installed and running
+- A local model pulled (e.g. `ollama pull qwen2.5:7b`)
+
+---
+
+## Installation
+
+### Option 1 — One line install (no Python required)
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/glemiu6/komit/master/scripts/install.sh | bash
+```
+
+### Option 2 — pip
+
+```bash
+pip install komit
+```
+
+### Option 3 — Download binary
+
+Download the binary for your platform from [GitHub Releases](https://github.com/glemiu6/komit/releases/latest):
+
+| Platform            | Binary                      |
+|---------------------|-----------------------------|
+| Linux x86_64        | `komit-linux-x86_64`        |
+| macOS Apple Silicon | `komit-macos-arm64`         |
+| Windows             | `komit-windows-x86_64.exe`  |
+> Intel Mac users: use `pip install komit` instead.
+
+```bash
+# Linux/Mac
+chmod +x komit-*
+sudo mv komit-* /usr/local/bin/komit
+```
+
+---
+
+## Setup
+
+### Git alias (recommended)
+
+```bash
+git config --global alias.ai '!komit'
+```
+
+Now you can use `git ai` as a shortcut.
+
+---
+
+## Usage
+
+```bash
+# stage your changes
+git add .
+
+# generate commit message
+komit
+
+# or via git alias
+git ai
+
+# or via shell script
+./scripts/commit.sh
+```
+
+### Interactive prompt
+
+```
+Staged files (3):
+  - src/auth.py
+  - tests/test_auth.py
+  - README.md
+
+Generating commit message...
+
+Suggested message:
+  feat: add JWT authentication with refresh token support
+
+Use this message? (y/n/e to edit/r to regenerate): 
+```
+
+- `y` — commit with the suggested message
+- `n` — cancel
+- `e` — open editor to modify the message
+- `r` — regenerate a new message
+
+---
+
+## Commit Styles
+
+Configure in `komitconfig.py` or pass as argument:
+
+**Conventional** (default):
+```
+feat: add user authentication
+fix: resolve null pointer in login flow
+docs: update API reference
+```
+
+**Simple:**
+```
+Add user authentication
+Fix null pointer in login flow
+Update API reference
+```
+
+**Detailed:**
+```
+feat: add user authentication
+
+- Add JWT token generation
+- Add password hashing with bcrypt
+- Add refresh token support
+```
+
+---
+
+## Configuration
+
+Edit `komit/komitconfig.py`:
+
+```python
+@dataclass
+class KomitConfig:
+    model: str = "qwen2.5:7b"       # any Ollama model
+    style: str = "conventional"      # conventional, simple, detailed
+    max_diff_length: int = 4000      # truncate large diffs
+    ollama_url: str = "http://localhost:11434"
+```
+
+---
+
+## Recommended Models
+
+| Model | Size | Best for |
+|-------|------|----------|
+| `qwen2.5:7b` | 4.7GB | Best quality |
+| `llama3.2:3b` | 2.0GB | Fastest |
+| `mistral:7b` | 4.1GB | Good balance |
+
+```bash
+ollama pull qwen2.5:7b
+```
+
+---
+
+## Uninstall
+
+```bash
+./scripts/uninstall.sh
+# or
+pip uninstall komit
+```
+
+---
+
+## Contributing
+
+1. Fork the repo
+2. Create a feature branch (`git checkout -b feature-name`)
+3. Commit your changes (`komit` 😉)
+4. Push to the branch (`git push origin feature-name`)
+5. Open a Pull Request
+
+---
+
+## License
+
+[Apache License](LICENSE)

komit-0.1.0/komit/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.1.0"
+__author__ = "Vlad Digori"

komit-0.1.0/komit/generator.py

@@ -0,0 +1,43 @@
+#komit/generator.py
+from komit.komitconfig import KomitConfig
+STYLES ={
+    "conventional":("Generate a conventional commit message (type: description).\n"
+                    "Types: feat, fix, docs, style, refactor, test, chore.\n"
+                    "Example: 'feat: add user authentication'\n"
+                    "Just the message, nothing else"),
+    "simple":("Generate a short, clear commit message in imperative mood.\n"
+              "Example: 'Add user authentication'\n"
+              "Just the message, nothing else"),
+    "detailed":("Generate a commit message with a short title and bullet points.\n"
+                "Example:\n"
+                "feat: add user authentication\n\n"
+                "- Add login endpoint\n"
+                "- Add JWT token generation\n"
+                "- Add password hashing\n"
+                "Just the message, nothing else"),
+}
+
+def generate_message(diff:str, config: KomitConfig | None=None):
+    config = config or KomitConfig()
+
+    #truncate large diff
+    if len(diff)>config.max_diff_length:
+        diff = diff[:config.max_diff_length]+"\n... (truncated)"
+    style_prompt = STYLES.get(config.style,STYLES["conventional"])
+    try:
+        from ollama import Client
+        client = Client(host=config.ollama_url)
+        response = client.chat(model=config.model,
+                               messages=[
+                                   {
+                                       "role":'system',
+                                       "content":style_prompt
+                                   },
+                                   {
+                                       "role":'user',
+                                       "content":f"Generate a commit message for this:\n\n{diff}"
+                                   }
+                               ])
+        return response.message.content.strip()
+    except Exception as e:
+        raise RuntimeError(f"Failed to generate commit message: {e}")

komit-0.1.0/komit/git_utils.py

@@ -0,0 +1,25 @@
+#komit/git_utils.py
+import subprocess
+
+def get_staged_diff() ->str:
+    result = subprocess.run(['git','diff','--staged'],capture_output=True,text=True)
+    return result.stdout
+
+def get_staged_files()->list[str]:
+    result = subprocess.run(['git','diff','--staged','--name-only'],capture_output=True,text=True)
+    return [f for f in result.stdout.strip().split('\n') if f]
+
+def commit(message:str):
+    subprocess.run(
+        ['git','commit','-m',message],check=True
+    )
+
+def commit_with_editor(message:str):
+    subprocess.run(
+        ['git','commit','-m',message,'-e'],
+        check=True
+    )
+
+def is_git_repo():
+    result = subprocess.run(['git','rev-parse','--is-inside-work-tree'],capture_output=True,text=True)
+    return result.returncode == 0

komit-0.1.0/komit/komitconfig.py

@@ -0,0 +1,9 @@
+#komit/komitconfig.py
+from dataclasses import dataclass
+
+@dataclass
+class KomitConfig:
+    model:str ='qwen2.5:7b'
+    style:str ='conventional'
+    max_diff_length:int = 4000
+    ollama_url:str ='http://localhost:11434'