docwright 0.1.0__py3-none-any.whl

ai_docgen/reporters/terminal.py

@@ -0,0 +1,31 @@
+from pathlib import Path
+
+from rich.console import Console
+from rich.table import Table
+
+from ai_docgen.registry import Registry
+
+
+def render_dashboard(registry_path: Path) -> None:
+    console = Console()
+    registry = Registry(registry_path)
+    projects = registry.all_projects()
+
+    if not projects:
+        console.print("[yellow]No projects registered. Run 'ai-docgen init' in a project.[/yellow]")
+        return
+
+    table = Table(title="ai-docgen — Project Status", show_lines=True)
+    table.add_column("Project", style="bold")
+    table.add_column("Status")
+    table.add_column("Last Updated")
+    table.add_column("Documents")
+
+    for project in projects:
+        status_icon = (
+            "[green]✓ synced[/green]" if project.status == "synced" else "[red]✗ stale[/red]"
+        )
+        doc_targets = ", ".join(d.target for d in project.documents)
+        table.add_row(project.name, status_icon, str(project.last_updated), doc_targets)
+
+    console.print(table)

ai_docgen/scaffolder.py

@@ -0,0 +1,163 @@
+from __future__ import annotations
+
+import json
+import re
+from dataclasses import dataclass
+from pathlib import Path
+
+import yaml
+
+GITHUB_ACTIONS_WORKFLOW = """\
+name: Update Documentation
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ai-docgen
+      - run: ai-docgen run
+        env:
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          AI_DOCGEN_BASE_SHA: >-
+            ${{ github.event.pull_request.base.sha || github.event.before }}
+"""
+
+GITLAB_CI_BLOCK = """
+docs:
+  stage: docs
+  image: python:3.12
+  script:
+    - pip install ai-docgen
+    - ai-docgen run
+  variables:
+    AI_DOCGEN_BASE_SHA: $CI_MERGE_REQUEST_DIFF_BASE_SHA
+"""
+
+MAKEFILE_TARGETS = """
+docs:  ## init if not initialized, otherwise update
+\tai-docgen run
+
+docs-sync:  ## force re-sync all docs against current templates
+\tai-docgen sync
+
+docs-check:  ## dry-run: show what would change
+\tai-docgen run --dry-run
+"""
+
+
+@dataclass
+class ProjectProfile:
+    language: str
+    service_name: str
+    ci: str
+    package_manager: str
+
+
+class Scaffolder:
+    def __init__(self, repo_root: Path) -> None:
+        self.repo_root = repo_root
+
+    def detect_profile(self) -> ProjectProfile:
+        language, service_name, package_manager = self.detect_language()
+        ci = self.detect_ci()
+        return ProjectProfile(
+            language=language,
+            service_name=service_name,
+            ci=ci,
+            package_manager=package_manager,
+        )
+
+    def detect_language(self) -> tuple[str, str, str]:
+        pyproject = self.repo_root / "pyproject.toml"
+        if pyproject.exists():
+            content = pyproject.read_text()
+            match = re.search(r'name\s*=\s*"([^"]+)"', content)
+            name = match.group(1) if match else self.repo_root.name
+            return "python", name, "poetry"
+        package_json = self.repo_root / "package.json"
+        if package_json.exists():
+            data = json.loads(package_json.read_text())
+            return "node", str(data.get("name", self.repo_root.name)), "npm"
+        composer = self.repo_root / "composer.json"
+        if composer.exists():
+            data = json.loads(composer.read_text())
+            name = str(data.get("name", self.repo_root.name)).split("/")[-1]
+            return "php", name, "composer"
+        return "unknown", self.repo_root.name, "unknown"
+
+    def detect_ci(self) -> str:
+        if (self.repo_root / ".github" / "workflows").exists():
+            return "github"
+        if (self.repo_root / ".gitlab-ci.yml").exists():
+            return "gitlab"
+        return "none"
+
+    def generate(self, profile: ProjectProfile, provider_type: str, output_mode: str) -> None:
+        self.write_config(provider_type, output_mode)
+        self.append_makefile_targets()
+        self.write_ci_workflow(profile)
+
+    def write_config(self, provider_type: str, output_mode: str) -> None:
+        config_dir = self.repo_root / ".ai-docgen"
+        config_dir.mkdir(parents=True, exist_ok=True)
+        config_file = config_dir / "ai-docgen.yml"
+        if config_file.exists():
+            return
+        api_key_env = {
+            "claude": "ANTHROPIC_API_KEY",
+            "openai": "OPENAI_API_KEY",
+        }.get(provider_type, "")
+        model = {
+            "claude": "claude-sonnet-4-6",
+            "openai": "gpt-4o",
+            "ollama": "llama3",
+        }.get(provider_type, "claude-sonnet-4-6")
+        config = {
+            "provider": {"type": provider_type, "model": model, "api_key_env": api_key_env},
+            "output": {"mode": output_mode},
+            "triggers": {
+                "paths": ["app/**", "src/**", "pyproject.toml", "package.json"],
+                "ignore": ["tests/**", "**/*.md"],
+            },
+            "documents": [
+                {"type": "readme", "template": "readme/default", "target": "README.md"},
+            ],
+            "registry": {"path": "../.ai-docgen/registry.yml"},
+        }
+        config_file.write_text(yaml.dump(config, default_flow_style=False, allow_unicode=True))
+
+    def append_makefile_targets(self) -> None:
+        makefile = self.repo_root / "Makefile"
+        if not makefile.exists():
+            makefile.write_text(MAKEFILE_TARGETS.lstrip())
+            return
+        content = makefile.read_text()
+        if "docs:" not in content:
+            makefile.write_text(content + MAKEFILE_TARGETS)
+
+    def write_ci_workflow(self, profile: ProjectProfile) -> None:
+        if profile.ci == "github":
+            workflow_path = self.repo_root / ".github" / "workflows" / "docs.yml"
+            if not workflow_path.exists():
+                workflow_path.write_text(GITHUB_ACTIONS_WORKFLOW)
+        elif profile.ci == "gitlab":
+            gitlab_ci = self.repo_root / ".gitlab-ci.yml"
+            content = gitlab_ci.read_text() if gitlab_ci.exists() else ""
+            if "ai-docgen run" not in content:
+                gitlab_ci.write_text(content + GITLAB_CI_BLOCK)

