git2report 0.1.0__py3-none-any.whl

git2report-0.1.0.dist-info/METADATA

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: git2report
+Version: 0.1.0
+Summary: Turn Git history into a plain-language, evidence-linked progress report with visual charts and Terminal Web Studio.
+Author-email: Vijay <vijaykd04@users.noreply.github.com>
+License: MIT
+Project-URL: Homepage, https://github.com/vijaykd04/Git2Report
+Project-URL: Repository, https://github.com/vijaykd04/Git2Report.git
+Project-URL: Issues, https://github.com/vijaykd04/Git2Report/issues
+Keywords: git,report,changelog,ai,gemini,ollama,terminal,metrics
+Classifier: Programming Language :: Python :: 3
+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: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydriller>=2.5
+Requires-Dist: typer>=0.9
+Requires-Dist: jinja2>=3.1
+Requires-Dist: reportlab>=4.0
+Requires-Dist: ollama>=0.3
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# Git2Report
+
+Turn a Git repository's history into a plain-language weekly progress report, where **every number is
+counted by code** and **every line carries commit IDs as proof**. The AI (optional, local) only writes
+sentences.
+
+```
+git2report --repo . --since 7d --audience guide --out report.pdf
+```
+
+## Install
+
+```
+python -m venv .venv
+.venv\Scripts\activate          # Windows   (Linux/macOS: source .venv/bin/activate)
+pip install -e ".[dev]"          # core + pytest
+pip install -e ".[ollama]"       # only if you want AI sentences (also install Ollama from ollama.com)
+```
+
+## Use
+
+### 🖥️ Interactive Web Studio GUI
+Launch the browser-based dashboard to configure, run, preview, and download reports with 1 click:
+```
+git2report --ui               # Opens Web Studio at http://localhost:5000
+# or: git2report-ui
+```
+
+### 💻 Command Line (Terminal)
+```bash
+# 1. Standard full-format generation (PDF + HTML + Markdown)
+git2report --repo ./myproject --since 7d --all --out report.html
+
+# 2. Local AI with Ollama (Private, offline, zero API keys)
+git2report --repo ./myproject --llm ollama --model llama3:8b
+# Or shortcut:
+git2report --repo ./myproject --ollama --model mistral
+
+# 3. Cloud AI with Google Gemini (Fast, smart summary caching)
+git2report --repo ./myproject --llm gemini --model gemini-2.5-flash
+
+# 4. Pure offline deterministic mode (Zero AI, instant)
+git2report --repo ./myproject --llm offline --audience guide
+
+# 5. Targeted audience personas
+git2report --repo ./myproject --since 2w --audience client --both          # Business & user-facing
+git2report --repo ./myproject --since 2w --audience team --both            # Engineering release notes
+
+# 6. Sprint goals & caching
+git2report --repo . --next "Finish payment gateway" --next "Write tests"   # Authentic developer goals
+git2report --clear-cache                                                   # Reset summary cache
+```
+
+### AI Engines (`--llm`)
+- **`--llm ollama`**: Uses a local model running on your machine via [Ollama](https://ollama.com/) (e.g., `llama3:8b`, `llama3.2`, `mistral`, `deepseek-r1:8b`, `phi4`). Zero data leaves your machine. Automatically discovers available local models. If Ollama is offline or uninstalled, it gracefully falls back to deterministic offline wording without crashing.
+- **`--llm gemini`**: Uses Google Gemini (`gemini-2.5-flash`) with smart SHA-256 caching (`.git2report_cache.json`) for fast execution and zero duplicate token costs. Set `GEMINI_API_KEY` in your environment or `.env` file.
+- **`--llm offline`** (default): Builds clean human sentences directly from commit messages without invoking any AI.
+
+Every AI output is validated by code: if the model returns invalid JSON, mentions raw numbers, or mentions file paths, Git2Report automatically retries once and falls back safely.
+
+
+## Evaluation (manual vs tool vs baseline)
+
+```
+git2report-eval sheet --repo ./proj --since 45d --n 25 --out eval.csv    # builds the sheet
+# open eval.csv in Excel: write manual_summary, give 1-5 scores, count unsupported claims
+git2report-eval score eval.csv --out results.md                          # averages: tool vs baseline
+```
+The baseline is what you get without the pipeline: the raw commit message (offline) or the raw commit pasted
+to the AI (`--llm ollama`). Be honest in the project report about the sample size and whose repo it was.
+
+## Audiences (offline mode)
+
+`guide` = full list, `client` = only user-facing work (features, fixes, performance), `team` = release-notes
+grouped by type. A commit's type comes from `type(scope):` if present, otherwise it is guessed from its first
+word (Add = feature, Fix = fix, Remove = refactor...). It is a heuristic, so check it on your own repo.
+
+## How it works (7 steps, one file each)
+
+| Step | File | Output |
+|---|---|---|
+| 1 Extract | `extractor.py` | list of `CommitRecord` |
+| 2 Filter | `filtering.py` | kept commits + a reason for every decision |
+| 3 Cluster | `clustering.py` | `{module: [commits]}` (scope, then folder, then commit type) |
+| 4 Metrics | `metrics.py` | numbers (junk files excluded) |
+| 5 Chunk | `chunker.py` | short code text per module, within a token budget |
+| 6 Summarise | `summarizer.py` | one sentence per module (AI or offline), checked by code |
+| 7 Report | `report.py` | Markdown (Jinja2) and PDF (ReportLab) |
+
+Tunable rules (junk files, noise words, aliases, budget) live in `config.py`.
+
+## Develop
+
+```
+pytest -q                  # 38 tests, uses a throw-away real Git repo
+bash scripts/make_demo_repo.sh   # 10-commit demo repo in ./demo_repo
+```
+
+## Status
+
+Done and tested:
+- Steps 1-7 deterministic pipeline with verified commit hashes.
+- 🖥️ **Interactive Web Studio GUI** (`git2report --ui`) with real-time progress, live preview, and direct PDF/HTML/MD downloads.
+- ⚡ **Smart Summary Cache** (`.git2report_cache.json`) for instant sub-second re-runs and 0 API token waste.
+- 📊 **Visual Analytics & Charts** (Commit type distribution segmented bar & module churn chart embedded in PDF & HTML).
+- Offline summaries per audience, unmerged "in progress" branches, developer-written sprint goals.
+- 🦙 **Ollama Local AI & Google Gemini Cloud AI**: Choose between 100% private local models (`llama3:8b`, `mistral`, `deepseek-r1`) or Google Gemini (`gemini-2.5-flash`), with automated code-validation and fallback.
+- ReportLab PDF, interactive HTML, Markdown, and 43 automated tests.
+- Tried on demo repo, pallets/click, and real full-stack project (CampusThrift).
+
+**Optional future work:** config file, multi-repo aggregator.

git2report-0.1.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+git2report/__init__.py,sha256=BFD8YXfiLTrZ7DVGdWwDFH_ykhVGQLiyXRnpM7Vju4s,113
+git2report/__main__.py,sha256=CcNQPexQIsuoFnkuCrYhVLrH9c3kBH9XcO7FHhJpCHc,69
+git2report/branches.py,sha256=GHrqRG3NDXCQ4XzNLYCtJ2V3Z9qWf5g7Fj9wMKjT2EU,1551
+git2report/cache.py,sha256=U82XFCkwRSTHfjS9JGP72uiP1kg6ngT0g-ZcLwTSrMk,2431
+git2report/charts.py,sha256=BustQhbnCZRE-dHipDH79E0DmX5TPLHsxUFGmCSkNV0,6035
+git2report/chunker.py,sha256=lwq-WZzKoljttHdOSnkBDtrpm8_xJ9RWhlhfYoPvkXk,1665
+git2report/cli.py,sha256=rtYW8zs1R2wLXps391MfjmqnayVNdGaxiYlp05wWd7M,7588
+git2report/clustering.py,sha256=jQe-fV1P3pdscPVqRxmR_tsk-oBSTC12L-yH2-yx07I,2373
+git2report/config.py,sha256=LIFFmItrov1TI2f6KjEDIkQv3le7tdN0SeKZw_QhWGM,1541
+git2report/eval_tools.py,sha256=D5Wkk3T7dCqo3UGaXG0pw1h1-Y3BwzGXb6zoVrqXeU8,5397
+git2report/extractor.py,sha256=nEGnMI0xEFaXkj3ax1rRivu-wMXGTQExsZTOHrSndj8,1419
+git2report/filtering.py,sha256=kJyePSoCDACfcDajHYDyh2oRZJJpTG9hPRieY6x1kwQ,1202
+git2report/metrics.py,sha256=mMXcrYAbixJh-VYtrcvkhtjo4iI0MVmYJDxD9nRs3PA,4977
+git2report/models.py,sha256=sEO6z-OcKSjkMsYWkAgfjttBHi_6Xm4e-rD9IOUH4sA,984
+git2report/pipeline.py,sha256=gszxBNhM1vR7c4P8fJytnSE6TQBiiJiW7qhQN9IkfoE,8948
+git2report/report.py,sha256=-yQu4nxa_idQXNbGUrfTXhBmu0RmWq2dc9-82aY9K1Y,36302
+git2report/rules.py,sha256=Zv282l5ilFU8HnKilDj8m4ETu1Or3RjfAYxgFMxJRU8,2794
+git2report/summarizer.py,sha256=JyGcTFF50S_QCZPr8i_XvFn35NLSUm-6EKubSrnmx-0,14528
+git2report/timeutil.py,sha256=lVWueZ20SYAObMlcE0RaghRqLQ8FfMJTqXIb5pF4_8A,722
+git2report/web.py,sha256=DrGALWm9Gjl19kWVQdyjTdUI8vo8grVw65ul2P3OhWY,42918
+git2report-0.1.0.dist-info/licenses/LICENSE,sha256=3dbJ0oOHU8rWroX2tB-dPJ9rIsRx9tUWXYlfVrG9tR4,1062
+git2report-0.1.0.dist-info/METADATA,sha256=IeH9xKUwEphlCziczHEy76fjrx3tmROSGGRgKd8y7Wk,6983
+git2report-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+git2report-0.1.0.dist-info/entry_points.txt,sha256=SUNfYYolMvveOFwlN23B8X3V6Igrjr_ZhuEkKZbqVCU,130
+git2report-0.1.0.dist-info/top_level.txt,sha256=kylwpjWLHBM8_BWVBLyE0qFJxRup13U-y8EZlBjRfmI,11
+git2report-0.1.0.dist-info/RECORD,,

git2report-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

git2report-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+git2report = git2report.cli:app
+git2report-eval = git2report.eval_tools:app
+git2report-ui = git2report.web:main

git2report-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vijay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

git2report-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+git2report