docdrift 2.0.0__tar.gz

docdrift-2.0.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: docdrift
+Version: 2.0.0
+Summary: Finds stale documentation and fixes it automatically using AI
+Home-page: https://github.com/ayush698800/docwatcher
+Author: ayush698800
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0
+Requires-Dist: gitpython>=3.1
+Requires-Dist: rich>=13.0
+Requires-Dist: tree-sitter>=0.21
+Requires-Dist: tree-sitter-python>=0.21
+Requires-Dist: tree-sitter-javascript>=0.21
+Requires-Dist: chromadb>=0.4
+Requires-Dist: sentence-transformers>=2.2
+Requires-Dist: groq>=0.4
+Requires-Dist: requests>=2.28
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# DocDrift
+
+> Finds stale documentation and fixes it automatically
+
+You change a function. DocDrift finds every doc section that is now
+lying because of that change — and fixes it with one keypress.
+
+No more merging PRs with outdated documentation. No more new developers
+wasting hours following instructions that stopped being true months ago.
+
+---
+
+## The problem
+
+You change a function. You forget to update the docs.
+Now your README is lying. A new developer follows it and wastes 3 hours.
+This happens everywhere, all the time. Nobody has a good solution.
+
+Until now.
+
+---
+
+## Demo
+```
+$ git add .
+$ ./docdrift commit
+
+DocDrift scanning before commit...
+Found 1 errors · 0 warnings · 2 undocumented
+
+ERROR validate_token
+  README.md line 7
+  Function now raises NotImplementedError but docs say it returns True/False
+
+  Fix this? (y/n): y
+  Generating fix...
+
+  Suggested:
+  The validate_token function validates a token and scope.
+  Raises NotImplementedError if validation has been removed.
+  Use AuthService.login() instead.
+
+  Apply? (y/n/e to edit): y
+  Fixed
+
+2 undocumented symbols found
+Auto-document all in README? (y/n): y
+  Generated docs for refresh_token
+  Generated docs for AuthService
+  Added 2 new sections to README
+
+Commit now? (y/n): y
+Commit message: refactor auth flow
+Committed
+```
+
+---
+
+## Install
+```bash
+git clone https://github.com/ayush698800/docwatcher.git
+cd docwatcher
+pip install -r requirements.txt
+bash install-hook.sh
+```
+
+Set your free Groq API key for cloud AI:
+```bash
+export GROQ_API_KEY="your_key_here"
+```
+
+Get a free key at groq.com — takes 2 minutes.
+
+Or use LM Studio or Ollama for fully local, private AI — no API key needed.
+
+---
+
+## Usage
+
+### Smart commit — the main command
+```bash
+git add .
+./docdrift commit
+```
+
+DocDrift will:
+- Scan all changed functions and classes
+- Find documentation that is now stale or wrong
+- Show each finding with exact file and line number
+- Ask if you want to fix it — AI generates the updated doc
+- Auto-document any new undocumented functions
+- Commit everything when you approve
+
+### Check only — no commit
+```bash
+./docdrift check
+```
+
+### Rebuild doc index
+```bash
+./docdrift index
+```
+
+---
+
+## GitHub Actions — automatic PR checks
+
+Add `.github/workflows/docdrift.yml` to any repo:
+```yaml
+name: DocDrift
+on:
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+jobs:
+  check-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: DocDrift
+        uses: ayush698800/docwatcher@v2.0.0
+        with:
+          groq_api_key: ${{ secrets.GROQ_API_KEY }}
+```
+
+Add `GROQ_API_KEY` to your repo secrets once.
+Now every PR gets automatically checked for stale docs and posts findings as a comment.
+
+---
+
+## Pre-commit hook
+
+DocDrift installs as a git hook that runs automatically before every commit:
+```bash
+bash install-hook.sh
+```
+
+Now every time you commit a Python or JS file, DocDrift checks automatically.
+Blocks commits with ERROR-level stale docs.
+Allows commits with warnings so you are never fully blocked.
+
+Skip when needed:
+```bash
+git commit --no-verify -m "your message"
+```
+
+---
+
+## How it works
+```
+git diff → changed functions and classes detected via Tree-sitter
+       ↓
+semantic search → finds related documentation sections
+       ↓  
+LLM check → is this doc still accurate after the code change?
+       ↓
+if stale → generates fix → asks permission → applies to file
+       ↓
+if undocumented → generates new docs → appends to README
+```
+
+---
+
+## What it finds
+
+- Functions that changed signature but docs describe the old one
+- Functions that now raise exceptions but docs say they return values
+- New parameters that are not mentioned anywhere in docs
+- Completely undocumented new functions and classes
+- Removed functionality still described as available
+
+---
+
+## Works with
+
+- Python and JavaScript codebases
+- Markdown and RST documentation
+- README files, /docs folders, inline comments
+- GitHub Actions for automatic team-wide PR checks
+- LM Studio and Ollama — fully local and private
+- Groq — free cloud AI, instant responses
+
+---
+
+## Built with
+
+- Tree-sitter — code parsing across languages
+- sentence-transformers — semantic documentation search
+- ChromaDB — local vector index
+- Groq / LM Studio / Ollama — LLM verdicts and fixes
+
+---
+
+## License
+
+MIT

