plating 0.0.0.dev0__tar.gz → 0.0.1000.post0__tar.gz

{plating-0.0.0.dev0/src/plating.egg-info → plating-0.0.1000.post0}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: plating
-Version: 0.0.0.dev0
+Version: 0.0.1000.post0
 Summary: Documentation generation system for Terraform/OpenTofu providers
 Author-email: Tim Perkins <code@tim.life>
 Maintainer-email: "provide.io" <code@provide.io>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
@@ -17,18 +16,12 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jinja2>=3.1.6
-Requires-Dist: rich>=13.0.0
-Requires-Dist: pyvider>=0.0.0.post0
-Requires-Dist: pyvider-hcl>=0.0.113
-Requires-Dist: pyvider-cty>=0.0.111
-Requires-Dist: provide-foundation>=0.0.0.dev3
-Provides-Extra: dev
-Requires-Dist: pytest>=8.0.0; extra == "dev"
-Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
-Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
-Requires-Dist: mypy>=1.10.0; extra == "dev"
-Requires-Dist: ruff>=0.2.0; extra == "dev"
+Requires-Dist: jinja2<4.0.0,>=3.1.6
+Requires-Dist: rich<14.0.0,>=13.0.0
+Requires-Dist: pyvider-cty>=0.0.1000
+Requires-Dist: provide-foundation[all]>=0.0.1000
+Requires-Dist: pymarkdownlnt>=0.9.32
+Requires-Dist: mkdocs-material>=9.6.20
 Dynamic: license-file
 
 # 🍽️ Plating
@@ -40,7 +33,7 @@ Plating is a powerful documentation system that brings culinary elegance to tech
 ## ✨ Features
 
 - **🎯 Automatic Documentation Generation** - Generate comprehensive docs from your provider code
-- **👗 Smart Component Dressing** - Automatically create documentation templates for undocumented components
+- **✨ Smart Component Adorning** - Automatically create documentation templates for undocumented components
 - **🍽️ Beautiful Plating** - Render documentation with examples, schemas, and rich formatting
 - **🔍 Component Discovery** - Automatically find and document resources, data sources, and functions
 - **📝 Jinja2 Templates** - Flexible templating with custom functions and filters
@@ -74,8 +67,8 @@ uv self update
 
 ```bash
 # Clone the repository
-git clone https://github.com/provide-io/plating.git
-cd plating
+git clone https://github.com/provide-io/garnish.git
+cd garnish
 
 # Create virtual environment
 uv venv
@@ -106,11 +99,11 @@ uv add git+https://github.com/provide-io/plating.git
 First, create `.plating` bundles for your undocumented components:
 
 ```bash
-# Dress all missing components
-plating dress
+# Adorn all missing components
+plating adorn
 
-# Dress only resources
-plating dress --component-type resource
+# Adorn only resources
+plating adorn --component-type resource
 ```
 
 ### 2. Customize Templates
@@ -197,7 +190,7 @@ Plating follows a modular architecture:
 
 - **PlatingBundle** - Represents documentation bundles
 - **PlatingPlater** - Renders documentation
-- **PlatingDresser** - Creates documentation templates
+- **PlatingAdorner** - Creates documentation templates
 - **PlatingDiscovery** - Finds components and bundles
 - **SchemaProcessor** - Extracts provider schemas
 

{plating-0.0.0.dev0 → plating-0.0.1000.post0}/README.md

@@ -7,7 +7,7 @@ Plating is a powerful documentation system that brings culinary elegance to tech
 ## ✨ Features
 
 - **🎯 Automatic Documentation Generation** - Generate comprehensive docs from your provider code
-- **👗 Smart Component Dressing** - Automatically create documentation templates for undocumented components
+- **✨ Smart Component Adorning** - Automatically create documentation templates for undocumented components
 - **🍽️ Beautiful Plating** - Render documentation with examples, schemas, and rich formatting
 - **🔍 Component Discovery** - Automatically find and document resources, data sources, and functions
 - **📝 Jinja2 Templates** - Flexible templating with custom functions and filters
@@ -41,8 +41,8 @@ uv self update
 
 ```bash
 # Clone the repository
-git clone https://github.com/provide-io/plating.git
-cd plating
+git clone https://github.com/provide-io/garnish.git
+cd garnish
 
 # Create virtual environment
 uv venv
