commitmate 1.0.0__tar.gz → 1.0.1__tar.gz

commitmate-1.0.1/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/commitmate
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tool
+        run: pip install build
+
+      - name: Build distribution
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

{commitmate-1.0.0 → commitmate-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commitmate
-Version: 1.0.0
+Version: 1.0.1
 Summary: Generates Conventional Commits-style messages from staged git diffs using a local Ollama model.
 Project-URL: Homepage, https://github.com/theishanpathak/commitmate
 Author: Ishan Pathak
@@ -39,7 +39,19 @@ Writing good commit messages consistently is tedious, and generic "wip" or "fix
 
 ## Installation
 
-Clone the repo and install it as an editable local package:
+### For users
+
+Install directly from PyPI:
+
+```bash
+pip install commitmate
+```
+
+This registers a `commitmate` command on your system, callable from any git repository.
+
+### For developers / contributors
+
+If you want to modify the source, run tests, or contribute:
 
 ```bash
 git clone https://github.com/theishanpathak/commitmate.git
@@ -47,7 +59,7 @@ cd commitmate
 pip install -e .
 ```
 
-This registers a `commitmate` command on your system, callable from any git repository.
+The `-e` (editable) install links the `commitmate` command back to your local source files, so any changes you make take effect immediately without reinstalling.
 
 ## Usage
 
@@ -107,6 +119,17 @@ If the model's response fails validation (wrong type, description too short, mal
 
 (See `requirements.txt`.)
 
+## Contributing
+
+Contributions are welcome. After cloning and installing with `pip install -e .` (see Installation above), you can make changes and test them immediately with the `commitmate` command, no reinstall needed.
+
+If you want to build the distributable package yourself:
+```bash
+pip install build
+python -m build
+```
+This produces a `.whl` and `.tar.gz` in `dist/`, which you can install into a fresh virtual environment to verify the packaging is correct before opening a PR.
+
 ## Author
 
 Ishan Pathak

{commitmate-1.0.0 → commitmate-1.0.1}/README.md

@@ -27,7 +27,19 @@ Writing good commit messages consistently is tedious, and generic "wip" or "fix
 
 ## Installation
 
-Clone the repo and install it as an editable local package:
+### For users
+
+Install directly from PyPI:
+
+```bash
+pip install commitmate
+```
+
+This registers a `commitmate` command on your system, callable from any git repository.
+
+### For developers / contributors
+
+If you want to modify the source, run tests, or contribute:
 
 ```bash
 git clone https://github.com/theishanpathak/commitmate.git
@@ -35,7 +47,7 @@ cd commitmate
 pip install -e .
 ```
 
-This registers a `commitmate` command on your system, callable from any git repository.
+The `-e` (editable) install links the `commitmate` command back to your local source files, so any changes you make take effect immediately without reinstalling.
 
 ## Usage
 
@@ -95,6 +107,17 @@ If the model's response fails validation (wrong type, description too short, mal
 
 (See `requirements.txt`.)
 
+## Contributing
+
+Contributions are welcome. After cloning and installing with `pip install -e .` (see Installation above), you can make changes and test them immediately with the `commitmate` command, no reinstall needed.
+
+If you want to build the distributable package yourself:
+```bash
+pip install build
+python -m build
+```
+This produces a `.whl` and `.tar.gz` in `dist/`, which you can install into a fresh virtual environment to verify the packaging is correct before opening a PR.
+
 ## Author
 
 Ishan Pathak

{commitmate-1.0.0 → commitmate-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "commitmate"
-version = "1.0.0"
+version = "1.0.1"
 description = "Generates Conventional Commits-style messages from staged git diffs using a local Ollama model."
 readme = "README.md"
 license = "MIT"