commitstash 0.4.0__tar.gz → 0.5.0__tar.gz

commitstash-0.5.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Something isn't working as expected
+title: "bug: "
+labels: bug
+---
+
+## What happened
+
+<!-- A clear description of the bug. -->
+
+## Steps to reproduce
+
+1.
+2.
+3.
+
+## Expected behavior
+
+<!-- What you expected instead. -->
+
+## Command & output
+
+<!-- The commitstash command you ran and its output. Redact any secrets. -->
+
+```
+$ commitstash ...
+```
+
+## Environment
+
+- commitstash version (`commitstash version`):
+- Install source (PyPI `commitstash` / from source):
+- OS:
+- Python version (`python --version`):
+- LLM provider (anthropic / openai / ollama / local `--no-ai`):
+
+## Additional context
+
+<!-- Anything else that helps — a minimal repo, git state, config. -->

commitstash-0.5.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

commitstash-0.5.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest an idea or improvement
+title: "feat: "
+labels: enhancement
+---
+
+## Problem / motivation
+
+<!-- What are you trying to do that commitstash doesn't support today? -->
+
+## Proposed solution
+
+<!-- What you'd like to see. If it's a new command or flag, sketch the usage. -->
+
+```
+$ commitstash ...
+```
+
+## Alternatives considered
+
+<!-- Other approaches you thought about. -->
+
+## Additional context
+
+<!-- Is this a new LLM provider, a new command, output formatting, etc.? -->

commitstash-0.5.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+Thanks for contributing! Keep this short — see CONTRIBUTING.md for the full guide.
+Use a Conventional Commit-style title, e.g. "feat: add Gemini provider".
+-->
+
+## Summary
+
+<!-- What does this change and why? -->
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Docs
+- [ ] Refactor / chore
+- [ ] Tests
+
+## Testing performed
+
+<!-- Commands run and their result. Include CLI output only if it clarifies interactive behavior. -->
+
+```
+ruff check .
+mypy commitstash/
+pytest -q
+```
+
+## User-facing CLI changes
+
+<!-- New/changed commands or flags, or "none". -->
+
+## Checklist
+
+- [ ] Commits follow Conventional Commits (`feat:`, `fix:`, `docs:`, …)
+- [ ] `ruff`, `mypy`, and `pytest` pass locally
+- [ ] Added/updated tests where it makes sense
+- [ ] No secrets or local config committed
+- [ ] Linked any related issue (`Closes #123`)

{commitstash-0.4.0 → commitstash-0.5.0}/.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
 
       - name: Type-check with mypy
         if: matrix.python-version == '3.12'
-        run: mypy autocommit/
+        run: mypy commitstash/
 
       - name: Run tests
         run: pytest -q

{commitstash-0.4.0 → commitstash-0.5.0}/.gitignore

@@ -22,3 +22,6 @@ htmlcov/
 .DS_Store
 .idea/
 .vscode/
+
+# Tooling
+.sf/

{commitstash-0.4.0 → commitstash-0.5.0}/AGENTS.md

@@ -4,14 +4,14 @@
 
 This repository contains a small Python CLI package for generating commit messages from staged diffs.
 
-- `autocommit/cli.py` defines the Click command group, interactive prompts, and subcommands.
-- `autocommit/git.py` wraps git operations such as reading staged files and creating commits.
-- `autocommit/llm.py` builds prompts and calls Anthropic or OpenAI providers.
-- `autocommit/config.py` loads and saves user preferences in `~/.autocommit/config.json`.
+- `commitstash/cli.py` defines the Click command group, interactive prompts, and subcommands.
+- `commitstash/git.py` wraps git operations such as reading staged files and creating commits.
+- `commitstash/llm.py` builds prompts and calls Anthropic or OpenAI providers.
+- `commitstash/config.py` loads and saves user preferences in `~/.commitstash/config.json`.
 - `README.md` documents user-facing installation, setup, and CLI usage.
 - `pyproject.toml` contains package metadata, dependencies, console script wiring, and Ruff settings.
 
-There is no committed `tests/` directory yet; add one with new tests.
+Tests live in `tests/`, organized by source module as `test_<module>.py`.
 
 ## Build, Test, and Development Commands
 
@@ -25,12 +25,12 @@ pip install -e ".[dev]"
 
 Common commands:
 