@@ -73,11 +73,11 @@ uv add git+https://github.com/provide-io/plating.git
 First, create `.plating` bundles for your undocumented components:
 
 ```bash
-# Dress all missing components
-plating dress
+# Adorn all missing components
+plating adorn
 
-# Dress only resources
-plating dress --component-type resource
+# Adorn only resources
+plating adorn --component-type resource
 ```
 
 ### 2. Customize Templates
@@ -164,7 +164,7 @@ Plating follows a modular architecture:
 
 - **PlatingBundle** - Represents documentation bundles
 - **PlatingPlater** - Renders documentation
-- **PlatingDresser** - Creates documentation templates
+- **PlatingAdorner** - Creates documentation templates
 - **PlatingDiscovery** - Finds components and bundles
 - **SchemaProcessor** - Extracts provider schemas
 

plating-0.0.1000.post0/VERSION

@@ -0,0 +1 @@
+0.0.1000-0

{plating-0.0.0.dev0 → plating-0.0.1000.post0}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 description = "Documentation generation system for Terraform/OpenTofu providers"
 requires-python = ">=3.11"
 readme = "README.md"
-license = { text = "Apache-2.0" }
+license = "Apache-2.0"
 authors = [
     { name = "Tim Perkins", email = "code@tim.life" },
 ]
@@ -14,7 +14,6 @@ maintainers = [
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: Apache Software License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.11",
@@ -23,21 +22,20 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "jinja2>=3.1.6",
-    "rich>=13.0.0",
-    "pyvider>=0.0.0.post0",
-    "pyvider-hcl>=0.0.113",
-    "pyvider-cty>=0.0.111",
-    "provide-foundation>=0.0.0.dev3",
+    "jinja2>=3.1.6,<4.0.0",
+    "rich>=13.0.0,<14.0.0",
+    "pyvider-cty>=0.0.1000",
+    "provide-foundation[all]>=0.0.1000",
+    "pymarkdownlnt>=0.9.32",
+    "mkdocs-material>=9.6.20",
 ]
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
-    "pytest>=8.0.0",
-    "pytest-asyncio>=0.21.0",
-    "pytest-cov>=6.0.0",
-    "mypy>=1.10.0",
-    "ruff>=0.2.0",
+    "provide-testkit[standard,build]>=0.0.1000",
+]
+docs = [
+    "provide-testkit[docs]>=0.0.1000",
 ]
 
 [project.scripts]
@@ -46,6 +44,7 @@ plating = "plating.cli:main"
 [tool.uv]
 package = true
 
+
 [tool.setuptools.packages.find]
 where = ["src"]
 include = ["plating*"]
@@ -61,15 +60,19 @@ asyncio_mode = "auto"
 pythonpath = ["src", "."]
 testpaths = ["tests"]
 python_files = ["test_*.py", "*_test.py"]
+filterwarnings = [
+    "ignore::RuntimeWarning:threading",
+    "ignore:coroutine.*was never awaited:RuntimeWarning",
+]
 
 [tool.ruff]
-line-length = 88
+line-length = 111
 indent-width = 4
 target-version = "py311"
 
 [tool.ruff.lint]
-select = ["E", "F", "W", "I", "UP"]
-ignore = ["E501"]
+select = ["E", "F", "W", "I", "UP", "ANN", "B", "C90", "SIM", "PTH", "RUF"]
+ignore = ["ANN401", "B008", "E501"]
 
 [tool.ruff.lint.isort]
 known-first-party = ["plating"]
@@ -93,23 +96,19 @@ warn_unused_ignores = true
 warn_unused_configs = true
 disallow_untyped_decorators = false
 
+# Exclude .plating directories from mypy checking
+exclude = [".*\\.plating/.*"]
+
 [[tool.mypy.overrides]]
-module = ["pyvider.*", "jinja2.*", "rich.*", "click.*", "attrs.*"]
+module = ["pyvider.*", "jinja2.*", "rich.*", "click.*", "attrs.*", "provide.*"]
 ignore_missing_imports = true
 
 [tool.coverage.run]
 source = ["plating"]
 branch = true
-parallel = true
 
 [tool.coverage.report]
 show_missing = true
 skip_covered = true
 exclude_lines = ["pragma: no cover", "raise NotImplementedError", "if __name__ == .__main__.:", "if TYPE_CHECKING:", "def __repr__", "def __str__", "pass"]
 
