docwright 0.1.2__tar.gz → 0.1.4__tar.gz

{docwright-0.1.2 → docwright-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docwright
-Version: 0.1.2
+Version: 0.1.4
 Summary: AI-powered documentation agent: auto-generates and maintains README & wiki on every commit
 License: MIT
 License-File: LICENSE

docwright-0.1.4/docwright/built_in_templates/wiki/home.md.j2

@@ -0,0 +1,20 @@
+# {{ project_name }} Wiki
+
+<!-- AUTO:overview -->
+<!-- /AUTO:overview -->
+
+## Contents
+
+<!-- AUTO:contents -->
+<!-- /AUTO:contents -->
+
+## Quick Links
+
+<!-- AUTO:quick_links -->
+<!-- /AUTO:quick_links -->
+
+<!-- MANUAL -->
+## Getting Help
+
+Add team contacts and support channels here.
+<!-- /MANUAL -->

{docwright-0.1.2 → docwright-0.1.4}/docwright/config.py

@@ -51,6 +51,7 @@ class Config(BaseModel):
     triggers: TriggersConfig | None = None
     documents: list[DocumentConfig] = Field(default_factory=list)
     registry: RegistryConfig = Field(default_factory=RegistryConfig)
+    language: str = "en"
 
     @classmethod
     def load(cls, repo_root: Path) -> Config:

docwright-0.1.4/docwright/engine.py

@@ -0,0 +1,290 @@
+from __future__ import annotations
+
+import subprocess
+import time
+from pathlib import Path
+
+from rich.console import Console
+from rich.progress import Progress, SpinnerColumn, TextColumn
+
+from docwright.analyzer import DiffAnalyzer
+from docwright.config import Config
+from docwright.outputs.base import Output
+from docwright.providers.base import LLMProvider
+from docwright.registry import DocumentEntry, ProjectEntry, Registry
+from docwright.renderer import DocumentRenderer, TemplateLoader
+
+SYSTEM_PROMPT_TEMPLATE = (
+    "You are a technical documentation writer. You update specific sections of documentation "
+    "based on code changes. Return ONLY the updated section content — no markdown fences, "
+    "no explanations, no surrounding text. Write in clear, concise English. "
+    "Be accurate and specific to the actual code. "
+    "{language_instruction}"
+)
+
+_console = Console(stderr=False)
+
+
+def build_system_prompt(language: str) -> str:
+    if language == "en":
+        language_instruction = "Generate all documentation in English language."
+    elif language == "ru":
+        language_instruction = "Generate all documentation in Russian language."
+    else:
+        language_instruction = f"Generate all documentation in {language} language."
+    return SYSTEM_PROMPT_TEMPLATE.format(language_instruction=language_instruction)
+
+
+class DocsEngine:
+    def __init__(self, repo_root: Path, provider: LLMProvider, output: Output) -> None:
+        self.repo_root = repo_root
+        self.provider = provider
+        self.output = output
+        self.config = Config.load(repo_root)
+        self.renderer = DocumentRenderer()
+        self.loader = TemplateLoader(
+            source=self.config.templates.source,
+            local_path=(
+                repo_root / self.config.templates.local_path
+                if self.config.templates.source == "local"
+                else None
+            ),
+        )
+        self.system_prompt = build_system_prompt(self.config.language)
+
+    async def init(self) -> None:
+        total_start = time.monotonic()
+        changed_files: list[Path] = []
+        sections_count = 0
+
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[blue]{task.description}"),
+            console=_console,
+            transient=True,
+        ) as progress:
+            ctx_task = progress.add_task("Reading repository context...")
+            repo_context = self.gather_repo_context()
+            progress.remove_task(ctx_task)
+
+        _console.print("[green]✓[/green] Repository context ready")
+
+        for doc_config in self.config.documents:
+            target = self.repo_root / doc_config.target
+            template_text = self.loader.load(doc_config.template)
+            document = target.read_text() if target.exists() else template_text
+            section_names = self.renderer.auto_section_names(template_text)
+
+            for section_name in section_names:
+                with Progress(
+                    SpinnerColumn(),
+                    TextColumn("[blue]{task.description}"),
+                    console=_console,
+                    transient=True,
+                ) as progress:
+                    task = progress.add_task(f"Generating {doc_config.target} → {section_name}...")
+                    section_start = time.monotonic()
+                    user_prompt = (
+                        f"Repository context:\n{repo_context}\n\n"
+                        f"Document type: {doc_config.type}\n"
+                        f"Update the '{section_name}' section with accurate, detailed information."
+                    )
+                    updated_content = await self.provider.complete(
+                        system=self.system_prompt, user=user_prompt
+                    )
+                    elapsed = time.monotonic() - section_start
+                    document = self.renderer.patch_section(
+                        document, section_name, updated_content + "\n"
+                    )
+                    progress.remove_task(task)
+
+                _console.print(
+                    f"[green]✓[/green] {doc_config.target} → {section_name} ({elapsed:.1f}s)"
+                )
+                sections_count += 1
+
+            target.parent.mkdir(parents=True, exist_ok=True)
+            target.write_text(document)
+            changed_files.append(target)
+
+        if changed_files:
+            self.output.apply(changed_files, "docs: generate initial documentation")
+
+        Config.mark_initialized(self.repo_root)
+        self.register_in_registry()
+
+        total_elapsed = time.monotonic() - total_start
+        _console.print(
+            f"[green]✓[/green] Initialized {sections_count} documents in {total_elapsed:.1f}s"
+        )
+
+    async def run(self, diff_text: str) -> bool:
+        if not Config.is_initialized(self.repo_root):
+            await self.init()
+            return False
+
+        total_start = time.monotonic()
+        triggers = self.config.triggers
+        analyzer = DiffAnalyzer(
+            diff_text=diff_text,
+            trigger_paths=triggers.paths if triggers else [],
+            ignore_paths=triggers.ignore if triggers else [],
+        )
+
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[blue]{task.description}"),
+            console=_console,
+            transient=True,
+        ) as progress:
+            task = progress.add_task("Analyzing diff...")
+            has_changes = analyzer.has_relevant_changes()
+            progress.remove_task(task)
+
+        if not has_changes:
+            _console.print("[green]✓[/green] No relevant changes, skipping")
+            return True
+
+        changed_file_paths = analyzer.changed_files() if hasattr(analyzer, "changed_files") else []
+        _console.print(
+            f"[green]✓[/green] Found relevant changes in {len(changed_file_paths)} files"
+        )
+
+        changed_files: list[Path] = []
+        diff_summary = analyzer.diff_summary()
+        sections_count = 0
+
+        for doc_config in self.config.documents:
+            target = self.repo_root / doc_config.target
+            if not target.exists():
+                continue
+            document = target.read_text()
+            section_names = self.renderer.auto_section_names(document)
+            updated = False
+
+            for section_name in section_names:
+                with Progress(
+                    SpinnerColumn(),
+                    TextColumn("[blue]{task.description}"),
+                    console=_console,
+                    transient=True,
+                ) as progress:
+                    task = progress.add_task(f"Generating {doc_config.target} → {section_name}...")
+                    section_start = time.monotonic()
+                    user_prompt = (
+                        f"Diff summary:\n{diff_summary}\n\n"
+                        f"Current document:\n{document}\n\n"
+                        f"Update the '{section_name}' section if the diff affects it. "
+                        f"If no update is needed, return the current section content unchanged."
+                    )
+                    updated_content = await self.provider.complete(
+                        system=self.system_prompt, user=user_prompt
+                    )
+                    elapsed = time.monotonic() - section_start
+                    new_document = self.renderer.patch_section(
+                        document, section_name, updated_content + "\n"
+                    )
+                    progress.remove_task(task)
+
+                _console.print(
+                    f"[green]✓[/green] {doc_config.target} → {section_name} ({elapsed:.1f}s)"
+                )
+                sections_count += 1
+
+                if new_document != document:
+                    document = new_document
+                    updated = True
+
+            if updated:
+                target.write_text(document)
+                changed_files.append(target)
+
+        if changed_files:
+            self.output.apply(changed_files, "docs: update documentation")
+
+        total_elapsed = time.monotonic() - total_start
+        _console.print(
+            f"[green]✓[/green] Updated {sections_count} sections in {total_elapsed:.1f}s"
+        )
+        return False
+
+    async def sync(self) -> None:
+        total_start = time.monotonic()
+        sections_count = 0
+
+        for doc_config in self.config.documents:
+            target = self.repo_root / doc_config.target
+            template_text = self.loader.load(doc_config.template)
+            document = target.read_text() if target.exists() else template_text
+            section_names = self.renderer.auto_section_names(template_text)
+            repo_context = self.gather_repo_context()
+
+            for section_name in section_names:
+                with Progress(
+                    SpinnerColumn(),
+                    TextColumn("[blue]{task.description}"),
+                    console=_console,
+                    transient=True,
+                ) as progress:
+                    task = progress.add_task(f"Syncing {doc_config.target} → {section_name}...")
+                    section_start = time.monotonic()
+                    user_prompt = (
+                        f"Repository context:\n{repo_context}\n\n"
+                        f"Current document:\n{document}\n\n"
+                        f"Re-sync the '{section_name}' section to be accurate and up to date."
+                    )
+                    updated_content = await self.provider.complete(
+                        system=self.system_prompt, user=user_prompt
+                    )
+                    elapsed = time.monotonic() - section_start
+                    document = self.renderer.patch_section(
+                        document, section_name, updated_content + "\n"
+                    )
+                    progress.remove_task(task)
+
+                _console.print(
+                    f"[green]✓[/green] {doc_config.target} → {section_name} ({elapsed:.1f}s)"
+                )
+                sections_count += 1
+
+            target.parent.mkdir(parents=True, exist_ok=True)
+            target.write_text(document)
+
+        total_elapsed = time.monotonic() - total_start
+        _console.print(f"[green]✓[/green] Synced {sections_count} sections in {total_elapsed:.1f}s")
+
+    def gather_repo_context(self) -> str:
+        lines: list[str] = [f"Repo root: {self.repo_root.name}"]
+        for candidate in ["pyproject.toml", "package.json", "composer.json", "go.mod"]:
+            path = self.repo_root / candidate
+            if path.exists():
+                lines.append(f"\n{candidate}:\n{path.read_text()[:2000]}")
+                break
+        src_dirs = ["app", "src", "lib"]
+        for src_dir in src_dirs:
+            full = self.repo_root / src_dir
+            if full.exists():
+                files = [str(p.relative_to(self.repo_root)) for p in full.rglob("*.py")][:20]
+                lines.append(f"\nSource files in {src_dir}/: {', '.join(files)}")
+                break
+        return "\n".join(lines)
+
+    def register_in_registry(self) -> None:
+        registry_path = self.repo_root / self.config.registry.path
+        registry = Registry(registry_path)
+        try:
+            remote = (
+                subprocess.check_output(["git", "remote", "get-url", "origin"], cwd=self.repo_root)
+                .decode()
+                .strip()
+            )
+        except subprocess.CalledProcessError:
+            remote = ""
+        registry.register(
+            ProjectEntry(
+                name=self.repo_root.name,
+                path=str(self.repo_root),
+                remote=remote,
+                documents=[DocumentEntry(target=d.target) for d in self.config.documents],
+            )
+        )