-- `autocommit version` verifies the editable console script is installed.
-- `pytest` runs the test suite once tests exist.
+- `commitstash version` verifies the editable console script is installed.
+- `pytest` runs the test suite.
 - `ruff check .` runs lint checks with the repository line length setting.
 - `python -m build` builds distribution artifacts, if the `build` package is installed.
 
-For manual testing, stage a small change in a disposable git repo and run `autocommit`.
+For manual testing, stage a small change in a disposable git repo and run `commitstash`.
 
 ## Coding Style & Naming Conventions
 
@@ -44,10 +44,10 @@ Use `pytest` for new tests. Place tests under `tests/` and name files `test_<mod
 
 ## Commit & Pull Request Guidelines
 
-Recent history uses Conventional Commit-style messages, for example `docs: add README` and `feat: initial autocommit CLI`. Continue using concise prefixes such as `feat:`, `fix:`, `docs:`, `test:`, and `chore:`.
+Recent history uses Conventional Commit-style messages, for example `docs: add README` and `feat: initial commitstash CLI`. Continue using concise prefixes such as `feat:`, `fix:`, `docs:`, `test:`, and `chore:`.
 
 Pull requests should include a short summary, testing performed, and any user-facing CLI behavior changes. Link related issues when available. Include terminal output only when it clarifies interactive CLI changes.
 
 ## Security & Configuration Tips
 
-Never commit API keys or generated local config. `ANTHROPIC_API_KEY` and `OPENAI_API_KEY` must stay in environment variables. Do not persist secrets in `~/.autocommit/config.json` or test fixtures.
+Never commit API keys or generated local config. `ANTHROPIC_API_KEY` and `OPENAI_API_KEY` must stay in environment variables. Do not persist secrets in `~/.commitstash/config.json` or test fixtures.

{commitstash-0.4.0 → commitstash-0.5.0}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.5.0 (2026-09-07)
+
+### Changed
+
+- standardize the distribution, command, Python package, configuration path, and documentation as `commitstash`
+- config moves to `~/.commitstash/config.json`; an existing `~/.autocommit/config.json` is
+  carried over automatically on first run, so settings and onboarding state survive the upgrade
+
 ## v0.4.0 (2026-07-19)
 
 ### Features
@@ -14,7 +22,7 @@
 
 ### Features
 
-- initial autocommit CLI — AI-powered git commit message generator
+- initial commitstash CLI — AI-powered git commit message generator
 - **secrets:** add regex-based secret scanner
 - **llm:** add ollama provider and shared completion dispatch
 - **review:** add staged-diff code review module

commitstash-0.5.0/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to commitstash
+
+Thanks for your interest in improving **commitstash** (published on PyPI as
+[`commitstash`](https://pypi.org/project/commitstash/)) — an AI-powered git
+workflow CLI that writes commit messages, scans for secrets, reviews diffs, and
+drafts PRs from your staged changes.
+
+This guide covers the fast path for contributors. For deeper conventions on
+structure, style, and testing, see [`AGENTS.md`](./AGENTS.md).
+
+## Development setup
+
+Requires **Python 3.9+**.
+
+```bash
+git clone https://github.com/suryaSPS/commitstash.git
+cd commitstash
+
+python -m venv .venv
+source .venv/bin/activate       # Windows: .venv\Scripts\activate
+
+pip install -e ".[dev]"          # editable install + dev tooling
+pre-commit install               # run lint/type checks on every commit
+```
+
+Verify the console script is wired up:
+
+```bash
+commitstash version
+```
+
+## Running the checks
+
+CI (`.github/workflows/ci.yml`) runs these across Python 3.9–3.12, so run them
+locally before pushing:
+
+```bash
+ruff check .            # lint (100-char line length)
+mypy commitstash/        # type-check
+pytest -q               # tests
+```
+
+## Making a change
+
+1. Branch off `master`: `git checkout -b feat/short-description`.
+2. Make focused commits — this repo **dogfoods itself**, so stage your changes
+   and run `commitstash` to generate the message.
+3. Follow [Conventional Commits](https://www.conventionalcommits.org/): prefixes
+   like `feat:`, `fix:`, `docs:`, `test:`, `chore:`, `refactor:`. The
+   `commitstash changelog` command relies on these to generate release notes.
+4. Add or update tests under `tests/` (`test_<module>.py`). Mock network clients
+   and subprocess calls — never require a real API key or make real commits.
+5. Open a PR against `master` using the pull request template.
+
+## Adding a new LLM provider
+
+Providers live in [`commitstash/providers.py`](./commitstash/providers.py) behind a
+small abstraction, so adding one (e.g. Gemini or Groq) is self-contained:
+
+1. Subclass `LLMProvider` and implement `complete(self, prompt, config, max_tokens)`,
+   returning the model's text response.
+2. Give it a `name` and register it in the `PROVIDERS` registry (follow how
+   `AnthropicProvider`, `OpenAIProvider`, and `OllamaProvider` do it).
+3. If the provider runs locally with no key (like Ollama), add its name to
+   `LOCAL_PROVIDERS` in `commitstash/llm.py`.
+4. Add unit tests that mock the client — assert prompt handling and error paths,
+   not live network calls.
+
+## Reporting bugs & requesting features
+
+Use the [issue templates](./.github/ISSUE_TEMPLATE/) — they prompt for the
+version (`commitstash version`), OS, provider, and steps to reproduce, which makes
+triage much faster.
+
+## Security
+
+Never commit API keys or generated local config. `ANTHROPIC_API_KEY` and
+`OPENAI_API_KEY` belong in environment variables only, never in
+`~/.commitstash/config.json` or test fixtures. If you find a security issue,
+please open a minimal report rather than including real secrets.
+
+## License
+
+By contributing, you agree that your contributions are licensed under the
+project's [MIT License](./LICENSE).

{commitstash-0.4.0 → commitstash-0.5.0}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: commitstash
-Version: 0.4.0
+Version: 0.5.0
 Summary: AI-powered git commit message generator — reads your staged diff, writes the commit for you
-Project-URL: Homepage, https://github.com/suryaSPS/autocommit
-Project-URL: Issues, https://github.com/suryaSPS/autocommit/issues
+Project-URL: Homepage, https://github.com/suryaSPS/commitstash
+Project-URL: Issues, https://github.com/suryaSPS/commitstash/issues
 Author-email: Surya Pratap Singh <suryasps20@gmail.com>
 License: MIT
 License-File: LICENSE
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 
 <div align="center">
 
-# autocommit
+# commitstash
 
 **AI-powered git commit message generator — reads your staged diff, writes the commit for you**
 
@@ -50,18 +50,18 @@ Writing good commit messages is tedious. Most developers either:
 
 ## The Solution
 
-`autocommit` reads your staged diff and generates a precise, conventional commit message using Claude or GPT — in under 3 seconds. No API key? Run it fully offline with `--no-ai` and it builds a message straight from the diff, or point it at a local model with Ollama.
+`commitstash` reads your staged diff and generates a precise, conventional commit message using Claude or GPT — in under 3 seconds. No API key? Run it fully offline with `--no-ai` and it builds a message straight from the diff, or point it at a local model with Ollama.
 
 It does more than messages:
 
 - **Blocks secrets** — every commit is scanned for API keys, tokens, and credentials in your staged changes. Leaks are stopped before they land.
-- **Reviews your diff** — `autocommit review` flags bugs and issues before you commit.
-- **Writes your PR** — `autocommit pr` drafts a title and description from your branch's commits and diff.
+- **Reviews your diff** — `commitstash review` flags bugs and issues before you commit.
+- **Writes your PR** — `commitstash pr` drafts a title and description from your branch's commits and diff.
 
 ```
 git add orders/views.py orders/serializers.py
 
