WhyML - Modular YAML Manifest Ecosystem

 ██╗    ██╗██╗  ██╗██╗   ██╗███╗   ███╗██╗     
 ██║    ██║██║  ██║╚██╗ ██╔╝████╗ ████║██║     
 ██║ █╗ ██║███████║ ╚████╔╝ ██╔████╔██║██║     
 ██║███╗██║██╔══██║  ╚██╔╝  ██║╚██╔╝██║██║     
 ╚███╔███╔╝██║  ██║   ██║   ██║ ╚═╝ ██║███████╗
  ╚══╝╚══╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝     ╚═╝╚══════╝

🏗️ Modular YAML-based component generation and multi-format conversion ecosystem

🚀 Quick Start

# Install WhyML
pip install whyml

# Scrape a website to YAML manifest
whyml scrape https://example.com --output manifest.yaml

# Convert to multiple formats
whyml convert manifest.yaml --format html --output result.html
whyml convert manifest.yaml --format react --output Component.tsx
whyml convert manifest.yaml --format vue --output Component.vue

📚 Documentation

🏁 Getting Started

📖 Installation Guide - Complete setup instructions
⚡ Quick Start Guide - Get running in 5 minutes
🎯 Examples Guide - Real-world usage examples
🌐 API Usage Guide - Python & REST API reference

📋 Core Documentation

🏗️ Modular Architecture - Ecosystem overview
📝 Manifest Reference - YAML specification
🔄 Converters Guide - Multi-format conversion
🕷️ Advanced Scraping - Web scraping features
🔧 CLI Reference - Command-line interface

💡 Tutorials & Examples

📁 Complete Workflow - End-to-end example
🔬 Advanced Examples - Complex scenarios
🧪 Testing Guide - Validation and testing

🏗️ Modular Architecture

WhyML is built as a modular ecosystem of specialized packages:

📦 Core Packages

whyml-core - Core functionality (validation, loading, processing, utilities)
whyml-scrapers - Web scraping and analysis capabilities
whyml-converters - Multi-format conversion (HTML, React, Vue, PHP)
whyml-cli - Unified command-line interface
whyml - Main package orchestrating all modules

🎯 Key Features

🚀 Multi-Format Conversion: Generate HTML, React, Vue, and PHP from YAML manifests
🔗 Template Inheritance: Advanced inheritance system with dependency resolution
🎨 CSS Integration: Built-in support for CSS frameworks (Bootstrap, Tailwind, Foundation)
🕷️ Advanced Web Scraping: Intelligent website-to-manifest conversion with structure simplification
⚡ Async Processing: High-performance asynchronous manifest loading and processing
🧪 Comprehensive Testing: Extensive test suite with modular architecture
🛠️ CLI & API: Command-line interface and FastAPI server for integration

📖 Read the complete Modular Architecture Guide →

⚡ Quick Example

Transform any website into maintainable YAML and regenerate it in multiple formats:

# Scrape a website to YAML manifest
whyml scrape https://example.com --output manifest.yaml

# Convert to multiple formats
whyml convert manifest.yaml --format html --output result.html
whyml convert manifest.yaml --format react --output Component.tsx
whyml convert manifest.yaml --format vue --output Component.vue

📖 View Complete Examples Guide →

📦 Modular Usage

Use specific packages for targeted functionality:

import asyncio
from whyml_core.loading.manifest_loader import ManifestLoader
from whyml_core.processing.manifest_processor import ManifestProcessor
from whyml_converters.html_converter import HTMLConverter
from whyml_scrapers.url_scraper import URLScraper

async def main():
    # Core functionality - load and process
    loader = ManifestLoader()
    processor = ManifestProcessor()
    
    async with loader:
        manifest = await loader.load_manifest('manifest.yaml')
        processed = processor.process_manifest(manifest)
    
    # Convert to HTML
    html_converter = HTMLConverter()
    result = html_converter.convert(processed)
    result.save_to_file('output.html')
    
    # Web scraping
    scraper = URLScraper()
    async with scraper:
        scraped_manifest = await scraper.scrape_url('https://example.com')

asyncio.run(main())

⌨️ CLI Usage

# Validate manifest using whyml-cli
whyml validate manifest.yaml

# Scrape website using whyml-scrapers  
whyml scrape https://example.com --output scraped.yaml

