plating 0.0.0.dev0__tar.gz

plating-0.0.0.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 provide.io llc
+
+   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.

plating-0.0.0.dev0/PKG-INFO

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: plating
+Version: 0.0.0.dev0
+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
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+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"
+Dynamic: license-file
+
+# 🍽️ Plating
+
+> A sophisticated documentation generation system for Terraform/OpenTofu providers
+
+Plating is a powerful documentation system that brings culinary elegance to technical documentation. Just as a chef carefully plates and garnishes a dish, Plating helps you present your Terraform provider documentation beautifully.
+
+## ✨ Features
+
+- **🎯 Automatic Documentation Generation** - Generate comprehensive docs from your provider code
+- **👗 Smart Component Dressing** - 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
+- **🔄 Schema Integration** - Extract and format provider schemas automatically
+
+## 📦 Prerequisites
+
+> **Important:** This project uses `uv` for Python environment and package management.
+
+### Install UV
+
+Visit [UV Documentation](https://github.com/astral-sh/uv) for more information.
+
+```bash
+# On macOS and Linux.
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# On Windows.
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+
+# Using pipx (if you prefer)
+pipx install uv
+
+# Update UV to latest version
+uv self update
+```
+
+## 🚀 Getting Started
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/provide-io/plating.git
+cd plating
+
+# Create virtual environment
+uv venv
+
+# Activate virtual environment
+source .venv/bin/activate  # On Linux/macOS
+# or
+.venv\Scripts\activate     # On Windows
+
+# Install dependencies
+uv sync
+```
+
+### Installing as a Package
+
+```bash
+# Install from PyPI
+uv add plating
+
+# Or install from source
+uv add git+https://github.com/provide-io/plating.git
+```
+
+## 📚 Usage Examples
+
+### 1. Dress Your Components
+
+First, create `.plating` bundles for your undocumented components:
+
+```bash
+# Dress all missing components
+plating dress
+
+# Dress only resources
+plating dress --component-type resource
+```
+
+### 2. Customize Templates
+
+Edit the generated templates in `.plating/docs/`:
+
+```markdown
+---
+page_title: "Resource: my_resource"
+---
+
+# my_resource
+
+{{ "{{ example('basic') }}" }}
+
+## Schema
+
+{{ "{{ schema() }}" }}
+```
+
+### 3. Generate Documentation
+
+Render your documentation:
+
+```bash
+# Generate docs in ./docs directory
+plating plate
+
+# Custom output directory
+plating plate --output-dir ./documentation
+```
+
+## 📂 Bundle Structure
+
+Each component has a `.plating` bundle:
+
+```
+my_resource.plating/
+├── docs/
+│   ├── my_resource.tmpl.md    # Main template
+│   └── _partial.md             # Reusable partials
+├── examples/
+│   ├── basic.tf                # Example configurations
+│   └── advanced.tf
+└── fixtures/                   # Test data
+    └── test_config.json
+```
+
+## 🎨 Template Functions
+
+Plating provides powerful template functions:
+
+- `{{ "{{ example('name') }}" }}` - Include an example file
+- `{{ "{{ schema() }}" }}` - Render component schema
+- `{{ "{{ partial('name') }}" }}` - Include a partial template
+- `{{ "{{ anchor('text') }}" }}` - Create header anchors
+
+## 🧪 Testing
+
+Test your examples with the built-in test runner:
+
+```bash
+# Test all examples
+plating test
+
+# Test specific component types
+plating test --component-type resource
+```
+
+## 🔧 Configuration
+
+Configure Plating in your `pyproject.toml`:
+
+```toml
+[tool.plating]
+provider_name = "my_provider"
+output_dir = "docs"
+component_types = ["resource", "data_source", "function"]
+```
+
+## 🏗️ Architecture
+
+Plating follows a modular architecture:
+
+- **PlatingBundle** - Represents documentation bundles
+- **PlatingPlater** - Renders documentation
+- **PlatingDresser** - Creates documentation templates
+- **PlatingDiscovery** - Finds components and bundles
+- **SchemaProcessor** - Extracts provider schemas
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📜 License
+
+Apache 2.0
+
+## 🙏 Acknowledgments
+
+Built with ❤️ using:
+- [attrs](https://www.attrs.org/) - Python classes without boilerplate
+- [Jinja2](https://jinja.palletsprojects.com/) - Powerful templating
+- [pyvider](https://github.com/provide-io/pyvider) - Terraform provider framework
+- [click](https://click.palletsprojects.com/) - Command line interface
+- [rich](https://rich.readthedocs.io/) - Beautiful terminal output
+
+---
+
+*Plating - Making documentation as delightful as a well-plated dish* 🍽️

plating-0.0.0.dev0/README.md

@@ -0,0 +1,190 @@
+# 🍽️ Plating
+
+> A sophisticated documentation generation system for Terraform/OpenTofu providers
+
+Plating is a powerful documentation system that brings culinary elegance to technical documentation. Just as a chef carefully plates and garnishes a dish, Plating helps you present your Terraform provider documentation beautifully.
+
+## ✨ Features
+
+- **🎯 Automatic Documentation Generation** - Generate comprehensive docs from your provider code
+- **👗 Smart Component Dressing** - 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
+- **🔄 Schema Integration** - Extract and format provider schemas automatically
+
+## 📦 Prerequisites
+
+> **Important:** This project uses `uv` for Python environment and package management.
+
+### Install UV
+
+Visit [UV Documentation](https://github.com/astral-sh/uv) for more information.
+
+```bash
+# On macOS and Linux.
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# On Windows.
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+
+# Using pipx (if you prefer)
+pipx install uv
+
+# Update UV to latest version
+uv self update
+```
+
+## 🚀 Getting Started
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/provide-io/plating.git
+cd plating
+
+# Create virtual environment
+uv venv
+
+# Activate virtual environment
+source .venv/bin/activate  # On Linux/macOS
+# or
+.venv\Scripts\activate     # On Windows
+
+# Install dependencies
+uv sync
+```
+
+### Installing as a Package
+
+```bash
+# Install from PyPI
+uv add plating
+
+# Or install from source
+uv add git+https://github.com/provide-io/plating.git
+```
+
+## 📚 Usage Examples
+
+### 1. Dress Your Components
+
+First, create `.plating` bundles for your undocumented components:
+
+```bash
+# Dress all missing components
+plating dress
+
+# Dress only resources
+plating dress --component-type resource
+```
+
+### 2. Customize Templates
+
+Edit the generated templates in `.plating/docs/`:
+
+```markdown
+---
+page_title: "Resource: my_resource"
+---
+
+# my_resource
+
+{{ "{{ example('basic') }}" }}
+
+## Schema
+
+{{ "{{ schema() }}" }}
+```
+
+### 3. Generate Documentation
+
+Render your documentation:
+
+```bash
+# Generate docs in ./docs directory
+plating plate
+
+# Custom output directory
+plating plate --output-dir ./documentation
+```
+
+## 📂 Bundle Structure
+
+Each component has a `.plating` bundle:
+
+```
+my_resource.plating/
+├── docs/
+│   ├── my_resource.tmpl.md    # Main template
+│   └── _partial.md             # Reusable partials
+├── examples/
+│   ├── basic.tf                # Example configurations
+│   └── advanced.tf
+└── fixtures/                   # Test data
+    └── test_config.json
+```
+
+## 🎨 Template Functions
+
+Plating provides powerful template functions:
+
+- `{{ "{{ example('name') }}" }}` - Include an example file
+- `{{ "{{ schema() }}" }}` - Render component schema
+- `{{ "{{ partial('name') }}" }}` - Include a partial template
+- `{{ "{{ anchor('text') }}" }}` - Create header anchors
+
+## 🧪 Testing
+
+Test your examples with the built-in test runner:
+
+```bash
+# Test all examples
+plating test
+
+# Test specific component types
+plating test --component-type resource
+```
+
+## 🔧 Configuration
+
+Configure Plating in your `pyproject.toml`:
+
+```toml
+[tool.plating]
+provider_name = "my_provider"
+output_dir = "docs"
+component_types = ["resource", "data_source", "function"]
+```
+
+## 🏗️ Architecture
+
+Plating follows a modular architecture:
+
+- **PlatingBundle** - Represents documentation bundles
+- **PlatingPlater** - Renders documentation
+- **PlatingDresser** - Creates documentation templates
+- **PlatingDiscovery** - Finds components and bundles
+- **SchemaProcessor** - Extracts provider schemas
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📜 License
+
+Apache 2.0
+
+## 🙏 Acknowledgments
+
+Built with ❤️ using:
+- [attrs](https://www.attrs.org/) - Python classes without boilerplate
+- [Jinja2](https://jinja.palletsprojects.com/) - Powerful templating
+- [pyvider](https://github.com/provide-io/pyvider) - Terraform provider framework
+- [click](https://click.palletsprojects.com/) - Command line interface
+- [rich](https://rich.readthedocs.io/) - Beautiful terminal output
+
+---
+
+*Plating - Making documentation as delightful as a well-plated dish* 🍽️

plating-0.0.0.dev0/VERSION

@@ -0,0 +1 @@
+0.0.0.dev0