-autocommit
+commitstash
 ```
 
 ```
@@ -109,7 +109,7 @@ Add the export to your `~/.zshrc` or `~/.bashrc` so it persists.
 git add <files>
 
 # Generate and commit
-autocommit
+commitstash
 ```
 
 That's it. Press Enter to accept, `e` to edit, `r` to regenerate, `q` to quit.
@@ -120,26 +120,26 @@ That's it. Press Enter to accept, `e` to edit, `r` to regenerate, `q` to quit.
 
 ```bash
 # Stage everything, then generate
-autocommit -a
+commitstash -a
 
 # Auto-accept without prompting (CI / hooks)
-autocommit -a -y
+commitstash -a -y
 
 # Change style for one commit
-autocommit --style simple
-autocommit --style angular
+commitstash --style simple
+commitstash --style angular
 
 # Add emoji prefix  (✨ feat, 🐛 fix, ♻️ refactor...)
-autocommit --emoji
+commitstash --emoji
 
 # Include a commit body explaining WHY
-autocommit --body
+commitstash --body
 
 # Switch provider for one commit
-autocommit --provider openai
+commitstash --provider openai
 
 # No API key — generate offline from the diff
-autocommit --no-ai
+commitstash --no-ai
 ```
 
 ---
@@ -147,12 +147,12 @@ autocommit --no-ai
 ## No-AI (offline) mode
 
 Don't have an API key, working offline, or just want zero-cost commits? Add `--no-ai`
-and `autocommit` builds the message locally by analyzing your staged diff — no network,
+and `commitstash` builds the message locally by analyzing your staged diff — no network,
 no key, no SDK required.
 
 ```bash