# Convert using whyml-converters
whyml convert manifest.yaml --format html --output result.html

# Generate applications
whyml generate pwa --manifest manifest.yaml --output ./pwa-app

Example YAML Manifest

metadata:
  title: "Landing Page"
  description: "Modern landing page component"
  version: "1.0.0"

template_vars:
  primary_color: "#007bff"
  hero_text: "Welcome to Our Product"
  cta_text: "Get Started"

styles:
  hero:
    background: "linear-gradient(135deg, {{ primary_color }}, #0056b3)"
    padding: "80px 0"
    text-align: "center"
    color: "white"
  
  cta_button:
    background: "#28a745"
    padding: "15px 30px"
    border: "none"
    border-radius: "5px"
    color: "white"
    font-weight: "bold"
    cursor: "pointer"

structure:
  main:
    class: "hero-section"
    children:
      div:
        class: "container"
        children:
          - h1:
              text: "{{ hero_text }}"
              class: "display-4"
          - p:
              text: "Transform your ideas into reality with our powerful platform"
              class: "lead"
          - button:
              text: "{{ cta_text }}"
              class: "btn btn-success btn-lg"

Advanced Web Scraping

WhyML provides powerful web scraping capabilities with advanced structure simplification and analysis features, perfect for website refactoring, monitoring, and cross-platform development.

Structure Simplification

Reduce complex HTML structures while preserving content and semantic meaning:

# Limit nesting depth to reduce YAML complexity
whyml scrape https://example.com --max-depth 3

# Flatten unnecessary wrapper divs
whyml scrape https://example.com --flatten-containers

# Apply general structure simplification
whyml scrape https://example.com --simplify-structure

# Combine multiple simplification options
whyml scrape https://blog.example.com \
  --max-depth 2 \
  --flatten-containers \
  --simplify-structure

Selective Section Generation

Extract only the sections you need for specific use cases:

# Extract only page analysis (page type detection, SEO metrics)
whyml scrape https://example.com --section analysis

# Get metadata and imports for quick inspection
whyml scrape https://example.com --section metadata --section imports

# Perfect for monitoring - extract only essential data
whyml scrape https://ecommerce-site.com --section analysis --section metadata

# Multiple sections for refactoring projects
whyml scrape https://legacy-site.com \
  --section structure \
  --section styles \
  --max-depth 3

Testing & Comparison Workflow

Validate conversion accuracy with comprehensive testing:

# Complete round-trip testing: scrape → YAML → HTML → compare
whyml scrape https://example.com --test-conversion

# Save regenerated HTML for manual inspection
whyml scrape https://example.com \
  --test-conversion \
  --output-html regenerated.html

# Test with simplification settings
whyml scrape https://complex-site.com \
  --test-conversion \
  --max-depth 2 \
  --flatten-containers \
  --output-html simplified.html

Page Analysis Features

Automatic detection and analysis of web page characteristics:

Page Type Detection: blog, e-commerce, landing page, portfolio, etc.
Content Statistics: word count, element count, links, images
Structure Complexity: nesting depth, semantic elements analysis
SEO Analysis: meta descriptions, heading structure, alt attributes
Accessibility Metrics: alt text coverage, heading hierarchy, language attributes

Real-World Use Cases

Website Refactoring

# Create simplified representations for legacy website modernization
whyml scrape https://legacy-corporate-site.com \
  --simplify-structure \
  --max-depth 3 \
  --flatten-containers \
  --output refactored-manifest.yaml

Cross-Platform Development

# Extract essential structure for mobile app development
whyml scrape https://web-app.com \
  --section structure \
  --section metadata \
  --max-depth 2 \
  --no-preserve-semantic

Website Monitoring

# Track page changes with essential data only
whyml scrape https://competitor-site.com \
  --section analysis \
  --section metadata \
  --output monitoring-$(date +%Y%m%d).yaml

Content Migration

# Test conversion accuracy for content migration projects
whyml scrape https://source-site.com \
  --test-conversion \
  --section structure \
  --section imports \
  --output-html migrated-preview.html

border-radius: "8px"
font-size: "1.2rem"

interactions: cta_click: "handleCTAClick" scroll_tracking: "trackScrollPosition"

structure: div: class: "container" children: - section: class: "hero" children: - h1: text: "{{ hero_text }}" - button: class: "cta_button" text: "{{ cta_text }}" onClick: "cta_click"