-[dependency-groups]
-dev = [
-    "pytest-asyncio>=1.1.0",
-    "pytest-xdist>=3.8.0",
-    "ruff>=0.12.9",
-]

plating-0.0.1000.post0/src/plating/__init__.py

@@ -0,0 +1,152 @@
+#
+# plating/__init__.py
+#
+"""Modern async documentation generation with full foundation integration.
+
+A clean, type-safe API for generating high-quality documentation with
+multi-domain support via foundation patterns.
+
+Key Features:
+- Type-safe async-first API
+- Full foundation integration (retry, metrics, circuit breakers)
+- Registry-based component discovery with multi-domain support
+- Integrated markdown validation with configurable rules
+- Context-aware template rendering with Jinja2
+- Extensible beyond Terraform to any domain (Kubernetes, CloudFormation, API docs, etc.)
+
+Example Usage:
+    ```python
+    import asyncio
+    from pathlib import Path
+    from plating import Plating, ComponentType, PlatingContext
+
+    async def main():
+        # Initialize with foundation context
+        context = PlatingContext(
+            provider_name="my_provider",
+            log_level="INFO",
+            no_color=False
+        )
+
+        api = Plating(context)
+
+        # Create missing templates
+        adorn_result = await api.adorn(component_types=[ComponentType.RESOURCE])
+        print(f"Created {adorn_result.templates_generated} templates")
+
+        # Generate docs with validation
+        plate_result = await api.plate(
+            Path("docs"),
+            component_types=[ComponentType.RESOURCE],
+            validate_markdown=True,
+            force=True
+        )
+
+        if plate_result.success:
+            print(f"Generated {len(plate_result.output_files)} files")
+
+        # Validate existing documentation
+        validation_result = await api.validate()
+        print(f"Validation: {validation_result.passed}/{validation_result.total} passed")
+
+    # Run the async main
+    asyncio.run(main())
+    ```
+
+CLI Usage:
+    ```bash
+    # Create missing templates
+    plating adorn --component-type resource --provider-name my_provider
+
+    # Generate documentation
+    plating plate --output-dir docs --validate
+
+    # Validate existing docs
+    plating validate --output-dir docs
+
+    # Show registry info
+    plating info --provider-name my_provider
+    ```
+"""
+
+from plating._version import __version__
+
+# Old PlatingAPI removed - use Plating class directly
+
+# Template engine
+from plating.async_template_engine import AsyncTemplateEngine, template_engine
+
+# New modular components
+from plating.bundles import FunctionPlatingBundle, PlatingBundle as ModularPlatingBundle
+
+# Foundation decorators and utilities
+from plating.decorators import (
+    plating_metrics,
+    with_circuit_breaker,
+    with_metrics,
+    with_retry,
+    with_timing,
+)
+from plating.discovery import PlatingDiscovery as ModularPlatingDiscovery, TemplateMetadataExtractor
+from plating.generation import DocumentationAdorner, DocumentationPlater, TemplateRenderer
+
+# from plating.markdown_validator import MarkdownValidator, get_markdown_validator, reset_markdown_validator
+# Core async API
+from plating.plating import Plating, plating
+
+# Registry and validation
+from plating.registry import PlatingRegistry, get_plating_registry, reset_plating_registry
+
+# Type-safe data structures
+from plating.types import (
+    AdornResult,
+    ArgumentInfo,
+    ComponentType,
+    PlateResult,
+    PlatingContext,
+    SchemaInfo,
+    ValidationResult,
+)
+
+__all__ = [
+    "AdornResult",
+    "ArgumentInfo",
+    # Template engine
+    "AsyncTemplateEngine",
+    # Type-safe structures
+    "ComponentType",
+    "DocumentationAdorner",
+    "DocumentationPlater",
+    # New modular components
+    "FunctionPlatingBundle",
+    "MarkdownValidator",
+    "ModularPlatingBundle",
+    "ModularPlatingDiscovery",
+    "PlateResult",
+    # Core API
+    "Plating",
+    "PlatingContext",
+    # Registry and validation
+    "PlatingRegistry",
+    "SchemaInfo",
+    "TemplateMetadataExtractor",
+    "TemplateRenderer",
+    "ValidationResult",
+    # Version
+    "__version__",
+    "get_markdown_validator",
+    "get_plating_registry",
+    "plating",
+    "plating_metrics",
+    "reset_markdown_validator",
+    "reset_plating_registry",
+    "template_engine",
+    "with_circuit_breaker",
+    "with_metrics",
+    # Foundation decorators
+    "with_retry",
+    "with_timing",
+]
+
+
+# 🚀✨🎯🍽️