-autocommit --no-ai        # generate offline
-autocommit --no-ai -a -y  # stage all, offline, auto-accept
+commitstash --no-ai        # generate offline
+commitstash --no-ai -a -y  # stage all, offline, auto-accept
 ```
 
 It inspects the diff to pick a sensible message:
@@ -173,14 +173,14 @@ reader — press `e` to tweak anything before committing.
 Make it the default so you never pass the flag:
 
 ```bash
-autocommit configure   # choose "local" when prompted for provider
+commitstash configure   # choose "local" when prompted for provider
 ```
 
 ---
 
 ## Secret Scanning
 
-Before every commit, `autocommit` scans your **staged changes** for secrets — AWS keys,
+Before every commit, `commitstash` scans your **staged changes** for secrets — AWS keys,
 GitHub tokens, Anthropic/OpenAI keys, Slack/Stripe/Google keys, private key blocks, JWTs,
 and hardcoded `password`/`api_key`/`token` assignments. If it finds one, the commit is
 blocked and the finding is shown with the secret redacted:
@@ -199,10 +199,10 @@ Run the scan on its own — it exits non-zero when anything is found, so it drop
 a pre-commit hook or CI step:
 
 ```bash
-autocommit scan
+commitstash scan
 ```
 
-Turn the automatic commit-time gate off in `autocommit configure` (or set `"scan_secrets": false`
+Turn the automatic commit-time gate off in `commitstash configure` (or set `"scan_secrets": false`
 in your config).
 
 ---
@@ -212,8 +212,8 @@ in your config).
 Get a review of your staged diff before you commit:
 
 ```bash
-autocommit review            # AI review with your configured provider
-autocommit review --no-ai    # offline pattern checks only
+commitstash review            # AI review with your configured provider
+commitstash review --no-ai    # offline pattern checks only
 ```
 
 With an AI provider it looks for bugs, security issues, and clear mistakes in the changed
@@ -228,9 +228,9 @@ and tells you it isn't a correctness review.
 Draft a PR title and description from the commits and diff on your current branch:
 
 ```bash
-autocommit pr                    # base branch autodetected (origin/HEAD, then main/master)
-autocommit pr --base develop     # compare against a specific branch
-autocommit pr --no-ai            # assemble from commit subjects, no API key
+commitstash pr                    # base branch autodetected (origin/HEAD, then main/master)
+commitstash pr --base develop     # compare against a specific branch
+commitstash pr --no-ai            # assemble from commit subjects, no API key
 ```
 
 Output is a title plus a `## Summary` / `## Changes` / `## Testing` markdown body — paste it
@@ -253,14 +253,14 @@ straight into GitHub.
 Run the interactive setup to save your preferences:
 
 ```bash
-autocommit configure
+commitstash configure
 ```
 
-Preferences are saved to `~/.autocommit/config.json`.
+Preferences are saved to `~/.commitstash/config.json`.
 API keys are **never** written to disk — always read from environment variables.
 
 <details>
-<summary>Manual config (~/.autocommit/config.json)</summary>
+<summary>Manual config (~/.commitstash/config.json)</summary>
 
 ```json
 {
@@ -291,12 +291,12 @@ API keys are **never** written to disk — always read from environment variable
 
 Switch permanently:
 ```bash
-autocommit configure   # select openai when prompted
+commitstash configure   # select openai when prompted
 ```
 
 Switch for one commit:
 ```bash
