DOC-5503 David's local examples build

Author: andy-stark-redis

build/local_examples.py

@@ -0,0 +1,158 @@
+#!/usr/bin/env python3
+"""
+Local Examples Processor
+
+This script processes local examples from the local_examples/ directory
+and integrates them into the existing examples system.
+
+Works like remote examples - each file contains an EXAMPLE: header
+and can be any supported language.
+"""
+
+import os
+import glob
+import shutil
+import logging
+from typing import Dict, Any
+
+from components.example import Example
+from components.util import mkdir_p
+from components.structured_data import load_dict, dump_dict
+
+
+# File extension to language mapping
+EXTENSION_TO_LANGUAGE = {
+    '.py': 'python',
+    '.js': 'node.js',
+    '.go': 'go',
+    '.cs': 'c#',
+    '.java': 'java',
+    '.php': 'php'
+}
+
+# Language to client name mapping (from config.toml clientsExamples)
+LANGUAGE_TO_CLIENT = {
+    'python': 'Python',
+    'node.js': 'Node.js',
+    'go': 'Go',
+    'c#': 'C#',
+    'java': 'Java-Sync',  # Default to sync, could be overridden
+    'php': 'PHP',
+    'redisvl': 'RedisVL'
+}
+
+
+def get_language_from_extension(filename: str) -> str:
+    """Get language from file extension."""
+    _, ext = os.path.splitext(filename)
+    return EXTENSION_TO_LANGUAGE.get(ext.lower())
+
+
+def get_client_name_from_language(language: str) -> str:
+    """Get client name from language."""
+    return LANGUAGE_TO_CLIENT.get(language, language.title())
+
+
+def get_example_id_from_file(path: str) -> str:
+    """Extract example ID from the first line of a file."""
+    try:
+        with open(path, 'r') as f:
+            first_line = f.readline().strip()
+            if 'EXAMPLE:' in first_line:
+                return first_line.split(':')[1].strip()
+    except Exception as e:
+        logging.error(f"Error reading example ID from {path}: {e}")
+    return None
+
+
+def process_local_examples(local_examples_dir: str = 'local_examples',
+                          examples_dir: str = 'examples',
+                          examples_json: str = 'data/examples.json') -> None:
+    """
+    Process local examples and integrate them into the examples system.
+
+    Works like remote examples - each file contains an EXAMPLE: header
+    and can be any supported language.
+
+    Args:
+        local_examples_dir: Directory containing local example source files
+        examples_dir: Target directory for processed examples
+        examples_json: Path to examples.json file
+    """
+
+    if not os.path.exists(local_examples_dir):
+        logging.info(f"Local examples directory {local_examples_dir} not found, skipping")
+        return
+
+    # Load existing examples data
+    examples_data = {}
+    if os.path.exists(examples_json):
+        examples_data = load_dict(examples_json)
+
+    # Process each file in local_examples directory
+    for filename in os.listdir(local_examples_dir):
+        source_file = os.path.join(local_examples_dir, filename)
+
+        if not os.path.isfile(source_file):
+            continue
+
+        # Get language from file extension
+        language = get_language_from_extension(filename)
+        if not language:
+            logging.warning(f"Unknown file extension for: {filename}")
+            continue
+
+        # Get example ID from file content
+        example_id = get_example_id_from_file(source_file)
+        if not example_id:
+            logging.warning(f"No EXAMPLE: header found in {filename}")
+            continue
+
+        logging.info(f"Processing local example: {example_id} ({language})")
+
+        # Create target directory
+        target_dir = os.path.join(examples_dir, example_id)
+        mkdir_p(target_dir)
+
+        # Initialize example data
+        if example_id not in examples_data:
+            examples_data[example_id] = {}
+
+        # Copy file to target directory with local_ prefix
+        base_name = os.path.splitext(filename)[0]
+        ext = os.path.splitext(filename)[1]
+        target_filename = f"local_{base_name}{ext}"
+        target_file = os.path.join(target_dir, target_filename)
+        shutil.copy2(source_file, target_file)
+
+        # Process with Example class
+        example = Example(language, target_file)
+
+        # Get client name
+        client_name = get_client_name_from_language(language)
+
+        # Create metadata
+        example_metadata = {
+            'source': source_file,
+            'language': language,
+            'target': target_file,
+            'highlight': example.highlight,
+            'hidden': example.hidden,
+            'named_steps': example.named_steps,
+            'sourceUrl': None  # Local examples don't have source URLs
+        }
+
+        examples_data[example_id][client_name] = example_metadata
+        logging.info(f"Processed {client_name} example for {example_id}")
+
+    # Save updated examples data
+    dump_dict(examples_json, examples_data)
+    logging.info(f"Updated examples data saved to {examples_json}")
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO, 
+                       format='%(levelname)s: %(message)s')
+    
+    process_local_examples()
+    print("Local examples processing complete")

build/make.py

@@ -1,10 +1,12 @@
 import argparse
 from datetime import datetime
 import logging
+import sys
 import tempfile
 
 from components.component import All
 from components.util import mkdir_p
+from local_examples import process_local_examples
 
 
 def parse_args() -> argparse.Namespace:
@@ -30,20 +32,19 @@ def parse_args() -> argparse.Namespace:
     ARGS = parse_args()
     mkdir_p(ARGS.tempdir)
 
-    # Configure logging BEFORE creating objects
-    log_level = getattr(logging, ARGS.loglevel.upper())
-    logging.basicConfig(
-        level=log_level,
-        format='%(message)s %(filename)s:%(lineno)d - %(funcName)s',
-        force=True  # Force reconfiguration in case logging was already configured
-    )
-
     # Load settings
     ALL = All(ARGS.stack, None, ARGS.__dict__)
 
     # Make the stack
+    logging.basicConfig(
+        level=ARGS.loglevel, format=f'{sys.argv[0]}: %(levelname)s %(asctime)s %(message)s')
     print(f'Applying all configured components"{ALL._name}"')
     start = datetime.now()
     ALL.apply()
+
+    # Process local examples
+    print('Processing local examples')
+    process_local_examples()
+
     total = datetime.now() - start
     print(f'+OK ({total.microseconds / 1000} ms)')

layouts/partials/tabbed-clients-example.html

@@ -21,15 +21,15 @@
     {{ $clientConfig := index $.Site.Params.clientsconfig $client }}
     {{ $language := index $example "language" }}
     {{ $quickstartSlug := index $clientConfig "quickstartSlug" }}
-    
+
     {{ if and ($example) (or (eq $lang "") (strings.Contains $lang $client)) }}
         {{ $examplePath := index $example "target" }}
         {{ $options := printf "linenos=false" }}
-        
+
         {{ if and (ne $step "") (isset $example "named_steps") (isset $example.named_steps $step) }}
             {{ $options = printf "%s,hl_lines=%s" $options (index $example.named_steps $step) }}
         {{ else }}
-            {{ if isset $example "highlight" }}
+            {{ if and (isset $example "highlight") (index $example "highlight") }}
                 {{ $options = printf "%s,hl_lines=%s" $options (delimit (index $example "highlight") " ") }}
             {{ end }}
         {{ end }}