diary-docs 0.1.0__py3-none-any.whl

diary_docs-0.1.0.dist-info/METADATA

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: diary-docs
+Version: 0.1.0
+Summary: Scaffold DIARY documentation structure with MkDocs and Backstage support
+Author-email: bakhija senakmoiky <senakmoiky@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bakhija/diary-docs
+Project-URL: Repository, https://github.com/bakhija/diary-docs
+Keywords: documentation,mkdocs,backstage,techdocs,scaffolder
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13.0
+Requires-Dist: inquirerpy>=0.3.4
+Dynamic: license-file
+
+# diary-docs — DIARY Documentation Scaffolder
+
+A CLI tool that scaffolds a DIARY documentation structure with MkDocs and Backstage support, indexes your codebase for knowledge retrieval, and keeps docs in sync with code changes.
+
+## Installation
+
+```bash
+pip install diary-docs
+```
+
+For development:
+
+```bash
+pip install -e .
+```
+
+## Commands
+
+### `diary-docs init`
+
+Initialize a new DIARY documentation project in the current directory.
+
+```bash
+diary-docs init
+```
+
+The tool prompts for a project name, then creates:
+
+```
+docs/
+├── index.md
+├── objectives.md
+├── structure/
+│   └── index.md
+├── techdocs/
+│   ├── index.md
+│   ├── architecture.md
+│   ├── api-contracts.md
+│   ├── deployment.md
+│   ├── adr.md
+│   └── development-guide.md
+├── product/
+│   ├── index.md
+│   ├── user-guide.md
+│   └── modules.md
+├── ops-governance/
+│   ├── index.md
+│   ├── runbooks.md
+│   └── security.md
+└── knowledge-base/
+    ├── index.md
+    ├── faq.md
+    └── troubleshooting.md
+mkdocs.yml
+catalog-info.yaml
+```
+
+It also generates an AI agent skill file for content generation.
+
+**Options:**
+
+| Flag | Description |
+|------|-------------|
+| `-f`, `--force` | Overwrite existing files |
+| `--help` | Show help for this command |
+
+If files already exist, they are skipped (unless `--force` is used).
+
+---
+
+### `diary-docs index`
+
+Index the workspace codebase for knowledge retrieval. Extracts symbols, files, and relationships into a SQLite database.
+
+```bash
+diary-docs index
+```
+
+**Options:**
+
+| Flag | Description |
+|------|-------------|
+| `-r`, `--report` | Generate a documentation coverage report after indexing |
+| `--db-path PATH` | Custom database path (default: `docs/.index/knowledge.db`) |
+| `--help` | Show help for this command |
+
+The index powers the `diary-docs generate-content` skill, allowing AI agents to query the codebase structure without manually scanning files.
+
+---
+
+### `diary-docs sync`
+
+Synchronize documentation with detected code changes. Compares the current workspace against git history to find outdated AIMB (AI-Managed) blocks in markdown files.
+
+```bash
+# Preview changes without applying
+diary-docs sync --dry-run
+
+# Apply all detected changes
+diary-docs sync --force
+```
+
+**Options:**
+
+| Flag | Description |
+|------|-------------|
+| `-n`, `--dry-run` | Preview changes as JSON without applying |
+| `-b`, `--branch NAME` | Override branch detection |
+| `-f`, `--force` | Skip conflict warnings |
+| `-o`, `--output FILE` | Write JSON report to file |
+| `--help` | Show help for this command |
+
+**Dry-run output** is a JSON SyncReport showing code changes, affected docs, confidence scores, and any conflicts.
+
+---
+
+### Global Options
+
+| Flag | Description |
+|------|-------------|
+| `--version` | Show version |
+| `--help` | Show top-level help |
+
+## AI Agent Skills
+
+`diary-docs init` generates two slash commands for AI coding agents (Claude Code, OpenCode). The skill files are placed in `.claude/commands/` or `.opencode/commands/` (you choose during init).
+
+### `/diary-generate-content`
+
+Analyzes the workspace codebase via the pre-built index and generates enterprise-grade documentation content for every DIARY file.
+
+```bash
+# In Claude Code or OpenCode:
+/diary-generate-content
+```
+
+The skill follows a multi-step workflow:
+1. Reads existing docs structure
+2. Queries the knowledge index (`docs/.index/knowledge.db`)
+3. Asks clarifying questions for missing context
+4. Generates content with Mermaid diagrams, tables, and use cases
+5. Writes all `docs/` files with AIMB (AI-Managed Block) wrappers
+
+Output covers: architecture overview, API contracts, deployment flow, ADR log, user guide, runbooks, security compliance, FAQ, and troubleshooting.
+
+---
+
+### `/diary-sync`
+
+Synchronizes documentation with detected code changes. Compares the current git state against history to find outdated AIMB blocks.
+
+```bash
+# In Claude Code or OpenCode:
+/diary-sync
+```
+
+The skill follows a structured workflow:
+1. Verifies git state and runs `diary-docs sync --dry-run`
+2. Parses the SyncReport JSON for changes and conflicts
+3. Processes each high-confidence change by updating relevant AIMB blocks
+4. Flags conflicts for manual review (never auto-resolves)
+5. Finalizes with `diary-docs sync --force`
+6. Prints a summary of all processed files
+
+**Prerequisites:** All code changes must be committed to git before running `/diary-sync`.
+
+---
+
+## What It Generates
+
+| File/Folder | Description |
+|-------------|-------------|
+| `docs/` | Main documentation folder |
+| `docs/index.md` | Root documentation index |
+| `docs/objectives.md` | Project objectives and goals |
+| `docs/structure/index.md` | Writing guidelines and conventions |
+| `docs/techdocs/` | Technical documentation section |
+| `docs/techdocs/architecture.md` | System architecture overview |
+| `docs/techdocs/api-contracts.md` | API endpoint specifications |
+| `docs/techdocs/deployment.md` | Deployment flow and environments |
+| `docs/techdocs/adr.md` | Architecture Decision Records |
+| `docs/techdocs/development-guide.md` | Local development setup guide |
+| `docs/product/` | Product documentation section |
+| `docs/product/user-guide.md` | End-user guide with use cases |
+| `docs/product/modules.md` | Module/component reference |
+| `docs/ops-governance/` | Operations & governance section |
+| `docs/ops-governance/runbooks.md` | Operational runbooks |
+| `docs/ops-governance/security.md` | Security compliance docs |
+| `docs/knowledge-base/` | Knowledge base section |
+| `docs/knowledge-base/faq.md` | Frequently asked questions |
+| `docs/knowledge-base/troubleshooting.md` | Troubleshooting guide |
+| `mkdocs.yml` | MkDocs configuration with TechDocs Core plugin |
+| `catalog-info.yaml` | Backstage component registration file |
+
+## Development
+
+```bash
+pytest tests/ -v
+```