docdrift-2.0.0/README.md

@@ -0,0 +1,200 @@
+# DocDrift
+
+> Finds stale documentation and fixes it automatically
+
+You change a function. DocDrift finds every doc section that is now
+lying because of that change — and fixes it with one keypress.
+
+No more merging PRs with outdated documentation. No more new developers
+wasting hours following instructions that stopped being true months ago.
+
+---
+
+## The problem
+
+You change a function. You forget to update the docs.
+Now your README is lying. A new developer follows it and wastes 3 hours.
+This happens everywhere, all the time. Nobody has a good solution.
+
+Until now.
+
+---
+
+## Demo
+```
+$ git add .
+$ ./docdrift commit
+
+DocDrift scanning before commit...
+Found 1 errors · 0 warnings · 2 undocumented
+
+ERROR validate_token
+  README.md line 7
+  Function now raises NotImplementedError but docs say it returns True/False
+
+  Fix this? (y/n): y
+  Generating fix...
+
+  Suggested:
+  The validate_token function validates a token and scope.
+  Raises NotImplementedError if validation has been removed.
+  Use AuthService.login() instead.
+
+  Apply? (y/n/e to edit): y
+  Fixed
+
+2 undocumented symbols found
+Auto-document all in README? (y/n): y
+  Generated docs for refresh_token
+  Generated docs for AuthService
+  Added 2 new sections to README
+
+Commit now? (y/n): y
+Commit message: refactor auth flow
+Committed
+```
+
+---
+
+## Install
+```bash
+git clone https://github.com/ayush698800/docwatcher.git
+cd docwatcher
+pip install -r requirements.txt
+bash install-hook.sh
+```
+
+Set your free Groq API key for cloud AI:
+```bash
+export GROQ_API_KEY="your_key_here"
+```
+
+Get a free key at groq.com — takes 2 minutes.
+
+Or use LM Studio or Ollama for fully local, private AI — no API key needed.
+
+---
+
+## Usage
+
+### Smart commit — the main command
+```bash
+git add .
+./docdrift commit
+```
+
+DocDrift will:
+- Scan all changed functions and classes
+- Find documentation that is now stale or wrong
+- Show each finding with exact file and line number
+- Ask if you want to fix it — AI generates the updated doc
+- Auto-document any new undocumented functions
+- Commit everything when you approve
+
+### Check only — no commit
+```bash
+./docdrift check
+```
+
+### Rebuild doc index
+```bash
+./docdrift index
+```
+
+---
+
+## GitHub Actions — automatic PR checks
+
+Add `.github/workflows/docdrift.yml` to any repo:
+```yaml
+name: DocDrift
+on:
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+jobs:
+  check-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: DocDrift
+        uses: ayush698800/docwatcher@v2.0.0
+        with:
+          groq_api_key: ${{ secrets.GROQ_API_KEY }}
+```
+
+Add `GROQ_API_KEY` to your repo secrets once.
+Now every PR gets automatically checked for stale docs and posts findings as a comment.
+
+---
+
+## Pre-commit hook
+
+DocDrift installs as a git hook that runs automatically before every commit:
+```bash
+bash install-hook.sh
+```
+
+Now every time you commit a Python or JS file, DocDrift checks automatically.
+Blocks commits with ERROR-level stale docs.
+Allows commits with warnings so you are never fully blocked.
+
+Skip when needed:
+```bash
+git commit --no-verify -m "your message"
+```
+
+---
+
+## How it works
+```
+git diff → changed functions and classes detected via Tree-sitter
+       ↓
+semantic search → finds related documentation sections
+       ↓  
+LLM check → is this doc still accurate after the code change?
+       ↓
+if stale → generates fix → asks permission → applies to file
+       ↓
+if undocumented → generates new docs → appends to README
+```
+
+---
+
+## What it finds
+
+- Functions that changed signature but docs describe the old one
+- Functions that now raise exceptions but docs say they return values
+- New parameters that are not mentioned anywhere in docs
+- Completely undocumented new functions and classes
+- Removed functionality still described as available
+
+---
+
+## Works with
+
+- Python and JavaScript codebases
+- Markdown and RST documentation
+- README files, /docs folders, inline comments
+- GitHub Actions for automatic team-wide PR checks
+- LM Studio and Ollama — fully local and private
+- Groq — free cloud AI, instant responses
+
+---
+
+## Built with
+
+- Tree-sitter — code parsing across languages
+- sentence-transformers — semantic documentation search
+- ChromaDB — local vector index
+- Groq / LM Studio / Ollama — LLM verdicts and fixes
+
+---
+
+## License
+
+MIT

