docwright 0.1.0__tar.gz

docwright-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Artem Gotlib
+
+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.

docwright-0.1.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: docwright
+Version: 0.1.0
+Summary: AI-powered documentation agent: auto-generates and maintains README & wiki on every commit
+License: MIT
+License-File: LICENSE
+Keywords: documentation,ai,llm,claude,openai,git,automation
+Author: Artem Gotlib
+Author-email: gotlib.artem.m@gmail.com
+Requires-Python: >=3.11,<4.0
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Utilities
+Requires-Dist: anthropic (>=0.28,<0.29)
+Requires-Dist: click (>=8.1,<9.0)
+Requires-Dist: gitpython (>=3.1,<4.0)
+Requires-Dist: httpx (>=0.27,<0.28)
+Requires-Dist: jinja2 (>=3.1,<4.0)
+Requires-Dist: openai (>=1.30,<2.0)
+Requires-Dist: pydantic (>=2.0,<3.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: rich (>=13.0,<14.0)
+Project-URL: Homepage, https://github.com/GotlibArtem/ai-docgen
+Project-URL: Repository, https://github.com/GotlibArtem/ai-docgen
+Description-Content-Type: text/markdown
+
+# ai-docgen
+
+AI-powered documentation agent that watches your commits and keeps README and wiki pages up to date automatically.
+
+## How It Works
+
+```
+Developer commits / pushes
+        │
+        ▼
+CI runs ai-docgen
+        │
+        ├─ First run?
+        │   └─ Generates all docs from scratch via LLM
+        │
+        └─ Already initialized?
+            ├─ No relevant changes → skips (fast)
+            └─ Relevant changes → updates only affected AUTO sections
+                        │
+                        ▼
+             Direct commit  OR  Pull Request (configurable)
+```
+
+The agent only rewrites `<!-- AUTO:section -->` blocks. Anything you write manually stays untouched.
+
+## Quick Start
+
+Install into any repository:
+
+```bash
+pip install ai-docgen
+ai-docgen install
+```
+
+This asks two questions (AI provider, commit mode) and creates:
+- `.ai-docgen/ai-docgen.yml` — config
+- `Makefile` targets: `make docs`, `make docs-sync`
+- CI workflow (GitHub Actions or GitLab CI)
+
+Then generate docs for the first time:
+
+```bash
+make docs
+```
+
+After that, docs update automatically on every push.
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `ai-docgen install` | Bootstrap a repository (interactive or `--auto`) |
+| `ai-docgen init` | Generate all documents from scratch |
+| `ai-docgen run` | Update changed sections based on latest diff |
+| `ai-docgen sync` | Force re-sync all AUTO sections |
+| `ai-docgen dashboard` | Terminal table of all registered projects |
+| `ai-docgen report` | Generate static HTML status report |
+
+## Configuration
+
+`.ai-docgen/ai-docgen.yml`:
+
+```yaml
+provider:
+  type: claude          # claude | openai | ollama
+  model: claude-opus-4-7
+  api_key_env: ANTHROPIC_API_KEY
+
+output:
+  mode: direct          # direct | pull_request
+
+triggers:
+  paths:
+    - "src/**"
+    - "app/**"
+  ignore:
+    - "tests/**"
+
+documents:
+  - type: readme
+    template: readme/default
+    target: README.md
+  - type: wiki
+    template: wiki/architecture
+    target: docs/wiki/architecture.md
+```
+
+## Supported Providers
+
+| Provider | When to use |
+|----------|-------------|
+| Claude (Anthropic) | Best output quality |
+| OpenAI (GPT-4o) | Alternative if you have OpenAI keys |
+| Ollama | Local model, no external API — for private projects |
+
+## Document Templates
+
+Built-in templates cover the full documentation surface:
+
+| Template | AUTO sections |
+|----------|---------------|
+| `readme/default` | overview, getting_started, architecture, api, development |
+| `wiki/architecture` | overview, components, data_flow, dependencies |
+| `wiki/api-contracts` | endpoints, authentication, error_codes |
+| `wiki/development-guide` | setup, testing, code_style |
+| `wiki/operations` | deployment, monitoring, runbooks, incident_response |
+| `wiki/data-model` | entities, business_rules, relationships |
+| `wiki/db-schema` | tables, indexes, migrations |
+| `wiki/integrations` | external_services, auth_credentials, data_exchange |
+| `wiki/security` | access_model, sensitive_data, requirements |
+| `wiki/troubleshooting` | common_issues, diagnostics, known_limitations |
+| `wiki/adr` | recent_decisions, decision_index |
+
+Custom templates go in `.ai-docgen/templates/` inside your repository.
+
+## AUTO / MANUAL Sections
+
+```markdown
+# README
+
+<!-- AUTO:overview -->
+This section is managed by ai-docgen.
+<!-- /AUTO:overview -->
+
+<!-- MANUAL -->
+## Contributing
+
+Write whatever you want here — ai-docgen never touches MANUAL blocks.
+<!-- /MANUAL -->
+```
+
+## Central Registry
+
+After `ai-docgen init`, the project is registered in a central `registry.yml`. View all projects:
+
+```bash
+ai-docgen dashboard          # terminal table
+ai-docgen report             # HTML page at ai-docgen-report.html
+```
+
+## Development
+
+```bash
+poetry install
+poetry run pytest             # 46 tests
+poetry run ruff check .       # lint
+poetry run mypy ai_docgen    # type check
+```
+
+## License
+
+MIT
+

docwright-0.1.0/README.md

@@ -0,0 +1,152 @@
+# ai-docgen
+
+AI-powered documentation agent that watches your commits and keeps README and wiki pages up to date automatically.
+
+## How It Works
+
+```
+Developer commits / pushes
+        │
+        ▼
+CI runs ai-docgen
+        │
+        ├─ First run?
+        │   └─ Generates all docs from scratch via LLM
+        │
+        └─ Already initialized?
+            ├─ No relevant changes → skips (fast)
+            └─ Relevant changes → updates only affected AUTO sections
+                        │
+                        ▼
+             Direct commit  OR  Pull Request (configurable)
+```
+
+The agent only rewrites `<!-- AUTO:section -->` blocks. Anything you write manually stays untouched.
+
+## Quick Start
+
+Install into any repository:
+
+```bash
+pip install ai-docgen
+ai-docgen install
+```
+
+This asks two questions (AI provider, commit mode) and creates:
+- `.ai-docgen/ai-docgen.yml` — config
+- `Makefile` targets: `make docs`, `make docs-sync`
+- CI workflow (GitHub Actions or GitLab CI)
+
+Then generate docs for the first time:
+
+```bash
+make docs
+```
+
+After that, docs update automatically on every push.
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `ai-docgen install` | Bootstrap a repository (interactive or `--auto`) |
+| `ai-docgen init` | Generate all documents from scratch |
+| `ai-docgen run` | Update changed sections based on latest diff |
+| `ai-docgen sync` | Force re-sync all AUTO sections |
+| `ai-docgen dashboard` | Terminal table of all registered projects |
+| `ai-docgen report` | Generate static HTML status report |
+
+## Configuration
+
+`.ai-docgen/ai-docgen.yml`:
+
+```yaml
+provider:
+  type: claude          # claude | openai | ollama
+  model: claude-opus-4-7
+  api_key_env: ANTHROPIC_API_KEY
+
+output:
+  mode: direct          # direct | pull_request
+
+triggers:
+  paths:
+    - "src/**"
+    - "app/**"
+  ignore:
+    - "tests/**"
+
+documents:
+  - type: readme
+    template: readme/default
+    target: README.md
+  - type: wiki
+    template: wiki/architecture
+    target: docs/wiki/architecture.md
+```
+
+## Supported Providers
+
+| Provider | When to use |
+|----------|-------------|
+| Claude (Anthropic) | Best output quality |
+| OpenAI (GPT-4o) | Alternative if you have OpenAI keys |
+| Ollama | Local model, no external API — for private projects |
+
+## Document Templates
+
+Built-in templates cover the full documentation surface:
+
+| Template | AUTO sections |
+|----------|---------------|
+| `readme/default` | overview, getting_started, architecture, api, development |
+| `wiki/architecture` | overview, components, data_flow, dependencies |
+| `wiki/api-contracts` | endpoints, authentication, error_codes |
+| `wiki/development-guide` | setup, testing, code_style |
+| `wiki/operations` | deployment, monitoring, runbooks, incident_response |
+| `wiki/data-model` | entities, business_rules, relationships |
+| `wiki/db-schema` | tables, indexes, migrations |
+| `wiki/integrations` | external_services, auth_credentials, data_exchange |
+| `wiki/security` | access_model, sensitive_data, requirements |
+| `wiki/troubleshooting` | common_issues, diagnostics, known_limitations |
+| `wiki/adr` | recent_decisions, decision_index |
+
+Custom templates go in `.ai-docgen/templates/` inside your repository.
+
+## AUTO / MANUAL Sections
+
+```markdown
+# README
+
+<!-- AUTO:overview -->
+This section is managed by ai-docgen.
+<!-- /AUTO:overview -->
+
+<!-- MANUAL -->
+## Contributing
+
+Write whatever you want here — ai-docgen never touches MANUAL blocks.
+<!-- /MANUAL -->
+```
+
+## Central Registry
+
+After `ai-docgen init`, the project is registered in a central `registry.yml`. View all projects:
+
+```bash
+ai-docgen dashboard          # terminal table
+ai-docgen report             # HTML page at ai-docgen-report.html
+```
+
+## Development
+
+```bash
+poetry install
+poetry run pytest             # 46 tests
+poetry run ruff check .       # lint
+poetry run mypy ai_docgen    # type check
+```
+
+## License
+
+MIT

docwright-0.1.0/ai_docgen/analyzer.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+import fnmatch
+import re
+from dataclasses import dataclass
+
+
+@dataclass
+class ChangedFile:
+    path: str
+
+
+class DiffAnalyzer:
+    def __init__(
+        self,
+        diff_text: str,
+        trigger_paths: list[str],
+        ignore_paths: list[str],
+    ) -> None:
+        self.diff_text = diff_text
+        self.trigger_paths = trigger_paths
+        self.ignore_paths = ignore_paths
+
+    def changed_files(self) -> list[ChangedFile]:
+        paths: list[str] = []
+        for line in self.diff_text.splitlines():
+            match = re.match(r"^\+\+\+ b/(.+)$", line)
+            if match:
+                paths.append(match.group(1))
+        return [ChangedFile(path=p) for p in paths]
+
+    def has_relevant_changes(self) -> bool:
+        for changed in self.changed_files():
+            if self.is_ignored(changed.path):
+                continue
+            if self.matches_trigger(changed.path):
+                return True
+        return False
+
+    def diff_summary(self) -> str:
+        files = self.changed_files()
+        if not files:
+            return "No changed files."
+        lines = ["Changed files:"]
+        for f in files:
+            lines.append(f"  - {f.path}")
+        lines.append("")
+        lines.append(self.diff_text[:3000])
+        if len(self.diff_text) > 3000:
+            lines.append("... (truncated)")
+        return "\n".join(lines)
+
+    def is_ignored(self, path: str) -> bool:
+        return any(fnmatch.fnmatch(path, pattern) for pattern in self.ignore_paths)
+
+    def matches_trigger(self, path: str) -> bool:
+        if not self.trigger_paths:
+            return True
+        return any(fnmatch.fnmatch(path, pattern) for pattern in self.trigger_paths)

docwright-0.1.0/ai_docgen/built_in_templates/readme/default.md.j2

@@ -0,0 +1,30 @@
+# {{ service_name }}
+
+<!-- AUTO:overview -->
+<!-- /AUTO:overview -->
+
+## Getting Started
+
+<!-- AUTO:getting_started -->
+<!-- /AUTO:getting_started -->
+
+## Architecture
+
+<!-- AUTO:architecture -->
+<!-- /AUTO:architecture -->
+
+## API
+
+<!-- AUTO:api -->
+<!-- /AUTO:api -->
+
+## Development
+
+<!-- AUTO:development -->
+<!-- /AUTO:development -->
+
+<!-- MANUAL -->
+## Contributing
+
+Add contributing notes here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/adr.md.j2

@@ -0,0 +1,27 @@
+# Architecture Decision Records
+
+## Recent Decisions
+
+<!-- AUTO:recent_decisions -->
+<!-- /AUTO:recent_decisions -->
+
+## Decision Index
+
+<!-- AUTO:decision_index -->
+<!-- /AUTO:decision_index -->
+
+<!-- MANUAL -->
+## ADR Template
+
+Use this format for new decisions:
+
+### ADR-NNN: Title
+
+**Status:** Proposed / Accepted / Deprecated / Superseded
+
+**Context:** What prompted this decision.
+
+**Decision:** What was decided.
+
+**Consequences:** What changes as a result.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/api-contracts.md.j2

@@ -0,0 +1,20 @@
+# API Contracts
+
+<!-- AUTO:endpoints -->
+<!-- /AUTO:endpoints -->
+
+## Authentication
+
+<!-- AUTO:authentication -->
+<!-- /AUTO:authentication -->
+
+## Error Codes
+
+<!-- AUTO:error_codes -->
+<!-- /AUTO:error_codes -->
+
+<!-- MANUAL -->
+## Changelog
+
+Document breaking changes here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/architecture.md.j2

@@ -0,0 +1,25 @@
+# Architecture
+
+<!-- AUTO:overview -->
+<!-- /AUTO:overview -->
+
+## Components
+
+<!-- AUTO:components -->
+<!-- /AUTO:components -->
+
+## Data Flow
+
+<!-- AUTO:data_flow -->
+<!-- /AUTO:data_flow -->
+
+## Dependencies
+
+<!-- AUTO:dependencies -->
+<!-- /AUTO:dependencies -->
+
+<!-- MANUAL -->
+## Decision Log
+
+Document architectural decisions here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/data-model.md.j2

@@ -0,0 +1,22 @@
+# Data Model
+
+## Domain Entities
+
+<!-- AUTO:entities -->
+<!-- /AUTO:entities -->
+
+## Business Rules
+
+<!-- AUTO:business_rules -->
+<!-- /AUTO:business_rules -->
+
+## Relationships
+
+<!-- AUTO:relationships -->
+<!-- /AUTO:relationships -->
+
+<!-- MANUAL -->
+## Glossary
+
+Define domain terms here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/db-schema.md.j2

@@ -0,0 +1,22 @@
+# Database Schema
+
+## Tables
+
+<!-- AUTO:tables -->
+<!-- /AUTO:tables -->
+
+## Indexes
+
+<!-- AUTO:indexes -->
+<!-- /AUTO:indexes -->
+
+## Migrations
+
+<!-- AUTO:migrations -->
+<!-- /AUTO:migrations -->
+
+<!-- MANUAL -->
+## Migration Runbook
+
+Document manual migration steps and rollback procedures here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/development-guide.md.j2

@@ -0,0 +1,22 @@
+# Development Guide
+
+## Setup
+
+<!-- AUTO:setup -->
+<!-- /AUTO:setup -->
+
+## Running Tests
+
+<!-- AUTO:testing -->
+<!-- /AUTO:testing -->
+
+## Code Style
+
+<!-- AUTO:code_style -->
+<!-- /AUTO:code_style -->
+
+<!-- MANUAL -->
+## Team Conventions
+
+Add team-specific conventions here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/integrations.md.j2

@@ -0,0 +1,22 @@
+# Integrations
+
+## External Services
+
+<!-- AUTO:external_services -->
+<!-- /AUTO:external_services -->
+
+## Authentication & Credentials
+
+<!-- AUTO:auth_credentials -->
+<!-- /AUTO:auth_credentials -->
+
+## Data Exchange
+
+<!-- AUTO:data_exchange -->
+<!-- /AUTO:data_exchange -->
+
+<!-- MANUAL -->
+## Integration Contacts
+
+Document vendor contacts and SLA details here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/operations.md.j2

@@ -0,0 +1,27 @@
+# Operations
+
+## Deployment
+
+<!-- AUTO:deployment -->
+<!-- /AUTO:deployment -->
+
+## Monitoring
+
+<!-- AUTO:monitoring -->
+<!-- /AUTO:monitoring -->
+
+## Runbooks
+
+<!-- AUTO:runbooks -->
+<!-- /AUTO:runbooks -->
+
+## Incident Response
+
+<!-- AUTO:incident_response -->
+<!-- /AUTO:incident_response -->
+
+<!-- MANUAL -->
+## On-Call Contacts
+
+Document on-call rotation and escalation paths here.
+<!-- /MANUAL -->

docwright-0.1.0/ai_docgen/built_in_templates/wiki/security.md.j2

@@ -0,0 +1,22 @@
+# Security
+
+## Access Model
+
+<!-- AUTO:access_model -->
+<!-- /AUTO:access_model -->
+
+## Sensitive Data Handling
+
+<!-- AUTO:sensitive_data -->
+<!-- /AUTO:sensitive_data -->
+
+## Security Requirements
+
+<!-- AUTO:requirements -->
+<!-- /AUTO:requirements -->
+
+<!-- MANUAL -->
+## Security Contacts
+
+Document responsible disclosure process and security team contacts here.
+<!-- /MANUAL -->