git-explain 1.1.0__tar.gz

git_explain-1.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.

git_explain-1.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: git-explain
+Version: 1.1.0
+Summary: CLI that suggests git add/commit from diffs using Gemini
+Author: git-explain contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/nazarli-shabnam/git-explain
+Project-URL: Source, https://github.com/nazarli-shabnam/git-explain
+Keywords: git,cli,commit,ai,gemini
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-genai>=1.50.0
+Requires-Dist: typer>=0.12.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: prompt_toolkit>=3.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Dynamic: license-file
+
+# git-explain
+
+CLI that suggests `git add` and `git commit` from your diffs. Uses local heuristics by default; optional **Gemini** integration for AI-generated messages.
+
+---
+
+## Install
+
+**From GitHub** (any Python 3.10+ env):
+
+```bash
+pip install "git+https://github.com/nazarli-shabnam/git-explain.git@main"
+```
+
+Or from a specific release:
+
+```bash
+pip install "git+https://github.com/nazarli-shabnam/git-explain.git@v0.1.0"
+```
+
+**From source** (repo root, where `pyproject.toml` lives):
+
+```powershell
+python -m venv venv
+.\venv\Scripts\activate
+pip install -e .
+```
+
+---
+
+## API key (for `--ai` only)
+
+Put your Gemini API key in a `.env` file where you run the CLI, or set it in your environment:
+
+```
+GEMINI_API_KEY=your_key_here
+```
+
+Or use `GOOGLE_API_KEY`. Optional: set `GEMINI_MODEL` to override the default (e.g. `GEMINI_MODEL=gemini-2.5-flash`). See [Troubleshooting](#troubleshooting) for 404/429.
+
+---
+
+## Usage
+
+Run from **inside a git repository** that has changes:
+
+```bash
+git-explain
+```
+
+You’ll see a list of changed files, choose which to include, then get suggested `git add` and `git commit` commands. Answer **y** to apply, **n** to preview only, or **auto** to apply and remember for next time.
+
+---
+
+## Modes: `git-explain` vs `git-explain --ai` vs `git-explain --with-diff --ai`
+
+| Command | What it does |
+|---------|--------------|
+| `git-explain` | **Heuristics only.** No API call. Suggests commit type and message from file names and status (e.g. docs, tests, config, code). Fast and private. |
+| `git-explain --ai` | **AI (paths only).** Sends only file paths and statuses (A/M/D) to Gemini. No file contents. Good for smarter messages without sharing code. |
+| `git-explain --with-diff --ai` | **AI (full diff).** Sends file list **plus** the full diff (staged, unstaged, untracked content) to Gemini. Produces detailed, specific messages (e.g. `feat: add opt-in --with-diff for detailed AI commit messages`). Opt-in; use when you want maximum accuracy and are okay sending diff content to the API. |
+
+**Summary:** Use plain `git-explain` for speed and privacy. Use `--ai` for better suggestions without sharing code. Use `--with-diff --ai` when you want the most accurate, context-aware messages and accept sending diff content to Gemini.
+
+---
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--help` | Show all options. |
+| `--auto` | Apply suggestion without prompting. |
+| `--ai` | Use Gemini for commit type/message (file paths only). |
+| `--with-diff` | With `--ai`: send full diff to the model for detailed messages. |
+| `--model NAME` | Override Gemini model (e.g. `--model gemini-2.0-flash`). |
+| `--staged-only` | Commit only what’s already staged (no `git add`). |
+| `--cwd PATH` | Run as if current directory is `PATH`. |
+| `--install-completion [SHELL]` | Install shell completion (`bash`, `zsh`). |
+| `--show-completion [SHELL]` | Print completion script for `SHELL`. |
+
+---
+
+## Workflow
+
+1. **Changed files** — Shows staged, unstaged, and untracked files. Untracked folders are grouped (e.g. `foo/ (untracked folder; 5 files)`).
+2. **Select files** — Enter numbers (e.g. `1,2,5-7`), `all`, or a path (e.g. `main.py`, `src/utils/`).
+3. **Commit mode** — If you selected 2+ files: choose `one` (single commit) or `split` (separate commits by docs/tests/config/code).
+4. **Suggested commands** — Panel with `git add` and `git commit` lines.
+5. **Edit (optional)** — You can tweak the commit message inline before applying.
+6. **Apply** — Answer `y` to run the commands, `n` to preview only, or `auto` to apply and remember.
+
+**Quick try:** Make a small change, run `git-explain`, answer **n** to only preview. If you see "No staged, unstaged, or untracked changes", ensure you have modified or added files that are not ignored by `.gitignore`.
+
+---
+
+## Troubleshooting
+
+**429 RESOURCE_EXHAUSTED / "quota exceeded" / "limit: 0"**  
+Quota or rate limit. Default model `gemini-2.5-flash` has free-tier quota; if you overrode `GEMINI_MODEL`, try removing it or set `GEMINI_MODEL=gemini-2.5-flash`. The app retries once after ~15s; see [rate limits](https://ai.google.dev/gemini-api/docs/rate-limits).
+
+**404 NOT_FOUND / "models/... is not found"**  
+Set a valid model in `.env`, e.g. `GEMINI_MODEL=gemini-2.5-flash`. Check [Google's model list](https://ai.google.dev/api/models).
+
+---
+
+## Test
+
+From repo root:
+
+```bash
+pip install -e ".[dev]"
+pytest -q
+```

git_explain-1.1.0/README.md

@@ -0,0 +1,113 @@
+# git-explain
+
+CLI that suggests `git add` and `git commit` from your diffs. Uses local heuristics by default; optional **Gemini** integration for AI-generated messages.
+
+---
+
+## Install
+
+**From GitHub** (any Python 3.10+ env):
+
+```bash
+pip install "git+https://github.com/nazarli-shabnam/git-explain.git@main"
+```
+
+Or from a specific release:
+
+```bash
+pip install "git+https://github.com/nazarli-shabnam/git-explain.git@v0.1.0"
+```
+
+**From source** (repo root, where `pyproject.toml` lives):
+
+```powershell
+python -m venv venv
+.\venv\Scripts\activate
+pip install -e .
+```
+
+---
+
+## API key (for `--ai` only)
+
+Put your Gemini API key in a `.env` file where you run the CLI, or set it in your environment:
+
+```
+GEMINI_API_KEY=your_key_here
+```
+
+Or use `GOOGLE_API_KEY`. Optional: set `GEMINI_MODEL` to override the default (e.g. `GEMINI_MODEL=gemini-2.5-flash`). See [Troubleshooting](#troubleshooting) for 404/429.
+
+---
+
+## Usage
+
+Run from **inside a git repository** that has changes:
+
+```bash
+git-explain
+```
+
+You’ll see a list of changed files, choose which to include, then get suggested `git add` and `git commit` commands. Answer **y** to apply, **n** to preview only, or **auto** to apply and remember for next time.
+
+---
+
+## Modes: `git-explain` vs `git-explain --ai` vs `git-explain --with-diff --ai`
+
+| Command | What it does |
+|---------|--------------|
+| `git-explain` | **Heuristics only.** No API call. Suggests commit type and message from file names and status (e.g. docs, tests, config, code). Fast and private. |
+| `git-explain --ai` | **AI (paths only).** Sends only file paths and statuses (A/M/D) to Gemini. No file contents. Good for smarter messages without sharing code. |
+| `git-explain --with-diff --ai` | **AI (full diff).** Sends file list **plus** the full diff (staged, unstaged, untracked content) to Gemini. Produces detailed, specific messages (e.g. `feat: add opt-in --with-diff for detailed AI commit messages`). Opt-in; use when you want maximum accuracy and are okay sending diff content to the API. |
+
+**Summary:** Use plain `git-explain` for speed and privacy. Use `--ai` for better suggestions without sharing code. Use `--with-diff --ai` when you want the most accurate, context-aware messages and accept sending diff content to Gemini.
+
+---
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--help` | Show all options. |
+| `--auto` | Apply suggestion without prompting. |
+| `--ai` | Use Gemini for commit type/message (file paths only). |
+| `--with-diff` | With `--ai`: send full diff to the model for detailed messages. |
+| `--model NAME` | Override Gemini model (e.g. `--model gemini-2.0-flash`). |
+| `--staged-only` | Commit only what’s already staged (no `git add`). |
+| `--cwd PATH` | Run as if current directory is `PATH`. |
+| `--install-completion [SHELL]` | Install shell completion (`bash`, `zsh`). |
+| `--show-completion [SHELL]` | Print completion script for `SHELL`. |
+
+---
+
+## Workflow
+
+1. **Changed files** — Shows staged, unstaged, and untracked files. Untracked folders are grouped (e.g. `foo/ (untracked folder; 5 files)`).
+2. **Select files** — Enter numbers (e.g. `1,2,5-7`), `all`, or a path (e.g. `main.py`, `src/utils/`).
+3. **Commit mode** — If you selected 2+ files: choose `one` (single commit) or `split` (separate commits by docs/tests/config/code).
+4. **Suggested commands** — Panel with `git add` and `git commit` lines.
+5. **Edit (optional)** — You can tweak the commit message inline before applying.
+6. **Apply** — Answer `y` to run the commands, `n` to preview only, or `auto` to apply and remember.
+
+**Quick try:** Make a small change, run `git-explain`, answer **n** to only preview. If you see "No staged, unstaged, or untracked changes", ensure you have modified or added files that are not ignored by `.gitignore`.
+
+---
+
+## Troubleshooting
+
+**429 RESOURCE_EXHAUSTED / "quota exceeded" / "limit: 0"**  
+Quota or rate limit. Default model `gemini-2.5-flash` has free-tier quota; if you overrode `GEMINI_MODEL`, try removing it or set `GEMINI_MODEL=gemini-2.5-flash`. The app retries once after ~15s; see [rate limits](https://ai.google.dev/gemini-api/docs/rate-limits).
+
+**404 NOT_FOUND / "models/... is not found"**  
+Set a valid model in `.env`, e.g. `GEMINI_MODEL=gemini-2.5-flash`. Check [Google's model list](https://ai.google.dev/api/models).
+
+---
+
+## Test
+
+From repo root:
+
+```bash
+pip install -e ".[dev]"
+pytest -q
+```

git_explain-1.1.0/git_explain/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"