plating-0.0.1000.post0/src/plating/_version.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from provide.foundation.utils.versioning import get_version
+
+"""Version handling for plating.
+
+This module uses the shared versioning utility from provide-foundation.
+"""
+
+__version__ = get_version("plating", caller_file=__file__)
+
+__all__ = ["__version__"]

{plating-0.0.0.dev0 → plating-0.0.1000.post0}/src/plating/adorner/__init__.py

@@ -3,11 +3,13 @@
 #
 """Adorning system for adding .plating directories to components."""
 
-from plating.adorner.api import adorn_components, adorn_missing_components
 from plating.adorner.adorner import PlatingAdorner
+from plating.adorner.api import adorn_components, adorn_missing_components
+from plating.adorner.templates import TemplateGenerator
 
 __all__ = [
     "PlatingAdorner",
+    "TemplateGenerator",
     "adorn_components",
     "adorn_missing_components",
 ]

{plating-0.0.0.dev0 → plating-0.0.1000.post0}/src/plating/adorner/adorner.py

@@ -4,23 +4,32 @@
 """Core adorner implementation."""
 
 import asyncio
+from typing import Any
 
-from pyvider.hub import ComponentDiscovery, hub
-from provide.foundation import logger, pout, perr
+from provide.foundation import logger, perr, pout
+from provide.foundation.hub import Hub
 
 from plating.adorner.finder import ComponentFinder
 from plating.adorner.templates import TemplateGenerator
+from plating.discovery import PlatingDiscovery
 from plating.errors import AdorningError, handle_error
-from plating.plating import PlatingDiscovery
 
 
 class PlatingAdorner:
     """Adorns components with .plating directories."""
 
-    def __init__(self):
-        self.plating_discovery = PlatingDiscovery()
+    def __init__(self, package_name: str):
+        """Initialize adorner with package name.
+
+        Args:
+            package_name: Python package to search for components
+        """
+        self.package_name = package_name
+        self.plating_discovery = PlatingDiscovery(package_name)
         self.template_generator = TemplateGenerator()
         self.component_finder = ComponentFinder()
+        # Initialize foundation hub for component discovery
+        self.hub = Hub()
 
     async def adorn_missing(self, component_types: list[str] = None) -> dict[str, int]:
         """
@@ -28,15 +37,15 @@ class PlatingAdorner:
 
         Returns a dictionary with counts of adorned components by type.
         """
-        # Discover all components via hub
-        discovery = ComponentDiscovery(hub)
-        await discovery.discover_all()
-        components = hub.list_components()
+        # Discover all components via foundation hub
+        try:
+            self.hub.discover_components(self.package_name)
+        except Exception as e:
+            logger.error(f"Component discovery failed: {e}")
+            return {"resource": 0, "data_source": 0, "function": 0}
 
         # Find existing plating bundles
-        existing_bundles = await asyncio.to_thread(
-            self.plating_discovery.discover_bundles
-        )
+        existing_bundles = await asyncio.to_thread(self.plating_discovery.discover_bundles)
         existing_names = {bundle.name for bundle in existing_bundles}
 
         # Track adorning results
@@ -47,20 +56,29 @@ class PlatingAdorner:
 
         # Adorn missing components
         for component_type in target_types:
-            if component_type in components:
-                for name, component_class in components[component_type].items():
-                    if name not in existing_names:
-                        success = await self._adorn_component(
-                            name, component_type, component_class
-                        )
-                        if success:
-                            adorned[component_type] += 1
+            components = self._get_components_by_dimension(component_type)
+            for name, component_class in components.items():
+                if name not in existing_names:
+                    success = await self._adorn_component(name, component_type, component_class)
+                    if success:
+                        adorned[component_type] += 1
 
         return adorned
 
