structkit 3.0.0__tar.gz → 3.1.0__tar.gz

{structkit-3.0.0/structkit.egg-info → structkit-3.1.0}/PKG-INFO

@@ -1,14 +1,19 @@
 Metadata-Version: 2.4
 Name: structkit
-Version: 3.0.0
-Summary: A structured data processing tool
+Version: 3.1.0
+Summary: YAML-first project scaffolding tool with remote content fetching, AI/MCP integration, and DevOps automation
 Author: httpdss
 License: MIT
-Project-URL: Homepage, https://github.com/httpdss/structkit
-Project-URL: Repository, https://github.com/httpdss/structkit.git
-Keywords: data,structure,processing
+Project-URL: Homepage, https://httpdss.github.io/structkit/
+Project-URL: Repository, https://github.com/httpdss/structkit
+Project-URL: Issues, https://github.com/httpdss/structkit/issues
+Project-URL: Discussions, https://github.com/httpdss/structkit/discussions
+Project-URL: Documentation, https://httpdss.github.io/structkit/docs/
+Project-URL: Funding, https://httpdss.github.io/structkit/docs/funding/
+Keywords: project-scaffolding,project-template,scaffolding,cookiecutter-alternative,copier-alternative,yaml-template,code-generation,devops,mcp,model-context-protocol,devex,platform-engineering,project-structure,boilerplate
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
@@ -16,6 +21,11 @@ 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: Environment :: Console
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -27,7 +37,7 @@ Requires-Dist: jinja2>=3.1.0
 Requires-Dist: PyGithub>=1.58.0
 Requires-Dist: shtab>=1.6.0
 Requires-Dist: colorlog>=6.7.0
-Requires-Dist: pydantic-ai>=0.1.0
+Requires-Dist: pydantic-ai-slim[anthropic,google,openai]>=0.1.0
 Requires-Dist: fastmcp>=2.0.0
 Provides-Extra: s3
 Requires-Dist: boto3>=1.26.0; extra == "s3"
@@ -45,18 +55,68 @@ Requires-Dist: flake8>=4.0.0; extra == "dev"
 Requires-Dist: mypy>=0.990; extra == "dev"
 Dynamic: license-file
 
-# 🚀 StructKit: Automated Project Structure Generator
+# 🚀 StructKit: YAML-first scaffolding for teams and AI agents
 
-![StructKit Logo](./docs/assets/github-hero.gif)
+> Define project structures once in YAML, then generate consistent repos, CI files, docs, Terraform modules, and app layouts locally, in CI, or through an AI assistant via MCP.
 