diary_docs-0.1.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+diary/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+diary/__main__.py,sha256=8CI7J7aAE0ayPQcX_31ew1YkhO30DvT4MAOGjTMa9_k,35
+diary/cli.py,sha256=78fROQJG6Tuo9ZY26uto3O_nvEBsYXEs4utK31km-WI,34649
+diary/git_utils.py,sha256=a3MkTPbwOT-VaC6JXmojX8wOCSJTrLnXOXIbZ0aOp7U,5429
+diary/templates.py,sha256=twsyGJpZeP91lZQAxDrrULyE4CulkMIR85z-N7VRkJI,2875
+diary/aimb/__init__.py,sha256=D9Mt7LfmBHEKPX675qP5eOPyKHUz4e6Tyaw4xJMkH6Y,997
+diary/aimb/hasher.py,sha256=ZwSpbdmPXEr0BzCWLitz5PgWNrN8a9L0wqZ9tiapUNs,4615
+diary/aimb/merge.py,sha256=SEDppV5XYOkFEo4XuTmFN2ywXZhqXnvRQ3OVFHFI-1k,8140
+diary/aimb/parser.py,sha256=jLvQ6fe1keACq40lL4juefbiZ_e516HiWnJcwNC7BFw,6094
+diary/indexer/__init__.py,sha256=Km4TXEU9LAMFXRhUegkfrZv6dGgQWDNgJRgXHIvVAuM,1407
+diary/indexer/database.py,sha256=9uEVGlSbVPFqPkZBMqQ7kPMiPURH_he04L7XsAQT85w,11114
+diary/indexer/extractors.py,sha256=j2YjX2P6k81ye2_tj1PN7tCPYeZltJ18mEqRlGQwjPw,16429
+diary/indexer/gitignore.py,sha256=vaX3zmv4ml2hijVWfllcQ2ydSty43Q6BfkSeibv-MUs,1798
+diary/indexer/indexer.py,sha256=4OK4H2ixWb6qYyhFQsG8P-2HbzBgVoiPtz-MBadgzIg,16349
+diary/indexer/reporter.py,sha256=RqbzuPZwBzTSnjbVuXSdQeKZELRCAeqr74Flg7mF3DI,4367
+diary/indexer/scanner.py,sha256=y6eXf5zv7GnmpIq7G9koA0O61oa1EGfNWPRck8jkF_s,1761
+diary/sync/__init__.py,sha256=Lo8JT7apEp5EkgnzfCXpvGfqU-0R0sjzRQu-XtoJ8EY,682
+diary/sync/detector.py,sha256=AoySXB0tEXCwKrPPbjiCLK2XVO-adg0I14b66xwSf1U,12816
+diary/sync/engine.py,sha256=mQfbu8G69_-sGWkH40hzI4PrhYDep0E7shiB0gB_YGs,13823
+diary/sync/protocol.py,sha256=jyooIttJNt2uDTzco0hNxem_itUy80kL27SmaCtCxS4,6162
+diary_docs-0.1.0.dist-info/licenses/LICENSE,sha256=VfIh7tKcjMr5NC5zjA2A-xRq7K8nfibQJ5Y8oub5jUk,1075
+diary_docs-0.1.0.dist-info/METADATA,sha256=YQGn_hrtLXAKTXPoDpDW5073F9_su3udx0YxDGPOJ2k,7355
+diary_docs-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+diary_docs-0.1.0.dist-info/entry_points.txt,sha256=LC96dsvVc1sig1sEJxTAaDSVROyApP6GMTkFAQjDlrQ,46
+diary_docs-0.1.0.dist-info/top_level.txt,sha256=0Di9045_-hpmWycLwR0KQDSbRP8Q1jYg2dcqsZ6Y7RY,6
+diary_docs-0.1.0.dist-info/RECORD,,

diary_docs-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

diary_docs-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+diary-docs = diary.cli:main

diary_docs-0.1.0.dist-info/licenses/LICENSE

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

diary_docs-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+diary