-    async def _adorn_component(
-        self, name: str, component_type: str, component_class
-    ) -> bool:
+    def _get_components_by_dimension(self, dimension: str) -> dict[str, Any]:
+        """Get components from foundation hub by dimension."""
+        components = {}
+        try:
+            names = self.hub.list_components(dimension=dimension)
+            for name in names:
+                component = self.hub.get_component(name, dimension=dimension)
+                if component:
+                    components[name] = component
+        except Exception as e:
+            logger.warning(f"Failed to get {dimension} components: {e}")
+        return components
+
+    async def _adorn_component(self, name: str, component_type: str, component_class) -> bool:
         """Adorn a single component with a .plating directory."""
         try:
             # Find the component's source file location
@@ -81,9 +99,7 @@ class PlatingAdorner:
                 await asyncio.to_thread(docs_dir.mkdir, parents=True, exist_ok=True)
                 await asyncio.to_thread(examples_dir.mkdir, parents=True, exist_ok=True)
             except OSError as e:
-                raise AdorningError(
-                    name, component_type, f"Failed to create directories: {e}"
-                )
+                raise AdorningError(name, component_type, f"Failed to create directories: {e}")
 
             # Generate and write template
             template_content = await self.template_generator.generate_template(
@@ -93,9 +109,7 @@ class PlatingAdorner:
             await asyncio.to_thread(template_file.write_text, template_content)
 
             # Generate and write example
-            example_content = await self.template_generator.generate_example(
-                name, component_type
-            )
+            example_content = await self.template_generator.generate_example(name, component_type)
             example_file = examples_dir / "example.tf"
             await asyncio.to_thread(example_file.write_text, example_content)
 

{plating-0.0.0.dev0 → plating-0.0.1000.post0}/src/plating/adorner/api.py

@@ -9,14 +9,14 @@ from plating.adorner.adorner import PlatingAdorner
 
 
 # Async entry point
-async def adorn_missing_components(component_types: list[str] = None) -> dict[str, int]:
+async def adorn_missing_components(component_types: list[str] | None = None) -> dict[str, int]:
     """Adorn components with missing .plating directories."""
     adorner = PlatingAdorner()
     return await adorner.adorn_missing(component_types)
 
 
 # Sync entry point
-def adorn_components(component_types: list[str] = None) -> dict[str, int]:
+def adorn_components(component_types: list[str] | None = None) -> dict[str, int]:
     """Sync entry point for adorning components."""
     return asyncio.run(adorn_missing_components(component_types))
 

{plating-0.0.0.dev0 → plating-0.0.1000.post0}/src/plating/adorner/finder.py

@@ -5,12 +5,13 @@
 
 import inspect
 from pathlib import Path
+from typing import Any
 
 
 class ComponentFinder:
     """Finds source files for components."""
 
-    async def find_source(self, component_class) -> Path | None:
+    async def find_source(self, component_class: Any) -> Path | None:
         """Find the source file for a component class."""
         try:
             source_file = inspect.getfile(component_class)

{plating-0.0.0.dev0 → plating-0.0.1000.post0}/src/plating/adorner/templates.py

@@ -3,13 +3,13 @@
 #
 """Template generation for adorned components."""
 
+from typing import Any
+
 
 class TemplateGenerator:
     """Generates templates and examples for components."""
 
-    async def generate_template(
-        self, name: str, component_type: str, component_class
-    ) -> str:
+    async def generate_template(self, name: str, component_type: str, component_class: Any) -> str:
         """Generate template content based on component type."""
         # Get component description if available
         try:
@@ -20,9 +20,7 @@ class TemplateGenerator:
                 if not doc_stripped.startswith("Create a new `Mock`"):
                     description = doc_stripped.split("\n")[0]  # First line only
                 else:
-                    description = (
-                        f"Terraform {component_type.replace('_', ' ')} for {name}"
-                    )
+                    description = f"Terraform {component_type.replace('_', ' ')} for {name}"
             else:
                 description = f"Terraform {component_type.replace('_', ' ')} for {name}"
         except AttributeError:
@@ -128,9 +126,7 @@ description: |-
 {{% endif %}}
 """
 
-    def _generic_template(
-        self, name: str, description: str, component_type: str
-    ) -> str:
+    def _generic_template(self, name: str, description: str, component_type: str) -> str:
         """Generate generic template content."""
         return f"""---
 page_title: "{component_type.title()}: {name}"
@@ -184,7 +180,7 @@ output "example_data" {{
 }}
 
 output "function_result" {{
-  description = "Result of {name} function"  
+  description = "Result of {name} function"
   value       = local.example_result
 }}
 """