-[![codecov](https://codecov.io/github/httpdss/structkit/graph/badge.svg?token=JL5WIO1C9T)](https://codecov.io/github/httpdss/struct)
-![GitHub issues](https://img.shields.io/github/issues/httpdss/struct)
-![GitHub pull requests](https://img.shields.io/github/issues-pr/httpdss/struct)
-![GitHub stars](https://img.shields.io/github/stars/httpdss/struct?style=social)
+![StructKit demo: generate project structure from YAML](./docs/assets/github-hero.gif)
 
-**StructKit** is a powerful, flexible tool for automating project structure creation through YAML configurations. Generate consistent project layouts, boilerplate code, and configurations with template variables, remote content fetching, and intelligent file handling.
+[![codecov](https://codecov.io/github/httpdss/structkit/graph/badge.svg?token=JL5WIO1C9T)](https://codecov.io/github/httpdss/structkit)
+![GitHub issues](https://img.shields.io/github/issues/httpdss/structkit)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/httpdss/structkit)
+![GitHub stars](https://img.shields.io/github/stars/httpdss/structkit?style=social)
 
-> 📚 **[View Complete Documentation](docs/index.md)** | 🚀 **[Quick Start Guide](docs/quickstart.md)** | 🔧 **[Installation](docs/installation.md)**
+**StructKit** replaces copy-pasted boilerplate and aging "golden repos" with reusable YAML structures. It can render template variables, fetch canonical files from remote sources, preview changes before writing, and expose your scaffolds to AI assistants through the Model Context Protocol.
+
+> 🚀 **[Quick Start](docs/quickstart.md)** | 📚 **[Docs](docs/index.md)** | 🧩 **[Examples](examples/)** | 🤖 **[MCP Guide](docs/mcp-integration.md)** | 💬 **[Discussions](https://github.com/httpdss/structkit/discussions)**
+
+## ⚡ Try it in 60 seconds
+
+```bash
+# Install the CLI
+pip install structkit
+
+# Preview available bundled structures
+structkit list
+
+# Generate a ready-made Terraform module scaffold
+structkit generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module
+```
+
+Prefer Docker?
+
+```bash
+docker run --rm -v "$(pwd):/workdir" ghcr.io/httpdss/structkit:main \
+  generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module
+```
+
+## 👤 Who StructKit is for
+
+- **Platform / DevEx teams** standardizing service layouts, CI baselines, and engineering conventions across many repos.
+- **DevOps engineers** generating repeatable Terraform modules, Kubernetes manifests, GitHub Actions workflows, and config bundles.
+- **AI coding workflow users** who want assistants to scaffold from approved templates instead of inventing project structure.
+- **Individual developers** tired of rebuilding the same files, folders, and docs for every new project.
+
+## 🤔 Why StructKit?
+
+Project scaffolding tools exist in most ecosystems, but StructKit solves problems the others often leave to copy-paste, template repositories, or custom scripts.
+
+| Feature | cookiecutter | copier | **StructKit** |
+|---|---|---|---|
+| Remote content (GitHub, S3, GCS, HTTP) | ❌ | ❌ | ✅ |
+| AI / MCP integration | ❌ | ❌ | ✅ |
+| Pre/post generation hooks | ✅ | ✅ | ✅ |
+| Dry run mode | ❌ | ✅ | ✅ |
+| YAML-first (no template repo required) | ❌ | ❌ | ✅ |
+| Multiple file conflict strategies | ❌ | ✅ | ✅ |
+| IDE schema validation | ❌ | ❌ | ✅ |
+
+**Key differentiators:**
+
+- **Remote-first content:** Reference your organization's canonical CI template from GitHub directly in your StructKit config. When the template updates, all new projects get the update — no copy-paste maintenance.
+- **AI-native via MCP:** Start the StructKit MCP server so your AI assistant can generate project scaffolds from natural language using your templates as the source of truth.
+- **YAML-first:** Define structures directly in YAML. No separate template repository is required.
+- **Safe by default:** Use dry-run previews and file conflict strategies before writing into existing projects.
 
 ## ✨ Key Features
 
@@ -69,23 +129,11 @@ Dynamic: license-file
 - **✅ Validation & Schema** - Built-in YAML validation and IDE support
 - **🤖 MCP Integration** - Model Context Protocol support for AI-assisted development workflows
 
-## 🚀 Quick Start
-
-### Installation
-
-```bash
-# Install via pip
-pip install git+https://github.com/httpdss/structkit.git
-
-# Or run with Docker
-docker run -v $(pwd):/workdir ghcr.io/httpdss/structkit:main generate my-config.yaml ./output
-```
-
-### Basic Usage
+## 🚀 More usage examples
 
 ```bash
 # Generate a Terraform module structure
-structkit generate terraform-module ./my-terraform-module
+structkit generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module
 
 # List available structures
 structkit list
@@ -95,7 +143,9 @@ structkit validate my-config.yaml
 
 # Start MCP server for AI integration
 structkit mcp --server
- ```
+```
+
+If StructKit saves you setup time, **star the repo**, try an [example](examples/), or share your use case in [GitHub Discussions](https://github.com/httpdss/structkit/discussions).
 
 ### Example Configuration
 
@@ -154,7 +204,7 @@ Our comprehensive documentation is organized into the following sections:
 ### 📖 Resources
 
 - **[Articles & Tutorials](docs/articles.md)** - Community content and learning resources
-- **[Examples](example/)** - Practical examples and use cases
+- **[Examples](examples/)** - Practical examples and use cases
 
 ## 🎯 Use Cases
 

{structkit-3.0.0 → structkit-3.1.0}/README.md

@@ -1,15 +1,65 @@
-# 🚀 StructKit: Automated Project Structure Generator
+# 🚀 StructKit: YAML-first scaffolding for teams and AI agents
 
-![StructKit Logo](./docs/assets/github-hero.gif)
+> Define project structures once in YAML, then generate consistent repos, CI files, docs, Terraform modules, and app layouts locally, in CI, or through an AI assistant via MCP.
 
-[![codecov](https://codecov.io/github/httpdss/structkit/graph/badge.svg?token=JL5WIO1C9T)](https://codecov.io/github/httpdss/struct)
-![GitHub issues](https://img.shields.io/github/issues/httpdss/struct)
-![GitHub pull requests](https://img.shields.io/github/issues-pr/httpdss/struct)
-![GitHub stars](https://img.shields.io/github/stars/httpdss/struct?style=social)
+![StructKit demo: generate project structure from YAML](./docs/assets/github-hero.gif)
 
-**StructKit** is a powerful, flexible tool for automating project structure creation through YAML configurations. Generate consistent project layouts, boilerplate code, and configurations with template variables, remote content fetching, and intelligent file handling.
+[![codecov](https://codecov.io/github/httpdss/structkit/graph/badge.svg?token=JL5WIO1C9T)](https://codecov.io/github/httpdss/structkit)
+![GitHub issues](https://img.shields.io/github/issues/httpdss/structkit)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/httpdss/structkit)
+![GitHub stars](https://img.shields.io/github/stars/httpdss/structkit?style=social)
 
-> 📚 **[View Complete Documentation](docs/index.md)** | 🚀 **[Quick Start Guide](docs/quickstart.md)** | 🔧 **[Installation](docs/installation.md)**
+**StructKit** replaces copy-pasted boilerplate and aging "golden repos" with reusable YAML structures. It can render template variables, fetch canonical files from remote sources, preview changes before writing, and expose your scaffolds to AI assistants through the Model Context Protocol.
+
+> 🚀 **[Quick Start](docs/quickstart.md)** | 📚 **[Docs](docs/index.md)** | 🧩 **[Examples](examples/)** | 🤖 **[MCP Guide](docs/mcp-integration.md)** | 💬 **[Discussions](https://github.com/httpdss/structkit/discussions)**
+
+## ⚡ Try it in 60 seconds
+
+```bash
+# Install the CLI
+pip install structkit
+
+# Preview available bundled structures
+structkit list
+
+# Generate a ready-made Terraform module scaffold
+structkit generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module
+```
+
+Prefer Docker?
+
+```bash
+docker run --rm -v "$(pwd):/workdir" ghcr.io/httpdss/structkit:main \
+  generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module
+```
+
+## 👤 Who StructKit is for
+
+- **Platform / DevEx teams** standardizing service layouts, CI baselines, and engineering conventions across many repos.
+- **DevOps engineers** generating repeatable Terraform modules, Kubernetes manifests, GitHub Actions workflows, and config bundles.
+- **AI coding workflow users** who want assistants to scaffold from approved templates instead of inventing project structure.
+- **Individual developers** tired of rebuilding the same files, folders, and docs for every new project.
+
+## 🤔 Why StructKit?
+
+Project scaffolding tools exist in most ecosystems, but StructKit solves problems the others often leave to copy-paste, template repositories, or custom scripts.
+
+| Feature | cookiecutter | copier | **StructKit** |
+|---|---|---|---|
+| Remote content (GitHub, S3, GCS, HTTP) | ❌ | ❌ | ✅ |
+| AI / MCP integration | ❌ | ❌ | ✅ |
+| Pre/post generation hooks | ✅ | ✅ | ✅ |
+| Dry run mode | ❌ | ✅ | ✅ |
+| YAML-first (no template repo required) | ❌ | ❌ | ✅ |
+| Multiple file conflict strategies | ❌ | ✅ | ✅ |
+| IDE schema validation | ❌ | ❌ | ✅ |
+
+**Key differentiators:**
+
+- **Remote-first content:** Reference your organization's canonical CI template from GitHub directly in your StructKit config. When the template updates, all new projects get the update — no copy-paste maintenance.
+- **AI-native via MCP:** Start the StructKit MCP server so your AI assistant can generate project scaffolds from natural language using your templates as the source of truth.
+- **YAML-first:** Define structures directly in YAML. No separate template repository is required.
+- **Safe by default:** Use dry-run previews and file conflict strategies before writing into existing projects.
 
 ## ✨ Key Features
 
@@ -22,23 +72,11 @@
 - **✅ Validation & Schema** - Built-in YAML validation and IDE support
 - **🤖 MCP Integration** - Model Context Protocol support for AI-assisted development workflows
 
-## 🚀 Quick Start
-
-### Installation
-
-```bash
-# Install via pip
-pip install git+https://github.com/httpdss/structkit.git
-
-# Or run with Docker
-docker run -v $(pwd):/workdir ghcr.io/httpdss/structkit:main generate my-config.yaml ./output
-```
-
-### Basic Usage
+## 🚀 More usage examples
 
 ```bash
 # Generate a Terraform module structure
-structkit generate terraform-module ./my-terraform-module
+structkit generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module
 
 # List available structures
 structkit list
@@ -48,7 +86,9 @@ structkit validate my-config.yaml
 
 # Start MCP server for AI integration
 structkit mcp --server
- ```
+```
+
+If StructKit saves you setup time, **star the repo**, try an [example](examples/), or share your use case in [GitHub Discussions](https://github.com/httpdss/structkit/discussions).
 
 ### Example Configuration
 
@@ -107,7 +147,7 @@ Our comprehensive documentation is organized into the following sections:
 ### 📖 Resources
 
 - **[Articles & Tutorials](docs/articles.md)** - Community content and learning resources
-- **[Examples](example/)** - Practical examples and use cases
+- **[Examples](examples/)** - Practical examples and use cases
 
 ## 🎯 Use Cases
 

{structkit-3.0.0 → structkit-3.1.0}/pyproject.toml

@@ -4,14 +4,15 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "structkit"
-version = "3.0.0"
-description = "A structured data processing tool"
+version = "3.1.0"
+description = "YAML-first project scaffolding tool with remote content fetching, AI/MCP integration, and DevOps automation"
 readme = "README.md"
 license = {text = "MIT"}
 authors = [{name = "httpdss"}]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.8",
@@ -19,9 +20,29 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Environment :: Console",
+    "Topic :: Software Development :: Code Generators",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: System :: Systems Administration",
+    "Topic :: Utilities",
 ]
 requires-python = ">=3.8"
-keywords = ["data", "structure", "processing"]
+keywords = [
+    "project-scaffolding",
+    "project-template",
+    "scaffolding",
+    "cookiecutter-alternative",
+    "copier-alternative",
+    "yaml-template",
+    "code-generation",
+    "devops",
+    "mcp",
+    "model-context-protocol",
+    "devex",
+    "platform-engineering",
+    "project-structure",
+    "boilerplate",
+]
 
 dependencies = [
     "PyYAML>=6.0",
@@ -32,7 +53,7 @@ dependencies = [
     "PyGithub>=1.58.0",
     "shtab>=1.6.0",
     "colorlog>=6.7.0",
-    "pydantic-ai>=0.1.0",
+    "pydantic-ai-slim[openai,google,anthropic]>=0.1.0",
     "fastmcp>=2.0.0",
 ]
 
@@ -57,8 +78,12 @@ dev = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/httpdss/structkit"
-Repository = "https://github.com/httpdss/structkit.git"
+Homepage = "https://httpdss.github.io/structkit/"
+Repository = "https://github.com/httpdss/structkit"
+Issues = "https://github.com/httpdss/structkit/issues"
+Discussions = "https://github.com/httpdss/structkit/discussions"
+Documentation = "https://httpdss.github.io/structkit/docs/"
+Funding = "https://httpdss.github.io/structkit/docs/funding/"
 
 [project.scripts]
 structkit = "structkit.main:main"

{structkit-3.0.0 → structkit-3.1.0}/structkit/commands/__init__.py

@@ -1,6 +1,7 @@
 import logging
 from structkit.completers import log_level_completer
 
+
 # Base command class
 class Command:
     def __init__(self, parser):

{structkit-3.0.0 → structkit-3.1.0}/structkit/commands/completion.py

@@ -3,6 +3,7 @@ import os
 
 SUPPORTED_SHELLS = ["bash", "zsh", "fish"]
 
+
 class CompletionCommand(Command):
   def __init__(self, parser):
     super().__init__(parser)