## Core Components

### Manifest Loader

Handles YAML manifest loading with advanced features:

- **Async Loading**: Non-blocking file and URL loading
- **Dependency Resolution**: Automatic resolution of manifest dependencies
- **Template Inheritance**: Support for `extends` relationships
- **Caching**: TTL-based caching for performance
- **Error Handling**: Comprehensive error reporting

```python
from whyml.manifest_loader import ManifestLoader

async with ManifestLoader() as loader:
    manifest = await loader.load_manifest('manifest.yaml')

Manifest Processor

Processes loaded manifests with template resolution:

Template Variables: Jinja2-based template processing
Style Optimization: CSS optimization and merging
Validation: Schema validation and error detection
Inheritance Merging: Smart merging of inherited manifests

from whyml.manifest_processor import ManifestProcessor

processor = ManifestProcessor()
processed = processor.process_manifest(raw_manifest)

Format Converters

HTML Converter

Generates semantic, optimized HTML with integrated CSS:

from whyml.converters import HTMLConverter

converter = HTMLConverter(
    css_framework='bootstrap',
    optimize_output=True,
    include_meta_tags=True
)
result = converter.convert(manifest)

React Converter

Creates React functional components with TypeScript support:

from whyml.converters import ReactConverter

converter = ReactConverter(
    use_typescript=True,
    component_type='functional',
    css_framework='tailwind'
)
result = converter.convert(manifest)

Vue Converter

Generates Vue 3 Single File Components:

from whyml.converters import VueConverter

converter = VueConverter(
    vue_version='3',
    use_composition_api=True,
    use_typescript=True
)
result = converter.convert(manifest)

PHP Converter

Creates modern PHP classes with templating:

from whyml.converters import PHPConverter

converter = PHPConverter(
    namespace='App\\Components',
    php_version='8.1',
    use_type_declarations=True
)
result = converter.convert(manifest)

Web Scraping

Intelligent website analysis and manifest generation:

from whyml.scrapers import URLScraper, WebpageAnalyzer

async with URLScraper() as scraper:
    manifest = await scraper.scrape_url('https://example.com')
    
analyzer = WebpageAnalyzer()
analysis = analyzer.analyze_webpage(soup, url)

Advanced Features

Template Inheritance

Create reusable base components:

# base-component.yaml
metadata:
  title: "Base Component"
  version: "1.0.0"

styles:
  container: "width: 100%; padding: 20px;"
  
structure:
  div:
    class: "container"
    children:
      h1:
        text: "{{ title }}"

# child-component.yaml
extends: "./base-component.yaml"

metadata:
  title: "Child Component"
  description: "Extends base component"

styles:
  content: "margin: 10px 0;"

structure:
  div:
    class: "container"
    children:
      - h1:
          text: "{{ title }}"
      - p:
          class: "content"
          text: "{{ description }}"

Dependency Management

imports:
  - "https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css"
  - "./shared/styles.css"

dependencies:
  - "./components/header.yaml"
  - "./components/footer.yaml"

Interactive Elements

interactions:
  button_click: "handleButtonClick"
  form_submit: "handleFormSubmit"
  state_counter: "useState(0)"
  effect_mount: "useEffect(() => {}, [])"

structure:
  form:
    onSubmit: "form_submit"
    children:
      - input:
          type: "text"
          placeholder: "Enter text"
      - button:
          onClick: "button_click"
          text: "Submit"

CLI Usage

Development Server (`whyml run`)

# Start development server (default: manifest.yaml on port 8080)
whyml run

# Custom manifest and port
whyml run -f manifest.yaml -p 8080 -h localhost

# Production deployment with TLS
whyml run -f manifest.yaml --port 443 --host yourdomain.com --tls-provider letsencrypt

# Development with file watching and auto-reload
whyml run -f manifest.yaml --watch --caddy-config Caddyfile.json

Natural Language Conversion

# Convert using intuitive syntax
whyml convert --from manifest.yaml --to index.html -as html
whyml convert --from manifest.yaml --to App.tsx -as react
whyml convert --from manifest.yaml --to App.vue -as vue
whyml convert --from manifest.yaml --to app.html -as spa
whyml convert --from manifest.yaml --to pwa-app.html -as pwa

# With environment variables and configuration
whyml convert --from manifest.yaml --to app.html -as pwa --env-file .env --config pwa.json

Application Generation

# Generate Progressive Web App
whyml generate pwa -f manifest.yaml -o ./pwa-app

# Generate Single Page Application
whyml generate spa -f manifest.yaml -o ./spa-app

# Generate mobile app configuration (APK via Capacitor)
whyml generate apk -f manifest.yaml -o ./mobile-app

# Generate desktop app (Tauri)
whyml generate tauri -f manifest.yaml -o ./desktop-app

# Generate Docker configuration
whyml generate docker -f manifest.yaml -o ./docker-config

# Generate Caddy server configuration
whyml generate caddy -f manifest.yaml -o ./Caddyfile.json

Legacy Commands (Still Supported)

# Validate manifest
whyml validate manifest.yaml

# Scrape website to manifest
whyml scrape https://example.com --output scraped-manifest.yaml

# Alternative server command (alias for run)
whyml serve -f manifest.yaml --port 3000 --watch

API Server

Start the FastAPI server for REST API access:

whyml server --port 8000

API Endpoints

POST /api/convert - Convert manifest to specified format
GET /api/manifest/{name} - Load manifest by name
POST /api/scrape - Scrape URL to manifest
POST /api/validate - Validate manifest structure
GET /api/health - Health check endpoint

Testing

Run the comprehensive test suite:

# Install development dependencies
pip install -r requirements-dev.txt

# Run all tests
pytest

# Run with coverage
pytest --cov=whyml --cov-report=html

# Run specific test modules
pytest tests/test_converters.py
pytest tests/test_manifest_loader.py

# ✅ Selective section generation - WORKS NOW!
whyml scrape https://example.com --section analysis --section metadata

# ✅ Structure simplification for refactoring
whyml scrape https://tom.sapletta.com --max-depth 3 --flatten-containers --simplify-structure

# ✅ Complete testing workflow with comparison
whyml scrape https://example.com --test-conversion --output-html regenerated.html

# ✅ Monitoring-friendly simple extraction  
whyml scrape https://blog.example.com --section analysis --max-depth 2

Architecture

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   YAML Input    │────│  Manifest Loader │────│ Manifest Processor│
│   • Files       │    │  • Async Loading │    │ • Template Vars  │
│   • URLs        │    │  • Dependency    │    │ • Validation     │
│   • Inheritance │    │    Resolution    │    │ • Optimization   │
└─────────────────┘    └──────────────────┘    └─────────────────┘
                                                          │
                       ┌──────────────────────────────────┴───────────────────┐
                       │                                                      │
┌─────────────────┐    │                                    ┌─────────────────┐
│   Converters    │────┤                                    │   Web Scrapers  │
│   • HTML        │    │                                    │   • URL Scraper │
│   • React       │    │          WhyML Core               │   • Page Analysis│
│   • Vue         │    │                                    │   • Structure   │
│   • PHP         │    │                                    │     Detection   │
└─────────────────┘    │                                    └─────────────────┘
                       │                                                      │
┌─────────────────┐    │                                    ┌─────────────────┐
│   CLI/API       │────┤                                    │   Output        │
│   • Commands    │    │                                    │   • Files       │
│   • FastAPI     │    │                                    │   • Validation  │
│   • Development │    │                                    │   • Optimization│
└─────────────────┘    └──────────────────────────────────────────────────────┘

Configuration

Environment Variables

export WHYML_CACHE_SIZE=1000
export WHYML_CACHE_TTL=3600
export WHYML_DEFAULT_FORMAT=html
export WHYML_OUTPUT_DIR=./output
export WHYML_MANIFEST_DIR=./manifests

Configuration File

# whyml.config.yaml
cache:
  size: 1000
  ttl: 3600

conversion:
  optimize_output: true
  include_meta_tags: true
  css_framework: "bootstrap"

validation:
  strict_mode: false
  allow_unknown_properties: true

scraping:
  user_agent: "WhyML-Scraper/1.0"
  timeout: 30
  extract_styles: true

🧪 Testing

WhyML features a comprehensive modular test suite with 127+ test cases across all packages:

📊 Current Test Status

Status	Count	Description
✅ Collected	127 tests	All tests successfully discovered
✅ Passing	117+ tests	Core functionality working
🔧 Remaining	~10 tests	Minor CLI flags and async issues
📈 Improvement	85%+ → 95%	API compatibility fixes resolved most issues

📊 Modular Test Coverage

Package	Test Files	Test Cases	Status
whyml-core	4 files	35+ tests	✅ Core APIs working
whyml-scrapers	3 files	25+ tests	✅ URLScraper, WebpageAnalyzer fixed
whyml-converters	4 files	35+ tests	✅ HTML, React, Vue, PHP converters working
whyml-cli	3 files	32+ tests	✅ Most commands working, minor CLI flag issues
Integration	Multiple	End-to-end	✅ Cross-package workflows operational

🚀 Running Tests

# Run all tests across entire ecosystem
make test

# Run tests with coverage report
make test-coverage  

# Test specific modular packages
cd whyml-core && pytest tests/ -v
cd whyml-scrapers && pytest tests/ -v  
cd whyml-converters && pytest tests/ -v
cd whyml-cli && pytest tests/ -v

# Integration testing
pytest tests/test_modular_integration.py -v

# Performance benchmarks
pytest tests/ -k "performance" -v

🎯 Test Categories

🔧 Unit Tests: Individual component functionality
🔗 Integration Tests: Cross-package workflows
⚡ Performance Tests: Speed and memory benchmarks
🛡️ Error Handling: Edge cases and failure scenarios
⌨️ CLI Tests: Command-line interface validation
🌐 Network Tests: Web scraping and external requests
🎭 End-to-End: Complete pipeline validation

✅ Test Quality Metrics & Recent Improvements

127+ total test cases successfully collected across all modular packages
117+ tests passing with critical functionality working
Major API compatibility fixes - reduced failures from 68 to 10 tests
Async testing for all async operations with improved async wrapper methods
Mock testing for external dependencies
Parameterized tests for multiple input scenarios
Property-based testing for edge case discovery

🔧 Recent API Compatibility Fixes (2025)

✅ Converter APIs: Added convert() methods and constructor parameters (css_framework, use_typescript, vue_version, php_version)
✅ Scraper APIs: Added scrape_url() method, _calculate_similarity(), and max_nesting_depth parameter
✅ Structure Analysis: Added simplification_applied and max_nesting_depth fields for test compatibility
✅ NetworkError: Added details parameter to constructor for enhanced error handling
✅ ConversionResult: Added filename parameter and format_type property for test compatibility
✅ LoadedManifest Handling: Fixed CLI conversion error by proper .content extraction

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Development Setup

git clone https://github.com/dynapsys/whyml.git
cd whyml
python -m venv venv
source venv/bin/activate  # or venv\Scripts\activate on Windows
pip install -e .
pip install -r requirements-dev.txt

Running Tests

pytest                          # Run all tests
pytest --cov=whyml             # With coverage
pytest -v tests/test_*.py       # Verbose output
pytest --benchmark-only         # Performance tests

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

Changelog

v1.0.0 (2024-01-15)

Initial release
Core manifest loading and processing
HTML, React, Vue, PHP converters
Web scraping capabilities
Comprehensive test suite
CLI and API interfaces

Support

Made with ❤️ by Tom Sapletta

Metadata

Release files for whyml 0.1.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for whyml 0.1.28
File	Size	Uploaded
whyml-0.1.28.tar.gz	215.6 kB	Sep 22, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for whyml 0.1.28
File	Interpreter	ABI	Platform	Reset
whyml-0.1.28-py3-none-any.whl 223.0 kB Sep 22, 2025	Python 3	none	any	Details

Total release size: 438.6 kB

Release files / whyml-0.1.28.tar.gz

Download URL	whyml-0.1.28.tar.gz
Size	215.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`726dd7b81adaf03000a8d8963172ab1a884312970c0e1f5ba9882f0a6550f63a`
BLAKE2b-256 checksum How to use checksums	`a89b3e8b95fcc70c1f6b615deee379a0c7a7d25005ec0670e5096e0d5e4c8133`
Upload date	Sep 22, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.0`

Release files / whyml-0.1.28-py3-none-any.whl

Download URL	whyml-0.1.28-py3-none-any.whl
Size	223.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`76c9a1fc728d38e2f678419e919826936c5a857cf0c105e7a14d768603525000`
BLAKE2b-256 checksum How to use checksums	`837a0c7fa3f747e4d9e1bb1201fb751771870f7012e6cab40f6fef5179ae24c1`
Upload date	Sep 22, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.0`