{docwright-0.1.2 → docwright-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docwright"
-version = "0.1.2"
+version = "0.1.4"
 description = "AI-powered documentation agent: auto-generates and maintains README & wiki on every commit"
 authors = ["Artem Gotlib <gotlib.artem.m@gmail.com>"]
 license = "MIT"

docwright-0.1.2/docwright/engine.py

@@ -1,165 +0,0 @@
-from __future__ import annotations
-
-import subprocess
-from pathlib import Path
-
-from docwright.analyzer import DiffAnalyzer
-from docwright.config import Config
-from docwright.outputs.base import Output
-from docwright.providers.base import LLMProvider
-from docwright.registry import DocumentEntry, ProjectEntry, Registry
-from docwright.renderer import DocumentRenderer, TemplateLoader
-
-SYSTEM_PROMPT = (
-    "You are a technical documentation writer. You update specific sections of documentation "
-    "based on code changes. Return ONLY the updated section content — no markdown fences, "
-    "no explanations, no surrounding text. Write in clear, concise English. "
-    "Be accurate and specific to the actual code."
-)
-
-
-class DocsEngine:
-    def __init__(self, repo_root: Path, provider: LLMProvider, output: Output) -> None:
-        self.repo_root = repo_root
-        self.provider = provider
-        self.output = output
-        self.config = Config.load(repo_root)
-        self.renderer = DocumentRenderer()
-        self.loader = TemplateLoader(
-            source=self.config.templates.source,
-            local_path=(
-                repo_root / self.config.templates.local_path
-                if self.config.templates.source == "local"
-                else None
-            ),
-        )
-
-    async def init(self) -> None:
-        changed_files: list[Path] = []
-        for doc_config in self.config.documents:
-            target = self.repo_root / doc_config.target
-            template_text = self.loader.load(doc_config.template)
-            document = target.read_text() if target.exists() else template_text
-            section_names = self.renderer.auto_section_names(template_text)
-            repo_context = self.gather_repo_context()
-            for section_name in section_names:
-                user_prompt = (
-                    f"Repository context:\n{repo_context}\n\n"
-                    f"Document type: {doc_config.type}\n"
-                    f"Update the '{section_name}' section with accurate, detailed information."
-                )
-                updated_content = await self.provider.complete(
-                    system=SYSTEM_PROMPT, user=user_prompt
-                )
-                document = self.renderer.patch_section(
-                    document, section_name, updated_content + "\n"
-                )
-            target.parent.mkdir(parents=True, exist_ok=True)
-            target.write_text(document)
-            changed_files.append(target)
-        if changed_files:
-            self.output.apply(changed_files, "docs: generate initial documentation")
-        Config.mark_initialized(self.repo_root)
-        self.register_in_registry()
-
-    async def run(self, diff_text: str) -> bool:
-        if not Config.is_initialized(self.repo_root):
-            await self.init()
-            return False
-        triggers = self.config.triggers
-        analyzer = DiffAnalyzer(
-            diff_text=diff_text,
-            trigger_paths=triggers.paths if triggers else [],
-            ignore_paths=triggers.ignore if triggers else [],
-        )
-        if not analyzer.has_relevant_changes():
-            return True
-        changed_files: list[Path] = []
-        diff_summary = analyzer.diff_summary()
-        for doc_config in self.config.documents:
-            target = self.repo_root / doc_config.target
-            if not target.exists():
-                continue
-            document = target.read_text()
-            section_names = self.renderer.auto_section_names(document)
-            updated = False
-            for section_name in section_names:
-                user_prompt = (
-                    f"Diff summary:\n{diff_summary}\n\n"
-                    f"Current document:\n{document}\n\n"
-                    f"Update the '{section_name}' section if the diff affects it. "
-                    f"If no update is needed, return the current section content unchanged."
-                )
-                updated_content = await self.provider.complete(
-                    system=SYSTEM_PROMPT, user=user_prompt
-                )
-                new_document = self.renderer.patch_section(
-                    document, section_name, updated_content + "\n"
-                )
-                if new_document != document:
-                    document = new_document
-                    updated = True
-            if updated:
-                target.write_text(document)
-                changed_files.append(target)
-        if changed_files:
-            self.output.apply(changed_files, "docs: update documentation")
-        return False
-
-    async def sync(self) -> None:
-        for doc_config in self.config.documents:
-            target = self.repo_root / doc_config.target
-            template_text = self.loader.load(doc_config.template)
-            document = target.read_text() if target.exists() else template_text
-            section_names = self.renderer.auto_section_names(template_text)
-            repo_context = self.gather_repo_context()
-            for section_name in section_names:
-                user_prompt = (
-                    f"Repository context:\n{repo_context}\n\n"
-                    f"Current document:\n{document}\n\n"
-                    f"Re-sync the '{section_name}' section to be accurate and up to date."
-                )
-                updated_content = await self.provider.complete(
-                    system=SYSTEM_PROMPT, user=user_prompt
-                )
-                document = self.renderer.patch_section(
-                    document, section_name, updated_content + "\n"
-                )
-            target.parent.mkdir(parents=True, exist_ok=True)
-            target.write_text(document)
-
-    def gather_repo_context(self) -> str:
-        lines: list[str] = [f"Repo root: {self.repo_root.name}"]
-        for candidate in ["pyproject.toml", "package.json", "composer.json", "go.mod"]:
-            path = self.repo_root / candidate
-            if path.exists():
-                lines.append(f"\n{candidate}:\n{path.read_text()[:2000]}")
-                break
-        src_dirs = ["app", "src", "lib"]
-        for src_dir in src_dirs:
-            full = self.repo_root / src_dir
-            if full.exists():
-                files = [str(p.relative_to(self.repo_root)) for p in full.rglob("*.py")][:20]
-                lines.append(f"\nSource files in {src_dir}/: {', '.join(files)}")
-                break
-        return "\n".join(lines)
-
-    def register_in_registry(self) -> None:
-        registry_path = self.repo_root / self.config.registry.path
-        registry = Registry(registry_path)
-        try:
-            remote = (
-                subprocess.check_output(["git", "remote", "get-url", "origin"], cwd=self.repo_root)
-                .decode()
-                .strip()
-            )
-        except subprocess.CalledProcessError:
-            remote = ""
-        registry.register(
-            ProjectEntry(
-                name=self.repo_root.name,
-                path=str(self.repo_root),
-                remote=remote,
-                documents=[DocumentEntry(target=d.target) for d in self.config.documents],
-            )
-        )