docwright-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,41 @@
+ai_docgen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_docgen/analyzer.py,sha256=-uFz-iihTmf1Ck1HspJS-7KtT0EryyVB9ViE0bxS3OY,1729
+ai_docgen/built_in_templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_docgen/built_in_templates/readme/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_docgen/built_in_templates/readme/default.md.j2,sha256=F7LGAfQlfzRJ3-dl9Uhf_ruwW-eH0Wbm5HIDKdli2hA,420
+ai_docgen/built_in_templates/wiki/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_docgen/built_in_templates/wiki/adr.md.j2,sha256=Y8oji0BV4r-rlZFU0V-1ArXBtkru1LaUrkOAoet30bk,482
+ai_docgen/built_in_templates/wiki/api-contracts.md.j2,sha256=_mOik1RcO1dR5KoH39QNIs-mhD2k3JNkWsZelX8z0cE,295
+ai_docgen/built_in_templates/wiki/architecture.md.j2,sha256=Sr6nRGulp7FBY0VCTg0J8-E401QPken8qtxVDsLklzE,357
+ai_docgen/built_in_templates/wiki/data-model.md.j2,sha256=f3y7wEVJFWqhTDkQtgnbPuowo0iZGLmVzK_QU2ESRAU,309
+ai_docgen/built_in_templates/wiki/db-schema.md.j2,sha256=CFJNNIg4GtHJoljUgKq_gaNa7xy6PA_TOp-Snr5W3Wc,316
+ai_docgen/built_in_templates/wiki/development-guide.md.j2,sha256=b_j_sTyRdUB1AuTqzOh16KNGJ8ji0lNV1bsdYgWGZuI,294
+ai_docgen/built_in_templates/wiki/integrations.md.j2,sha256=epfkrKbxyXptsuZW1GjHf5JCMfyKWkUUyf5Zc7hXMaE,382
+ai_docgen/built_in_templates/wiki/operations.md.j2,sha256=M8A466WoQeyFipSuMw5seO3ntmY3ITu1dS-MonPIfY0,404
+ai_docgen/built_in_templates/wiki/security.md.j2,sha256=eb8v1QgQ_vp_EazcWqTZh0eIUDrPTylKLEL2s-EFM98,383
+ai_docgen/built_in_templates/wiki/troubleshooting.md.j2,sha256=vXFFiUKie6MdbSk0Wh_coizyeRe9TA8Sl29F8J3T8Vg,364
+ai_docgen/cli.py,sha256=ZXqHILRloaj_ofYYVTFnoYywYN9N0Tt-D6TvWWvppqc,4839
+ai_docgen/config.py,sha256=8xRhLxIKtqa95yIMVI1f6tunyeHQcnXuXSw6xiMsD0Q,2131
+ai_docgen/engine.py,sha256=fkZStouCKONvSwxA3b5xaE0cn0LeX7YlnSYcuMWye1o,7147
+ai_docgen/outputs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_docgen/outputs/base.py,sha256=pb81eALfRvT-ELYAxFGUa9s-ifvrQLi01y-obsLH85E,176
+ai_docgen/outputs/direct.py,sha256=EcpWwSoLVxe-ERmil1KJe7XV-r3XNuJ81mtcmpt3MpA,460
+ai_docgen/outputs/factory.py,sha256=JtHPXnEdw6F60_fU5qtYlB4jamNdwgJrcBK9caKfn60,436
+ai_docgen/outputs/pull_request.py,sha256=VqNh7mJa3je0ac4xJZ0nN3M1GZeuxGtuVvd_oA-R8GU,2342
+ai_docgen/providers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_docgen/providers/base.py,sha256=CqMem3YRj8_4nKpM3MMM18dPzKqK_Uc8gdKaK2OzlmM,147
+ai_docgen/providers/claude.py,sha256=WQeyNrkJqF9WX6XFpTfUthLbHt4Jfd8C21IK5RU3AV8,754
+ai_docgen/providers/factory.py,sha256=tqUaW09POy9FCYL66VpMaP7tqUxKzQPuHWVQ5AyibeU,990
+ai_docgen/providers/ollama.py,sha256=zRMwzQGrIlTuiGcR6MSm6ciAE0HAFi1WRizgo5ApVBY,883
+ai_docgen/providers/openai.py,sha256=TF98V9jpWRRXpiwm1A3untGgeToBhj4t4fkTLCPJq0U,645
+ai_docgen/registry.py,sha256=ptFx2L07k_m1U7nLK9MHO2P3_H7ML2cUSHr_IMiegTs,4027
+ai_docgen/renderer.py,sha256=pZyNGJCCjDX-0PEabCxNO1Uz2svQFPFP_3ZsHFzEseQ,3616
+ai_docgen/reporters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_docgen/reporters/html.py,sha256=KTAVnz4z0C4_SMKZC9cSFC3WJxeu-Ek6T6ctjDD-oFM,1717
+ai_docgen/reporters/terminal.py,sha256=of5ez0gBhmjgHtIp0llbUxjubz9uTpJKLLSyh6QtE8M,990
+ai_docgen/scaffolder.py,sha256=qj5pI6DiqOds-W7VivkEFwVjYL7cJ2ridpf9ClpCXFA,5364
+docwright-0.1.0.dist-info/METADATA,sha256=ZYFW8RzOp5fzgQAiTXBvPIDEwt3GVLUm4ELGh62ktwY,5341
+docwright-0.1.0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
+docwright-0.1.0.dist-info/entry_points.txt,sha256=SSRvbV_1E2dXGRbLRQUjaEFqtihMJ1HwNI_mMcIlk_M,47
+docwright-0.1.0.dist-info/licenses/LICENSE,sha256=SeGR-IOaMfiOmXLPSpDKFSsvI0uPCiN9uHO4XePSs1k,1069
+docwright-0.1.0.dist-info/RECORD,,

docwright-0.1.0.dist-info/WHEEL

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

docwright-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ai-docgen=ai_docgen.cli:cli
+

docwright-0.1.0.dist-info/licenses/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.