attune-help 0.1.0__tar.gz

attune_help-0.1.0/LICENSE

@@ -0,0 +1,19 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   Copyright 2026 Smart AI Memory
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

attune_help-0.1.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: attune-help
+Version: 0.1.0
+Summary: Lightweight help runtime with progressive depth and audience adaptation.
+Author-email: Patrick Roebuck <admin@smartaimemory.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           Copyright 2026 Smart AI Memory
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://github.com/Smart-AI-Memory/attune-ai
+Project-URL: Repository, https://github.com/Smart-AI-Memory/attune-ai
+Keywords: help,documentation,progressive-depth,templates
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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 :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-frontmatter>=1.0.0
+Provides-Extra: rich
+Requires-Dist: rich>=13.0.0; extra == "rich"
+Dynamic: license-file
+
+# attune-help
+
+Lightweight help runtime with progressive depth and
+audience adaptation. Read project help templates
+generated by [attune-ai](https://pypi.org/project/attune-ai/).
+
+## Install
+
+```bash
+pip install attune-help
+```
+
+## Quick Start
+
+```python
+from attune_help import HelpEngine
+
+engine = HelpEngine(template_dir=".help/templates")
+
+# Progressive depth: concept -> task -> reference
+print(engine.lookup("security-audit"))   # concept
+print(engine.lookup("security-audit"))   # task
+print(engine.lookup("security-audit"))   # reference
+```
+
+## How It Works
+
+Each topic has three depth levels:
+
+| Level | Type | What you get |
+|-------|------|-------------|
+| 0 | Concept | What is it? When to use it? |
+| 1 | Task | Step-by-step how-to |
+| 2 | Reference | Full detail, edge cases |
+
+Repeated lookups on the same topic auto-advance.
+A new topic resets to concept.
+
+## Renderers
+
+```python
+# Plain text (default)
+engine = HelpEngine(renderer="plain")
+
+# Rich terminal output (requires `pip install attune-help[rich]`)
+engine = HelpEngine(renderer="cli")
+
+# Claude Code inline format
+engine = HelpEngine(renderer="claude_code")
+
+# Auto-detect environment
+engine = HelpEngine(renderer="auto")
+```
+
+## Template Directory
+
+Templates are markdown files with YAML frontmatter:
+
+```
+.help/templates/
+  security/
+    concept.md
+    task.md
+    reference.md
+  api/
+    concept.md
+    task.md
+    reference.md
+```
+
+Generate templates with
+[attune-ai](https://pypi.org/project/attune-ai/):
+
+```bash
+pip install attune-ai
+# Then in Claude Code:
+/coach init
+```
+
+Or create them manually — any markdown file with
+`feature`, `depth`, and `source_hash` frontmatter
+fields works.
+
+## API
+
+### `HelpEngine`
+
+```python
+HelpEngine(
+    template_dir=None,    # Override template path
+    storage=None,         # Session storage backend
+    renderer="plain",     # Output renderer
+    user_id="default",    # Session tracking ID
+)
+```
+
+**Methods:**
+
+- `lookup(topic)` — Progressive depth lookup
+- `get(template_id)` — Direct template access
+- `lookup_raw(topic)` — Returns `PopulatedTemplate`
+  dataclass
+- `get_summary(skill)` — One-line skill summary
+- `precursor_warnings(file_path)` — File-aware
+  warnings
+
+### `SessionStorage` Protocol
+
+Implement custom storage backends:
+
+```python
+from attune_help import SessionStorage
+
+class RedisStorage(SessionStorage):
+    def load(self, user_id: str) -> dict: ...
+    def save(self, user_id: str, state: dict) -> None: ...
+```
+
+## License
+
+Apache 2.0

attune_help-0.1.0/README.md

@@ -0,0 +1,121 @@
+# attune-help
+
+Lightweight help runtime with progressive depth and
+audience adaptation. Read project help templates
+generated by [attune-ai](https://pypi.org/project/attune-ai/).
+
+## Install
+
+```bash
+pip install attune-help
+```
+
+## Quick Start
+
+```python
+from attune_help import HelpEngine
+
+engine = HelpEngine(template_dir=".help/templates")
+
+# Progressive depth: concept -> task -> reference
+print(engine.lookup("security-audit"))   # concept
+print(engine.lookup("security-audit"))   # task
+print(engine.lookup("security-audit"))   # reference
+```
+
+## How It Works
+
+Each topic has three depth levels:
+
+| Level | Type | What you get |
+|-------|------|-------------|
+| 0 | Concept | What is it? When to use it? |
+| 1 | Task | Step-by-step how-to |
+| 2 | Reference | Full detail, edge cases |
+
+Repeated lookups on the same topic auto-advance.
+A new topic resets to concept.
+
+## Renderers
+
+```python
+# Plain text (default)
+engine = HelpEngine(renderer="plain")
+
+# Rich terminal output (requires `pip install attune-help[rich]`)
+engine = HelpEngine(renderer="cli")
+
+# Claude Code inline format
+engine = HelpEngine(renderer="claude_code")
+
+# Auto-detect environment
+engine = HelpEngine(renderer="auto")
+```
+
+## Template Directory
+
+Templates are markdown files with YAML frontmatter:
+
+```
+.help/templates/
+  security/
+    concept.md
+    task.md
+    reference.md
+  api/
+    concept.md
+    task.md
+    reference.md
+```
+
+Generate templates with
+[attune-ai](https://pypi.org/project/attune-ai/):
+
+```bash
+pip install attune-ai
+# Then in Claude Code:
+/coach init
+```
+
+Or create them manually — any markdown file with
+`feature`, `depth`, and `source_hash` frontmatter
+fields works.
+
+## API
+
+### `HelpEngine`
+
+```python
+HelpEngine(
+    template_dir=None,    # Override template path
+    storage=None,         # Session storage backend
+    renderer="plain",     # Output renderer
+    user_id="default",    # Session tracking ID
+)
+```
+
+**Methods:**
+
+- `lookup(topic)` — Progressive depth lookup
+- `get(template_id)` — Direct template access
+- `lookup_raw(topic)` — Returns `PopulatedTemplate`
+  dataclass
+- `get_summary(skill)` — One-line skill summary
+- `precursor_warnings(file_path)` — File-aware
+  warnings
+
+### `SessionStorage` Protocol
+
+Implement custom storage backends:
+
+```python
+from attune_help import SessionStorage
+
+class RedisStorage(SessionStorage):
+    def load(self, user_id: str) -> dict: ...
+    def save(self, user_id: str, state: dict) -> None: ...
+```
+
+## License
+
+Apache 2.0

attune_help-0.1.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "attune-help"
+version = "0.1.0"
+description = "Lightweight help runtime with progressive depth and audience adaptation."
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Patrick Roebuck", email = "admin@smartaimemory.com"}
+]
+keywords = ["help", "documentation", "progressive-depth", "templates"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Documentation",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "python-frontmatter>=1.0.0",
+]
+
+[project.optional-dependencies]
+rich = ["rich>=13.0.0"]
+
+[project.urls]
+Homepage = "https://github.com/Smart-AI-Memory/attune-ai"
+Repository = "https://github.com/Smart-AI-Memory/attune-ai"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+attune_help = ["templates/**/*.md", "templates/**/*.json"]

attune_help-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

attune_help-0.1.0/src/attune_help/__init__.py

@@ -0,0 +1,32 @@
+"""attune-help: Lightweight help runtime with progressive depth.
+
+Provides template loading, progressive depth escalation,
+audience adaptation, and feedback scoring — without the
+full attune-ai authoring toolkit.
+"""
+
+from __future__ import annotations
+
+from attune_help.engine import (
+    AudienceProfile,
+    HelpEngine,
+    PopulatedTemplate,
+    TemplateContext,
+)
+from attune_help.storage import LocalFileStorage, SessionStorage
+
+__all__ = [
+    "AudienceProfile",
+    "HelpEngine",
+    "LocalFileStorage",
+    "PopulatedTemplate",
+    "SessionStorage",
+    "TemplateContext",
+]
+
+try:
+    from importlib.metadata import version
+
+    __version__ = version("attune-help")
+except Exception:  # noqa: BLE001
+    __version__ = "dev"