-autocommit -p openai
+commitstash -p openai
 ```
 
 ### Ollama (local LLM)
@@ -307,8 +307,8 @@ Run a real model on your own machine — no API key, no network calls off-box:
 ollama serve
 ollama pull llama3.2
 
-autocommit -p ollama            # one commit
-autocommit configure            # choose "ollama"; set model + host
+commitstash -p ollama            # one commit
+commitstash configure            # choose "ollama"; set model + host
 ```
 
 Model and host are configurable (`ollama_model`, `ollama_host`).
@@ -317,10 +317,10 @@ Model and host are configurable (`ollama_model`, `ollama_host`).
 
 ## Git Hook
 
-Install `autocommit` as a `prepare-commit-msg` hook so every `git commit` auto-generates a message:
+Install `commitstash` as a `prepare-commit-msg` hook so every `git commit` auto-generates a message:
 
 ```bash
-autocommit install-hook
+commitstash install-hook
 ```
 
 To uninstall:
@@ -332,13 +332,13 @@ rm .git/hooks/prepare-commit-msg
 
 ## Commit Splitting
 
-Staged everything at once? `autocommit split` clusters the staged files into
+Staged everything at once? `commitstash split` clusters the staged files into
 logical commits — source changes by scope, then tests, docs, and config — and
 commits each group with its own generated message:
 
 ```
 git add .
-autocommit split
+commitstash split
 
 Proposed split (3 commits, AI grouping)
 
@@ -369,19 +369,19 @@ silently dragging unstaged work into a commit.
 
 ```bash
 # Plain-language explanation of the staged diff — what, why, impact, risk
-autocommit explain
+commitstash explain
 
 # Changelog section from conventional commits since the last tag
-autocommit changelog
+commitstash changelog
 
 # ...or a labelled release, prepended to CHANGELOG.md
-autocommit changelog --label v0.3.0 --write
+commitstash changelog --label v0.3.0 --write
 ```
 
 `changelog` is deliberately deterministic — the same history always produces
 the same changelog, so it needs no API key and works in CI.
 
-`autocommit` also reads your recent commit history when generating messages,
+`commitstash` also reads your recent commit history when generating messages,
 so suggestions match the tone and scope conventions your repo already uses.
 
 ---
@@ -392,7 +392,7 @@ Backends are pluggable. Anything that can complete a prompt can drive every
 feature — subclass, register, done:
 
 ```python
-from autocommit.providers import LLMProvider, register
+from commitstash.providers import LLMProvider, register
 
 class GroqProvider(LLMProvider):
     name = "groq"
@@ -409,19 +409,19 @@ register(GroqProvider())
 
 | Command | Description |
 |---|---|
-| `autocommit` | Generate from staged diff (interactive) |
-| `autocommit -a` | Stage all changes, then generate |
-| `autocommit -y` | Auto-accept first suggestion |
-| `autocommit --no-ai` | Generate offline, no API key needed |
-| `autocommit scan` | Scan staged changes for secrets (exits 1 on findings) |
-| `autocommit review` | Review the staged diff for bugs and issues |
-| `autocommit pr` | Draft a PR title and description for the branch |
-| `autocommit split` | Split staged changes into a series of atomic commits |
-| `autocommit explain` | Explain the staged diff: what, why, impact, risk |
-| `autocommit changelog` | Generate a changelog from conventional commit history |
-| `autocommit configure` | Interactive setup |
-| `autocommit install-hook` | Install as git hook in current repo |
-| `autocommit version` | Show version |
+| `commitstash` | Generate from staged diff (interactive) |
+| `commitstash -a` | Stage all changes, then generate |
+| `commitstash -y` | Auto-accept first suggestion |
+| `commitstash --no-ai` | Generate offline, no API key needed |
+| `commitstash scan` | Scan staged changes for secrets (exits 1 on findings) |
+| `commitstash review` | Review the staged diff for bugs and issues |
+| `commitstash pr` | Draft a PR title and description for the branch |
+| `commitstash split` | Split staged changes into a series of atomic commits |
+| `commitstash explain` | Explain the staged diff: what, why, impact, risk |
+| `commitstash changelog` | Generate a changelog from conventional commit history |
+| `commitstash configure` | Interactive setup |
+| `commitstash install-hook` | Install as git hook in current repo |
+| `commitstash version` | Show version |
 
 ---