docdrift-2.0.0/docdrift.egg-info/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: docdrift
+Version: 2.0.0
+Summary: Finds stale documentation and fixes it automatically using AI
+Home-page: https://github.com/ayush698800/docwatcher
+Author: ayush698800
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0
+Requires-Dist: gitpython>=3.1
+Requires-Dist: rich>=13.0
+Requires-Dist: tree-sitter>=0.21
+Requires-Dist: tree-sitter-python>=0.21
+Requires-Dist: tree-sitter-javascript>=0.21
+Requires-Dist: chromadb>=0.4
+Requires-Dist: sentence-transformers>=2.2
+Requires-Dist: groq>=0.4
+Requires-Dist: requests>=2.28
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# DocDrift
+
+> Finds stale documentation and fixes it automatically
+
+You change a function. DocDrift finds every doc section that is now
+lying because of that change — and fixes it with one keypress.
+
+No more merging PRs with outdated documentation. No more new developers
+wasting hours following instructions that stopped being true months ago.
+
+---
+
+## The problem
+
+You change a function. You forget to update the docs.
+Now your README is lying. A new developer follows it and wastes 3 hours.
+This happens everywhere, all the time. Nobody has a good solution.
+
+Until now.
+
+---
+
+## Demo
+```
+$ git add .
+$ ./docdrift commit
+
+DocDrift scanning before commit...
+Found 1 errors · 0 warnings · 2 undocumented
+
+ERROR validate_token
+  README.md line 7
+  Function now raises NotImplementedError but docs say it returns True/False
+
+  Fix this? (y/n): y
+  Generating fix...
+
+  Suggested:
+  The validate_token function validates a token and scope.
+  Raises NotImplementedError if validation has been removed.
+  Use AuthService.login() instead.
+
+  Apply? (y/n/e to edit): y
+  Fixed
+
+2 undocumented symbols found
+Auto-document all in README? (y/n): y
+  Generated docs for refresh_token
+  Generated docs for AuthService
+  Added 2 new sections to README
+
+Commit now? (y/n): y
+Commit message: refactor auth flow
+Committed
+```
+
+---
+
+## Install
+```bash
+git clone https://github.com/ayush698800/docwatcher.git
+cd docwatcher
+pip install -r requirements.txt
+bash install-hook.sh
+```
+
+Set your free Groq API key for cloud AI:
+```bash
+export GROQ_API_KEY="your_key_here"
+```
+
+Get a free key at groq.com — takes 2 minutes.
+
+Or use LM Studio or Ollama for fully local, private AI — no API key needed.
+
+---
+
+## Usage
+
+### Smart commit — the main command
+```bash
+git add .
+./docdrift commit
+```
+
+DocDrift will:
+- Scan all changed functions and classes
+- Find documentation that is now stale or wrong
+- Show each finding with exact file and line number
+- Ask if you want to fix it — AI generates the updated doc
+- Auto-document any new undocumented functions
+- Commit everything when you approve
+
+### Check only — no commit
+```bash
+./docdrift check
+```
+
+### Rebuild doc index
+```bash
+./docdrift index
+```
+
+---
+
+## GitHub Actions — automatic PR checks
+
+Add `.github/workflows/docdrift.yml` to any repo:
+```yaml
+name: DocDrift
+on:
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+jobs:
+  check-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: DocDrift
+        uses: ayush698800/docwatcher@v2.0.0
+        with:
+          groq_api_key: ${{ secrets.GROQ_API_KEY }}
+```
+
+Add `GROQ_API_KEY` to your repo secrets once.
+Now every PR gets automatically checked for stale docs and posts findings as a comment.
+
+---
+
+## Pre-commit hook
+
+DocDrift installs as a git hook that runs automatically before every commit:
+```bash
+bash install-hook.sh
+```
+
+Now every time you commit a Python or JS file, DocDrift checks automatically.
+Blocks commits with ERROR-level stale docs.
+Allows commits with warnings so you are never fully blocked.
+
+Skip when needed:
+```bash
+git commit --no-verify -m "your message"
+```
+
+---
+
+## How it works
+```
+git diff → changed functions and classes detected via Tree-sitter
+       ↓
+semantic search → finds related documentation sections
+       ↓  
+LLM check → is this doc still accurate after the code change?
+       ↓
+if stale → generates fix → asks permission → applies to file
+       ↓
+if undocumented → generates new docs → appends to README
+```
+
+---
+
+## What it finds
+
+- Functions that changed signature but docs describe the old one
+- Functions that now raise exceptions but docs say they return values
+- New parameters that are not mentioned anywhere in docs
+- Completely undocumented new functions and classes
+- Removed functionality still described as available
+
+---
+
+## Works with
+
+- Python and JavaScript codebases
+- Markdown and RST documentation
+- README files, /docs folders, inline comments
+- GitHub Actions for automatic team-wide PR checks
+- LM Studio and Ollama — fully local and private
+- Groq — free cloud AI, instant responses
+
+---
+
+## Built with
+
+- Tree-sitter — code parsing across languages
+- sentence-transformers — semantic documentation search
+- ChromaDB — local vector index
+- Groq / LM Studio / Ollama — LLM verdicts and fixes
+
+---
+
+## License
+
+MIT

