commit-msg-ai 0.2.1__tar.gz

commit_msg_ai-0.2.1/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Test package install
+        run: |
+          pip install dist/*.whl
+          commit-msg-ai --help
+          python -c "from commit_msg_ai.main import main; print('Import OK')"

commit_msg_ai-0.2.1/.github/workflows/pages.yml

@@ -0,0 +1,42 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+    paths: [docs/**]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/configure-pages@v5
+
+      - uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+
+      - uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

commit_msg_ai-0.2.1/.github/workflows/release.yml

@@ -0,0 +1,141 @@
+name: Release & Publish
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get commit message
+        id: commit
+        run: echo "message=$(git log -1 --pretty=%s)" >> "$GITHUB_OUTPUT"
+
+      - name: Determine version bump
+        id: bump
+        run: |
+          MSG="${{ steps.commit.outputs.message }}"
+          if [[ "$MSG" == bc:* ]]; then
+            echo "type=major" >> "$GITHUB_OUTPUT"
+          elif [[ "$MSG" == feat:* ]]; then
+            echo "type=minor" >> "$GITHUB_OUTPUT"
+          elif [[ "$MSG" == fix:* ]]; then
+            echo "type=patch" >> "$GITHUB_OUTPUT"
+          else
+            echo "type=none" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Bump version
+        if: steps.bump.outputs.type != 'none'
+        id: version
+        run: |
+          CURRENT=$(grep '^version' pyproject.toml | head -1 | sed 's/.*"\(.*\)".*/\1/')
+          IFS='.' read -r MAJOR MINOR PATCH <<< "$CURRENT"
+
+          case "${{ steps.bump.outputs.type }}" in
+            major) MAJOR=$((MAJOR + 1)); MINOR=0; PATCH=0 ;;
+            minor) MINOR=$((MINOR + 1)); PATCH=0 ;;
+            patch) PATCH=$((PATCH + 1)) ;;
+          esac
+
+          NEW="${MAJOR}.${MINOR}.${PATCH}"
+          echo "current=$CURRENT" >> "$GITHUB_OUTPUT"
+          echo "new=$NEW" >> "$GITHUB_OUTPUT"
+
+          sed -i "s/version = \"$CURRENT\"/version = \"$NEW\"/" pyproject.toml
+          sed -i "s/__version__ = \"$CURRENT\"/__version__ = \"$NEW\"/" commit_msg_ai/__init__.py
+
+      - name: Generate changelog
+        if: steps.bump.outputs.type != 'none'
+        id: changelog
+        run: |
+          PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
+          if [ -z "$PREV_TAG" ]; then
+            RANGE="HEAD"
+          else
+            RANGE="${PREV_TAG}..HEAD"
+          fi
+
+          {
+            echo 'body<<CHANGELOG_EOF'
+
+            FEATS=$(git log "$RANGE" --pretty=format:"%s" | grep -E "^feat:" | sed 's/^feat: //' || true)
+            if [ -n "$FEATS" ]; then
+              echo "### Features"
+              echo "$FEATS" | while read -r line; do echo "- $line"; done
+              echo ""
+            fi
+
+            FIXES=$(git log "$RANGE" --pretty=format:"%s" | grep -E "^fix:" | sed 's/^fix: //' || true)
+            if [ -n "$FIXES" ]; then
+              echo "### Fixes"
+              echo "$FIXES" | while read -r line; do echo "- $line"; done
+              echo ""
+            fi
+
+            BREAKING=$(git log "$RANGE" --pretty=format:"%s" | grep -E "^bc:" | sed 's/^bc: //' || true)
+            if [ -n "$BREAKING" ]; then
+              echo "### Breaking Changes"
+              echo "$BREAKING" | while read -r line; do echo "- $line"; done
+              echo ""
+            fi
+
+            echo 'CHANGELOG_EOF'
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Commit version bump
+        if: steps.bump.outputs.type != 'none'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml commit_msg_ai/__init__.py
+          git commit -m "chore: bump version to ${{ steps.version.outputs.new }}"
+          git push
+
+      - name: Create tag and release
+        if: steps.bump.outputs.type != 'none'
+        run: |
+          TAG="v${{ steps.version.outputs.new }}"
+          git tag "$TAG"
+          git push origin "$TAG"
+
+          gh release create "$TAG" \
+            --title "$TAG" \
+            --notes "${{ steps.changelog.outputs.body }}"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/setup-python@v5
+        if: steps.bump.outputs.type != 'none'
+        with:
+          python-version: '3.12'
+
+      - name: Build package
+        if: steps.bump.outputs.type != 'none'
+        run: |
+          pip install build
+          python -m build
+
+      - name: Test package install
+        if: steps.bump.outputs.type != 'none'
+        run: |
+          pip install dist/*.whl
+          commit-msg-ai --help
+          python -c "from commit_msg_ai.main import main; print('Import OK')"
+
+      - name: Publish to PyPI
+        if: steps.bump.outputs.type != 'none'
+        uses: pypa/gh-action-pypi-publish@release/v1

commit_msg_ai-0.2.1/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.venv/

commit_msg_ai-0.2.1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: commit-msg-ai
+Version: 0.2.1
+Summary: Generate commit messages from staged changes using a local LLM via Ollama
+Project-URL: Homepage, https://xavimf87.github.io/commit-msg-ai
+Project-URL: Repository, https://github.com/xavimf87/commit-msg-ai
+Project-URL: Issues, https://github.com/xavimf87/commit-msg-ai/issues
+Author: Xavi Martínez
+License-Expression: MIT
+Keywords: ai,cli,commit,git,llm,ollama
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# commit-msg-ai
+
+Generate commit messages from your staged changes using a local LLM via [Ollama](https://ollama.com). No API keys, no cloud — everything runs on your machine.
+
+## Getting started
+
+### 1. Install and set up Ollama
+
+commit-msg-ai requires [Ollama](https://ollama.com) to run language models locally. Install it first:
+
+**macOS:**
+
+```bash
+brew install ollama
+```
+
+**Linux:**
+
+```bash
+curl -fsSL https://ollama.com/install.sh | sh
+```
+
+**Windows:** Download the installer from [ollama.com/download](https://ollama.com/download).
+
+Once installed, start the Ollama server:
+
+```bash
+ollama serve
+```
+
+> On macOS, Ollama runs automatically in the background after installation. You can skip this step if you see the Ollama icon in your menu bar.
+
+### 2. Choose a model
+
+You need at least one model downloaded. See what's available on your machine:
+
+```bash
+ollama list
+```
+
+If the list is empty, pull a model. Some good options for commit message generation:
+
+```bash
+# Lightweight and fast (~2GB)
+ollama pull llama3.2
+
+# Good for code understanding (~4.7GB)
+ollama pull qwen2.5-coder
+
+# Small and capable (~2.3GB)
+ollama pull mistral
+```
+
+You can browse all available models at [ollama.com/library](https://ollama.com/library).
+
+### 3. Install commit-msg-ai
+
+**With pipx (recommended):**
+
+```bash
+pipx install git+https://github.com/YOUR_USER/commit-msg-ai.git
+```
+
+**With pip:**
+
+```bash
+pip install git+https://github.com/YOUR_USER/commit-msg-ai.git
+```
+
+### 4. Configure your model
+
+By default commit-msg-ai uses `llama3.2`. If you pulled a different model, set it as default:
+
+```bash
+commit-msg-ai config model qwen2.5-coder
+```
+
+Verify your config:
+
+```bash
+commit-msg-ai config
+```
+
+### 5. Use it
+
+```bash
+git add .
+commit-msg-ai
+```
+
+```
+Staged files:
+M  src/auth.py
+A  src/middleware.py
+
+Generating commit message with qwen2.5-coder...
+
+──────────────────────────────────────────────────
+feat: add JWT authentication middleware
+──────────────────────────────────────────────────
+
+Commit with this message? [Y/n] y
+[main 3a1b2c3] feat: add JWT authentication middleware
+ 2 files changed, 45 insertions(+), 3 deletions(-)
+```
+
+That's it.
+
+## Configuration
+
+commit-msg-ai stores config in `~/.config/commit-msg-ai/config.json`.
+
+```bash
+# Set default model
+commit-msg-ai config model mistral
+
+# Set Ollama server URL (useful for remote setups)
+commit-msg-ai config url http://192.168.1.50:11434
+
+# View all config
+commit-msg-ai config
+
+# View a single value
+commit-msg-ai config model
+```
+
+Override any config for a single run with flags:
+
+```bash
+commit-msg-ai --model codellama
+commit-msg-ai --url http://other-server:11434
+```
+
+## Commit message format
+
+commit-msg-ai generates messages with only three prefixes:
+
+- `feat:` new features
+- `fix:` bug fixes
+- `bc:` breaking changes
+
+## Requirements
+
+- Python 3.9+
+- [Ollama](https://ollama.com) running locally (or on a reachable server)
+- At least one model pulled (`ollama pull llama3.2`)

commit_msg_ai-0.2.1/README.md

@@ -0,0 +1,146 @@
+# commit-msg-ai
+
+Generate commit messages from your staged changes using a local LLM via [Ollama](https://ollama.com). No API keys, no cloud — everything runs on your machine.
+
+## Getting started
+
+### 1. Install and set up Ollama
+
+commit-msg-ai requires [Ollama](https://ollama.com) to run language models locally. Install it first:
+
+**macOS:**
+
+```bash
+brew install ollama
+```
+
+**Linux:**
+
+```bash
+curl -fsSL https://ollama.com/install.sh | sh
+```
+
+**Windows:** Download the installer from [ollama.com/download](https://ollama.com/download).
+
+Once installed, start the Ollama server:
+
+```bash
+ollama serve
+```
+
+> On macOS, Ollama runs automatically in the background after installation. You can skip this step if you see the Ollama icon in your menu bar.
+
+### 2. Choose a model
+
+You need at least one model downloaded. See what's available on your machine:
+
+```bash
+ollama list
+```
+
+If the list is empty, pull a model. Some good options for commit message generation:
+
+```bash
+# Lightweight and fast (~2GB)
+ollama pull llama3.2
+
+# Good for code understanding (~4.7GB)
+ollama pull qwen2.5-coder
+
+# Small and capable (~2.3GB)
+ollama pull mistral
+```
+
+You can browse all available models at [ollama.com/library](https://ollama.com/library).
+
+### 3. Install commit-msg-ai
+
+**With pipx (recommended):**
+
+```bash
+pipx install git+https://github.com/YOUR_USER/commit-msg-ai.git
+```
+
+**With pip:**
+
+```bash
+pip install git+https://github.com/YOUR_USER/commit-msg-ai.git
+```
+
+### 4. Configure your model
+
+By default commit-msg-ai uses `llama3.2`. If you pulled a different model, set it as default:
+
+```bash
+commit-msg-ai config model qwen2.5-coder
+```
+
+Verify your config:
+
+```bash
+commit-msg-ai config
+```
+
+### 5. Use it
+
+```bash
+git add .
+commit-msg-ai
+```
+
+```
+Staged files:
+M  src/auth.py
+A  src/middleware.py
+
+Generating commit message with qwen2.5-coder...
+
+──────────────────────────────────────────────────
+feat: add JWT authentication middleware
+──────────────────────────────────────────────────
+
+Commit with this message? [Y/n] y
+[main 3a1b2c3] feat: add JWT authentication middleware
+ 2 files changed, 45 insertions(+), 3 deletions(-)
+```
+
+That's it.
+
+## Configuration
+
+commit-msg-ai stores config in `~/.config/commit-msg-ai/config.json`.
+
+```bash
+# Set default model
+commit-msg-ai config model mistral
+
+# Set Ollama server URL (useful for remote setups)
+commit-msg-ai config url http://192.168.1.50:11434
+
+# View all config
+commit-msg-ai config
+
+# View a single value
+commit-msg-ai config model
+```
+
+Override any config for a single run with flags:
+
+```bash
+commit-msg-ai --model codellama
+commit-msg-ai --url http://other-server:11434
+```
+
+## Commit message format
+
+commit-msg-ai generates messages with only three prefixes:
+
+- `feat:` new features
+- `fix:` bug fixes
+- `bc:` breaking changes
+
+## Requirements
+
+- Python 3.9+
+- [Ollama](https://ollama.com) running locally (or on a reachable server)
+- At least one model pulled (`ollama pull llama3.2`)

commit_msg_ai-0.2.1/commit_msg_ai/__init__.py

@@ -0,0 +1,3 @@
+"""commit-msg-ai - Generate commit messages from staged changes using a local LLM."""
+
+__version__ = "0.2.1"