logforge-gitlog 0.1.0__py3-none-any.whl

logforge_gitlog-0.1.0.dist-info/METADATA

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: logforge-gitlog
+Version: 0.1.0
+Summary: AI-Powered Changelog & Release Notes Generator
+Project-URL: Homepage, https://github.com/JToSound/LogForge
+Project-URL: Repository, https://github.com/JToSound/LogForge
+Project-URL: Changelog, https://github.com/JToSound/LogForge/blob/main/CHANGELOG.md
+License: MIT License
+        
+        Copyright (c) 2024 gitlog contributors
+        
+        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.
+License-File: LICENSE
+Keywords: ai,changelog,cli,git,release-notes
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.11
+Requires-Dist: gitpython>=3.1
+Requires-Dist: jinja2>=3.1
+Requires-Dist: litellm>=1.40
+Requires-Dist: pydantic-settings>=2
+Requires-Dist: pydantic>=2
+Requires-Dist: rich>=13
+Requires-Dist: tenacity>=8
+Requires-Dist: tomli>=2; python_version < '3.11'
+Requires-Dist: typer[all]>=0.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: types-jinja2; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# LogForge — gitlog
+
+**LogForge — AI-Powered Changelog & Release Notes Generator**
+
+[![CI](https://github.com/JToSound/LogForge/actions/workflows/ci.yml/badge.svg)](https://github.com/JToSound/LogForge/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/JToSound/LogForge/branch/main/graph/badge.svg)](https://codecov.io/gh/JToSound/LogForge)
+[![GitHub Releases](https://img.shields.io/github/v/release/JToSound/LogForge)](https://github.com/JToSound/LogForge/releases)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+One command. From git history to a human-readable, structured CHANGELOG.  
+Supports **multiple languages**, **multiple output formats**, and **any LLM**.
+
+</div>
+
+---
+
+## Quick Start
+
+```bash
+# Install directly from GitHub (recommended until published to PyPI)
+pip install git+https://github.com/JToSound/LogForge.git
+cd your-repo
+export OPENAI_API_KEY=sk-...
+gitlog generate
+```
+
+That's it. Your `CHANGELOG.md` is ready. 🎉
+
+---
+
+## 5s Demo
+
+Below is a very short demo that shows `gitlog generate` producing a changelog in under 5 seconds on small repos.
+
+![Quick demo](docs/demo.svg)
+
+---
+
+## Features
+
+- 🤖 **Two-layer classification** — rule engine (zero API cost) + LLM batch fallback
+- 🌍 **Multilingual output** — English, Traditional Chinese, Simplified Chinese, Japanese
+- 📄 **Multiple formats** — Markdown (Keep-a-Changelog), JSON, HTML, Twitter drafts
+- 🔗 **GitHub integration** — auto-generates PR/issue/commit links
+- ⚡ **Batch LLM calls** — never call the LLM in a loop; respects token budgets
+- 🔄 **Fallback chain** — LLM failure → rule engine, never interrupts the flow
+- 🧩 **CI/CD ready** — GitHub Actions workflow included out of the box
+- 🏠 **Local inference** — Ollama support for fully private generation
+
+---
+
+## Installation
+
+```bash
+# Recommended: with uv
+uv tool install gitlog
+
+# Or pip
+pip install gitlog
+```
+
+**Requirements:** Python 3.11+, Git
+
+---
+
+## Usage
+
+```bash
+# Generate full CHANGELOG
+gitlog generate
+
+# From a specific version
+gitlog generate --since v1.2.0
+
+# HTML report
+gitlog generate --format html
+
+# Traditional Chinese output
+gitlog generate --lang zh-TW
+
+# Use a local Ollama model (no API key needed)
+gitlog generate --model ollama/llama3
+
+# Preview in terminal without writing a file
+gitlog generate --dry-run
+
+# Compare two versions
+gitlog diff v1.0.0 v1.1.0
+
+# Generate Twitter/X announcement
+gitlog tweet
+
+# ASCII commit statistics
+gitlog stats
+
+# Interactive setup
+gitlog init
+```
+
+---
+
+## Configuration
+
+Create a `.gitlog.toml` in your repo root (or run `gitlog init`):
+
+```toml
+[gitlog]
+llm_provider = "openai"
+model = "gpt-4o-mini"
+language = "en"
+format = "markdown"
+output_file = "CHANGELOG.md"
+project_description = "A developer tool for..."
+exclude_patterns = ["^chore\\(deps\\)", "^Merge branch"]
+group_by_scope = true
+max_commits_per_group = 20
+
+[gitlog.github]
+repo = "owner/repo"
+```
+
+### Full Configuration Reference
+
+| Parameter | Default | Description |
+|---|---|---|
+| `llm_provider` | `openai` | LLM provider: `openai`, `anthropic`, `ollama` |
+| `model` | `gpt-4o-mini` | Model identifier |
+| `language` | `en` | Output language: `en`, `zh-TW`, `zh-CN`, `ja` |
+| `format` | `markdown` | Output format: `markdown`, `json`, `html`, `twitter` |
+| `output_file` | `CHANGELOG.md` | Output file path |
+| `project_description` | `""` | Project context injected into LLM prompts |
+| `exclude_patterns` | see default | Regex list of commit messages to skip |
+| `group_by_scope` | `true` | Group commits by conventional commit scope |
+| `max_commits_per_group` | `20` | Max commits shown per category per version |
+| `github.repo` | `""` | `owner/repo` for generating clickable links |
+
+---
+
+## GitHub Actions Integration
+
+Add to your release workflow:
+
+```yaml
+- name: Generate Changelog
+  uses: JToSound/LogForge/.github/workflows/release.yml@main
+  env:
+    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+```
+
+Or use the included `release.yml` which automatically:
+1. Builds and publishes to PyPI on tag push
+2. Generates the changelog using gitlog itself
+3. Creates a GitHub Release with the generated notes
+
+---
+
+## Supported LLM Providers
+
+| Provider | Model Example | Env Var |
+|---|---|---|
+| OpenAI | `gpt-4o-mini` | `OPENAI_API_KEY` |
+| Anthropic | `claude-3-5-haiku-20241022` | `ANTHROPIC_API_KEY` |
+| Ollama (local) | `ollama/llama3` | *(none required)* |
+| Gemini | `gemini/gemini-1.5-flash` | `GEMINI_API_KEY` |
+
+---
+
+## License
+
+MIT © gitlog contributors

logforge_gitlog-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+logforge_gitlog-0.1.0.dist-info/METADATA,sha256=9i2ze8wK2zGqCqPp8ma9qUBOtca2IuLrMafKJ9GWRTA,7307
+logforge_gitlog-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+logforge_gitlog-0.1.0.dist-info/entry_points.txt,sha256=29AWTz-MCXZg5Pd2XJVfc-bdrGURvTJtc0wwoquwCeo,68
+logforge_gitlog-0.1.0.dist-info/licenses/LICENSE,sha256=2kr1yI3LOKUYA3C11sPRaHyX2HPI0n7k_OOfGvJYCkE,1097
+logforge_gitlog-0.1.0.dist-info/RECORD,,

logforge_gitlog-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

logforge_gitlog-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+gitlog = gitlog.cli:app
+logforge = gitlog.cli:app

logforge_gitlog-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 gitlog contributors
+
+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.