docdrift-2.0.0/docdrift.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+README.md
+pyproject.toml
+setup.py
+docdrift.egg-info/PKG-INFO
+docdrift.egg-info/SOURCES.txt
+docdrift.egg-info/dependency_links.txt
+docdrift.egg-info/entry_points.txt
+docdrift.egg-info/requires.txt
+docdrift.egg-info/top_level.txt
+docwatcher/__init__.py
+docwatcher/cli.py
+docwatcher/config.py
+docwatcher/diff_parser.py
+docwatcher/doc_scanner.py
+docwatcher/embeddings.py
+docwatcher/fixer.py
+docwatcher/llm_checker.py
+docwatcher/sample.py
+docwatcher/symbol_extractor.py
+docwatcher/utils.py
+tests/__init__.py

docdrift-2.0.0/docdrift.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

docdrift-2.0.0/docdrift.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+docdrift = docwatcher.cli:cli

docdrift-2.0.0/docdrift.egg-info/requires.txt

@@ -0,0 +1,10 @@
+click>=8.0
+gitpython>=3.1
+rich>=13.0
+tree-sitter>=0.21
+tree-sitter-python>=0.21
+tree-sitter-javascript>=0.21
+chromadb>=0.4
+sentence-transformers>=2.2
+groq>=0.4
+requests>=2.28

docdrift-2.0.0/docdrift.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+docwatcher
+tests