faultline 0.1.0__tar.gz

faultline-0.1.0/.gitignore

@@ -0,0 +1,54 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+wheels/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Testing
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+.tox/
+
+# Type checking
+.mypy_cache/
+.pyright/
+
+# featuremap output
+.featuremap/
+.faultline
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store
+
+# Secrets
+.env
+.env.local
+.env.*
+*.key
+
+# Hatch
+.hatch/
+
+# Dev dashboard (personal use only)
+dashboard/
+
+

faultline-0.1.0/LICENSE

@@ -0,0 +1,183 @@
+                                 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 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, as defined by Sections 1 through 9 of this
+      document, any work of authorship, including the original version of
+      the Work and any modifications or additions to that Work or Derivative
+      Works of the Work, intentionally submitted to the 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 Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and 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 the combined contribution 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 any Contribution embodied 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contributions, and to permit persons to whom the Contributions are
+      furnished to do so.
+
+   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 reproducing 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 exemplary 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 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 offer only
+      conditions consistent with the terms of this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 pashaSchool
+
+   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.

faultline-0.1.0/PKG-INFO

@@ -0,0 +1,329 @@
+Metadata-Version: 2.4
+Name: faultline
+Version: 0.1.0
+Summary: Map features in any codebase from git history. No Jira required.
+Project-URL: Homepage, https://github.com/pkuzina/faultline
+Project-URL: Repository, https://github.com/pkuzina/faultline
+Project-URL: Issues, https://github.com/pkuzina/faultline/issues
+Author: FeatureMap Team
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bug-fix-ratio,code-analysis,engineering-metrics,features,git,health-score,technical-debt
+Classifier: Development Status :: 4 - Beta
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: anthropic>=0.25.0
+Requires-Dist: gitpython>=3.1.40
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: ollama
+Requires-Dist: ollama>=0.4.0; extra == 'ollama'
+Description-Content-Type: text/markdown
+
+# faultline
+
+> Turn your git history into a feature risk map — no Jira required.
+
+**faultline** analyzes your git commit history to automatically detect features and modules in your codebase, then shows which ones are accumulating the most bug fixes — your technical debt hotspots.
+
+No integrations. No configuration. Just point it at any git repo.
+
+---
+
+## Why faultline?
+
+Engineering managers need to know *where* the technical debt is before they can act on it. Most tools require you to tag tickets in Jira or Linear. faultline reads the truth directly from your git history.
+
+```
+✗ payments    — health: 23   38 bug fixes / 112 commits (33.9%)
+!  auth        — health: 54   12 bug fixes / 48 commits  (25.0%)
+✓  dashboard   — health: 91    2 bug fixes / 67 commits   (3.0%)
+```
+
+---
+
+## Installation
+
+### From source
+
+```bash
+git clone https://github.com/pkuzina/faultline
+cd faultline
+pip install -e .
+```
+
+### With Ollama support
+
+```bash
+pip install -e '.[ollama]'
+```
+
+---
+
+## Quick Start
+
+```bash
+# Analyze the current directory
+faultline analyze .
+
+# Analyze a specific repo
+faultline analyze ./path/to/repo
+
+# Focus on a source subdirectory (recommended for frontend/monorepo projects)
+faultline analyze . --src src/
+
+# Last 90 days, show top 5 risk zones
+faultline analyze . --days 90 --top 5
+
+# Just print, don't save
+faultline analyze . --no-save
+
+# AI-powered semantic feature detection
+faultline analyze . --llm --src src/
+
+# AI feature detection with flow breakdown
+faultline analyze . --llm --flows --src src/
+```
+
+---
+
+## AI-Powered Feature Detection
+
+By default faultline groups files by directory structure (fast, no API needed). With `--llm` enabled, Claude or a local Ollama model reads the full file tree and returns a **semantic feature map** — grouping files by business domain, not folder names.
+
+```
+Without --llm:  "components", "views", "hooks"        ← technical layers
+With --llm:     "user-auth", "payments", "dashboard"  ← business features
+```
+
+### Anthropic Claude (cloud)
+
+```bash
+# Pass your API key directly
+faultline analyze . --llm --api-key sk-ant-...
+
+# Or use an environment variable
+export ANTHROPIC_API_KEY=sk-ant-...
+faultline analyze . --llm
+
+# Recommended for large projects — focus on source files only
+faultline analyze . --llm --src src/
+```
+
+Get your API key at [console.anthropic.com](https://console.anthropic.com) → API Keys.
+Uses **Claude Haiku** for cost-efficient analysis (~$0.001 per repo).
+
+### Ollama (local, free, private)
+
+Run analysis entirely on your machine — no API key, no data leaves your computer.
+Recommended for private repositories.
+
+```bash
+# 1. Install Ollama
+brew install ollama        # macOS
+# or: curl -fsSL https://ollama.com/install.sh | sh
+
+# 2. Pull the recommended model (one time, ~4.7 GB)
+ollama pull llama3.1:8b
+
+# 3. Start the server
+ollama serve
+
+# 4. Install the ollama package
+pip install -e '.[ollama]'
+
+# 5. Run
+faultline analyze . --llm --provider ollama --src src/
+```
+
+### Recommended models
+
+| Model | Size | Semantic quality | Notes |
+|-------|------|-----------------|-------|
+| `llama3.1:8b` | 4.7 GB | ★★★★★ | **Default — best balance of quality and size** |
+| `mistral-nemo:12b` | 7.1 GB | ★★★★★ | Best overall quality, higher RAM requirement |
+| `qwen2.5:7b` | 4.7 GB | ★★★★ | Good alternative |
+| `llama3.2:3b` | 2.0 GB | ★★★ | Use when RAM is limited |
+
+```bash
+# Best quality (requires ~8 GB RAM)
+ollama pull mistral-nemo:12b
+faultline analyze . --llm --provider ollama --model mistral-nemo:12b
+
+# Lightweight option
+ollama pull llama3.2:3b
+faultline analyze . --llm --provider ollama --model llama3.2:3b
+```
+
+The API key is validated **before** the analysis starts — no waiting to discover a bad key.
+Falls back silently to heuristic mode if the LLM is unavailable.
+
+---
+
+## Flow Detection
+
+With `--flows`, faultline goes one level deeper — breaking each feature into **user-facing flows**: named end-to-end sequences of actions (e.g. `checkout-flow`, `refund-flow`).
+
+Requires `--llm`. Works with both Anthropic and Ollama.
+
+```bash
+faultline analyze . --llm --flows --src src/
+faultline analyze . --llm --provider ollama --flows --src src/
+```
+
+Output shows two tables: features overview, then features with nested flows:
+
+```
+                         Features by Risk
+╭──────────────┬────────┬─────────┬───────────┬────────╮
+│ Feature      │ Health │ Commits │ Bug Fixes │  Bug % │
+├──────────────┼────────┼─────────┼───────────┼────────┤
+│ payments     │   23   │     112 │        38 │ 33.9%  │
+│ auth         │   54   │      48 │        12 │ 25.0%  │
+╰──────────────┴────────┴─────────┴───────────┴────────╯
+
+                    Feature & Flow Map by Risk
+╭──────┬────────────────────────┬────────┬─────────┬───────────╮
+│      │ Feature / Flow         │ Health │ Commits │ Bug Fixes │
+├──────┼────────────────────────┼────────┼─────────┼───────────┤
+│  ✗   │ payments               │   23   │     112 │        38 │
+│      │   ├─ checkout-flow     │   18   │      67 │        28 │
+│      │   └─ refund-flow       │   41   │      45 │        10 │
+│  !   │ auth                   │   54   │      48 │        12 │
+│      │   └─ login-flow        │   54   │      48 │        12 │
+╰──────┴────────────────────────┴────────┴─────────┴───────────╯
+```
+
+---
+
+## Focusing on a Subdirectory
+
+Use `--src` to restrict analysis to a specific folder. Everything outside that path is ignored.
+
+```bash
+# Sources in src/
+faultline analyze . --src src/
+
+# Sources in app/
+faultline analyze . --src app/
+
+# Monorepo — analyze one package
+faultline analyze . --src packages/api/src/
+```
+
+Automatically excluded regardless of location:
+- Dependencies: `node_modules/`, `vendor/`, `.venv/`
+- Build output: `dist/`, `build/`, `.next/`, `coverage/`
+- Tooling: `.github/`, `.husky/`, `.storybook/`, `.circleci/`
+- Binary and generated files: `.map`, `.lock`, `.woff`, `.ttf`
+
+---
+
+## Output
+
+### Terminal
+
+```
+╭──────────────────────────────────────────────╮
+│             FeatureMap Analysis               │
+│                                               │
+│ Repository:           /path/to/repo           │
+│ Analyzed:             last 365 days           │
+│ Total commits:        847                     │
+│ Features found:       12                      │
+│ Bug fix commits:      143                     │
+│ Average health score: 61.3/100                │
+╰──────────────────────────────────────────────╯
+```
+
+### JSON
+
+Results are saved to `.faultline/feature-map.json` by default:
+
+```json
+{
+  "repo_path": "/path/to/repo",
+  "analyzed_at": "2026-02-22T10:00:00Z",
+  "total_commits": 847,
+  "date_range_days": 365,
+  "features": [
+    {
+      "name": "payments",
+      "description": "Handles Stripe payment processing and subscription billing.",
+      "health_score": 23.0,
+      "bug_fix_ratio": 0.339,
+      "bug_fixes": 38,
+      "total_commits": 112,
+      "authors": ["alice", "bob"],
+      "paths": ["src/payments/stripe.py", "src/payments/webhooks.py"],
+      "flows": [
+        {
+          "name": "checkout-flow",
+          "health_score": 18.0,
+          "bug_fixes": 28,
+          "total_commits": 67
+        }
+      ]
+    }
+  ]
+}
+```
+
+---
+
+## CLI Reference
+
+### `faultline analyze [REPO_PATH]`
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--src` | — | Subdirectory to focus on, e.g. `src/` or `app/` |
+| `--days` | `365` | Days of git history to analyze |
+| `--max-commits` | `5000` | Maximum commits to read |
+| `--top` | `3` | Number of top risk zones to highlight |
+| `--output` | `.faultline/feature-map.json` | Output file path |
+| `--no-save` | — | Skip saving JSON output |
+| `--llm` | `false` | Use AI for semantic feature detection |
+| `--flows` | `false` | Detect user-facing flows within features (requires `--llm`) |
+| `--provider` | `anthropic` | LLM provider: `anthropic` or `ollama` |
+| `--model` | — | Model override (default: `claude-haiku-4-5` / `qwen2.5-coder:7b`) |
+| `--api-key` | env | Anthropic API key (`ANTHROPIC_API_KEY` env var) |
+| `--ollama-url` | `http://localhost:11434` | Custom Ollama server URL |
+
+---
+
+## How It Works
+
+1. **Reads git history** — up to `--max-commits` commits within the requested date range
+2. **Collects tracked files** — respects `--src` filter, skips build output and tooling
+3. **Maps files to features** — two modes:
+   - **Heuristic** (default): groups by directory structure (`src/payments/` → `payments`)
+   - **LLM** (`--llm`): sends the file tree to Claude or Ollama, gets back a semantic `{feature: [files]}` mapping by business domain
+4. **Scans commit history** — for each feature, counts total commits and bug fix commits
+5. **Calculates health scores** — `100 - (bug_fix_ratio × 200)`, weighted by commit activity
+6. **Detects flows** (`--flows`): analyzes files within each feature and maps them to named user-facing journeys
+
+---
+
+## Health Score
+
+| Score | Status | Meaning |
+|-------|--------|---------|
+| 75–100 | ✓ Green | Healthy — low bug fix ratio |
+| 50–74 | ! Yellow | Watch — moderate technical debt |
+| 0–49 | ✗ Red | Critical — high bug fix ratio |
+
+---
+
+## License
+
+[Apache 2.0](LICENSE)