dars-framework 1.9.5__tar.gz → 1.9.7__tar.gz

{dars_framework-1.9.5 → dars_framework-1.9.7}/MANIFEST.in

@@ -5,5 +5,6 @@ recursive-include dars/templates *
 recursive-include dars/docs *
 recursive-include dars *.json
 recursive-include dars *.md
+recursive-include dars/exporters/web/resources *
 exclude LandingPage
 exclude tst

{dars_framework-1.9.5/dars_framework.egg-info → dars_framework-1.9.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dars-framework
-Version: 1.9.5
+Version: 1.9.7
 Summary: Dars is a Full-Stack multiplatform Python UI framework for building modern, interactive web and desktop apps with Python code. Seamlessly integrated with FastAPI, it allows you to build complete applications with Server-Side Rendering (SSR) and reactive SPA capabilities also classic multipage html and desktop apps in a single codebase.
 Author-email: ztamdev <ztadevs@gmail.com>
 Maintainer-email: ztamdev <ztadevs@gmail.com>
@@ -480,7 +480,8 @@ For complete documentation, see the [Backend API Guide](https://ztamdev.github.i
 | `dars init --type desktop`            | Scaffold desktop-capable project (BETA)                           |
 | `dars init --type ssr`                | Scaffold full-stack SSR project (SSR + API)                       |
 | `dars build` (desktop config)         | Build desktop app artifacts (BETA)                                |
-| `dars preview ./my_app_web`           | Preview exported app locally                                      |
+| `dars preview`                        | Preview exported app (auto-detects output)                        |
+| `dars preview --port 9000`            | Preview on a custom port                                          |
 | `dars init my_project`                | Create a new Dars project (also creates dars.config.json)         |
 | `dars init --update`                  | Create/Update dars.config.json in current dir                     |
 | `dars build`                          | Build using dars.config.json (entry/outdir/format)                |
@@ -490,6 +491,8 @@ For complete documentation, see the [Backend API Guide](https://ztamdev.github.i
 | `dars dev`                            | Run the configured entry file with hot preview (app.rTimeCompile) |
 | `dars dev --port 9000`                | Run dev server on a custom port (overrides config)                |
 | `dars dev --backend`                  | Run only the configured backendEntry (FastAPI/SSR backend)        |
+| `dars generate component <name>`      | Scaffold a new FunctionComponent                                  |
+| `dars generate page <name>`           | Scaffold a new page (static or SPA)                               |
 | `dars --help`                         | Show help and all CLI options                                     |
 
 Tip: use `dars doctor` to review optional tooling that can enhance bundling/minification.
@@ -501,6 +504,22 @@ Tip: use `dars doctor` to review optional tooling that can enhance bundling/mini
 - Build with `dars build` to produce desktop artifacts under `dist/`.
 - This feature is in BETA: usable for testing, not yet recommended for production.
 
+### Code Generation
+
+Scaffold new components and pages instantly with automatic project integration.
+
+```bash
+# Generate a new FunctionComponent
+dars generate component MyComponent
+
+# Generate a new Page (Static, SPA or SSR)
+dars generate page About --page-type spa
+dars generate page Dashboard --page-type ssr
+
+# Scaffold and auto-inject into your main.py file
+dars generate page Contact --yes
+```
+
 ---
 
 - Visit dars [official website](https://ztamdev.github.io/Dars-Framework/)
@@ -530,13 +549,17 @@ python my_app.py --port 8088
 
 ---
 
-You can also use the CLI preview command on an exported app:
+You can also use the CLI preview command on an exported app. Starting from v1.9.6, the path is optional and will be automatically detected from your `dars.config.json` (defaults to `./dist`):
 
 ```bash
-dars preview ./my_exported_app
+# Auto-detects output directory and port from config
+dars preview
+
+# Or specify a custom path and port
+dars preview ./my_exported_app -p 8080
 ```
 
-This will start a local server at http://localhost:8000 to view your exported app in the browser.
+This will start a local server at the configured port (defaults to http://localhost:8000) to view your exported app in the browser.
 
 ---
 
@@ -576,7 +599,7 @@ Example default:
 - `utility_styles`: Dictionary defining custom utility classes. Keys are class names, values are lists of utility strings or raw CSS properties.
 - `markdownHighlight`: Auto-inject a client-side syntax highlighter for fenced code blocks in Markdown. Default `true`.
 - `backendEntry`: Python import path for your SSR/backend app (e.g. `"backend.api:app"`). Required when your app uses `RouteType.SSR` routes. Used by `dars dev --backend`.
-- `port`: The port for the development preview server. Default `8000`.
+- `port`: The port for the development preview server. Default `8000`. This port is used by `dars dev`, `python app.py` (rTimeCompile), and `dars preview`.
 
 Validate your config:
 

{dars_framework-1.9.5 → dars_framework-1.9.7}/README.md

@@ -439,7 +439,8 @@ For complete documentation, see the [Backend API Guide](https://ztamdev.github.i
 | `dars init --type desktop`            | Scaffold desktop-capable project (BETA)                           |
 | `dars init --type ssr`                | Scaffold full-stack SSR project (SSR + API)                       |
 | `dars build` (desktop config)         | Build desktop app artifacts (BETA)                                |
-| `dars preview ./my_app_web`           | Preview exported app locally                                      |
+| `dars preview`                        | Preview exported app (auto-detects output)                        |
+| `dars preview --port 9000`            | Preview on a custom port                                          |
 | `dars init my_project`                | Create a new Dars project (also creates dars.config.json)         |
 | `dars init --update`                  | Create/Update dars.config.json in current dir                     |
 | `dars build`                          | Build using dars.config.json (entry/outdir/format)                |
@@ -449,6 +450,8 @@ For complete documentation, see the [Backend API Guide](https://ztamdev.github.i
 | `dars dev`                            | Run the configured entry file with hot preview (app.rTimeCompile) |
 | `dars dev --port 9000`                | Run dev server on a custom port (overrides config)                |
 | `dars dev --backend`                  | Run only the configured backendEntry (FastAPI/SSR backend)        |
+| `dars generate component <name>`      | Scaffold a new FunctionComponent                                  |
+| `dars generate page <name>`           | Scaffold a new page (static or SPA)                               |
 | `dars --help`                         | Show help and all CLI options                                     |
 
 Tip: use `dars doctor` to review optional tooling that can enhance bundling/minification.
@@ -460,6 +463,22 @@ Tip: use `dars doctor` to review optional tooling that can enhance bundling/mini
 - Build with `dars build` to produce desktop artifacts under `dist/`.
 - This feature is in BETA: usable for testing, not yet recommended for production.
 
+### Code Generation
+
+Scaffold new components and pages instantly with automatic project integration.
+
+```bash
+# Generate a new FunctionComponent
+dars generate component MyComponent
+
+# Generate a new Page (Static, SPA or SSR)
+dars generate page About --page-type spa
+dars generate page Dashboard --page-type ssr
+
+# Scaffold and auto-inject into your main.py file
+dars generate page Contact --yes
+```
+
 ---
 
 - Visit dars [official website](https://ztamdev.github.io/Dars-Framework/)
@@ -489,13 +508,17 @@ python my_app.py --port 8088
 
 ---
 
-You can also use the CLI preview command on an exported app:
+You can also use the CLI preview command on an exported app. Starting from v1.9.6, the path is optional and will be automatically detected from your `dars.config.json` (defaults to `./dist`):
 
 ```bash
-dars preview ./my_exported_app
+# Auto-detects output directory and port from config
+dars preview
+
+# Or specify a custom path and port
+dars preview ./my_exported_app -p 8080
 ```
 
-This will start a local server at http://localhost:8000 to view your exported app in the browser.
+This will start a local server at the configured port (defaults to http://localhost:8000) to view your exported app in the browser.
 
 ---
 
@@ -535,7 +558,7 @@ Example default:
 - `utility_styles`: Dictionary defining custom utility classes. Keys are class names, values are lists of utility strings or raw CSS properties.
 - `markdownHighlight`: Auto-inject a client-side syntax highlighter for fenced code blocks in Markdown. Default `true`.
 - `backendEntry`: Python import path for your SSR/backend app (e.g. `"backend.api:app"`). Required when your app uses `RouteType.SSR` routes. Used by `dars dev --backend`.
-- `port`: The port for the development preview server. Default `8000`.
+- `port`: The port for the development preview server. Default `8000`. This port is used by `dars dev`, `python app.py` (rTimeCompile), and `dars preview`.
 
 Validate your config:
 

dars_framework-1.9.7/dars/cli/generate.py

@@ -0,0 +1,288 @@
+import os
+import re
+from rich.console import Console
+from rich.prompt import Prompt, Confirm
+from dars.cli.prompts import select_prompt, confirm_prompt
+
+API_CONFIG_PY_CODE = """import os
+import sys
+
+class DarsEnv:
+    # Set this to "production" when deploying
+    MODE = "development" 
+    
+    DEV = "development"
+    BUILD = "production"
+    
+    @staticmethod
+    def get_env():
+        return DarsEnv.MODE
+
+    @staticmethod
+    def is_dev():
+        return DarsEnv.get_env() == DarsEnv.DEV
+
+    @staticmethod
+    def get_urls():
+        # Configuration for URLs
+        if DarsEnv.is_dev():
+            return {
+                "backend": "http://localhost:3000", # SSR/API Server
+                "frontend": "http://localhost:8000" # Dev Server
+            }
+        return {
+            "backend": "/", # Production: Same origin
+            "frontend": "/"
+        }
+"""
+
+API_PY_CODE = """\"""
+SSR Backend - Dars Framework
+Run with: python -m backend.api
+\"""
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from dars.backend.ssr import create_ssr_app
+import sys
+import os
+from backend.apiConfig import DarsEnv
+
+# Import the Dars app
+import sys
+sys.path.insert(0, '.')
+from main import app as dars_app
+
+
+# Create FastAPI app with SSR support
+app = create_ssr_app(dars_app)
+
+# Enable CORS for local development
+if DarsEnv.is_dev():
+    urls = DarsEnv.get_urls()
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=[urls['frontend'], "http://127.0.0.1:3000"],
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+if __name__ == "__main__":
+    import uvicorn
+    urls = DarsEnv.get_urls()
+    print(" " + "="*60)
+    print("Dars SSR Backend")
+    print("="*60)
+    print(f"Endpoints:")
+    print(f" • {urls['backend']}/              - API info")
+    print(f" • {urls['backend']}/api/ssr/*     - SSR routes")
+    print(f"Frontend: {urls['frontend']}")
+    print("="*60 + " ")
+    
+    uvicorn.run(app, host="127.0.0.1", port=3000)
+"""
+
+console = Console()
+
+def handle_generate(args):
+    gen_type = args.type
+    if not gen_type:
+        gen_type = select_prompt("What do you want to generate?", choices=["component", "page"])
+        
+    name = args.name
+    if not name:
+        while True:
+            name = Prompt.ask(f"Enter the name of the {gen_type}")
+            if name and name.strip():
+                break
+            console.print(f"[red]Error: {gen_type.capitalize()} name cannot be empty.[/red]")
+
+    # Ensure it's a valid python identifier
+    safe_name = re.sub(r'[^a-zA-Z0-9_]', '_', name)
+    # Avoid python keywords or starting with numbers
+    if safe_name and safe_name[0].isdigit():
+        safe_name = "_" + safe_name
+
+    if gen_type == "component":
+        os.makedirs("components", exist_ok=True)
+        file_path = f"components/{name}.py"
+        if os.path.exists(file_path):
+            console.print(f"[red]Error: Component {file_path} already exists.[/red]")
+            return
+            
+        content = f"""from dars.all import *
+
+@FunctionComponent
+def {safe_name}(props):
+    return Container(
+        Text("{name} Component works!")
+    )
+"""
+        with open(file_path, "w") as f:
+            f.write(content)
+        console.print(f"[green]SUCCESS: Component {name} generated successfully at {file_path}[/green]")
+        console.print("[yellow]Note: Remember to import and use it in your main application.[/yellow]")
+        
+    elif gen_type == "page":
+        page_type = args.page_type
+        if not page_type:
+            page_type = select_prompt(f"What type of page is '{name}'?", choices=["static", "spa", "ssr"])
+            
+        os.makedirs("pages", exist_ok=True)
+        file_path = f"pages/{name}.py"
+        if os.path.exists(file_path):
+            console.print(f"[red]Error: Page {file_path} already exists.[/red]")
+            return
+            
+        if page_type == "static":
+            content = f"""from dars.all import *
+
+{safe_name} = Page(
+    Container(
+        Text("{name} Static Page works!")
+    )
+)
+"""
+            import_statement = f"from pages.{name} import {safe_name}"
+            inject_statement = f"app.add_page('{name}', {safe_name})"
+        elif page_type == "spa":
+            content = f"""from dars.all import *
+
+@route("/{name}")
+def {safe_name}():
+    return Page(
+        Container(
+            Text("{name} SPA Page works!")
+        )
+    )
+"""
+            import_statement = f"from pages.{name} import {safe_name}"
+            inject_statement = f"app.add_page('{name}', {safe_name}())"
+        else: # ssr
+            content = f"""from dars.all import *
+
+@route("/{name}", route_type=RouteType.SSR)
+def {safe_name}():
+    return Page(
+        Container(
+            Text("{name} SSR Page works!")
+        )
+    )
+"""
+            import_statement = f"from pages.{name} import {safe_name}"
+            inject_statement = f"app.add_page('{name}', {safe_name}())"
+
+            # Check for backend files
+            if not os.path.exists("backend"):
+                console.print("\n[bold yellow]⚠ WARNING: SSR routes require a backend configuration.[/bold yellow]")
+                console.print("[yellow]It seems your project doesn't have the '/backend' directory required for Dars SSR.[/yellow]")
+                
+                if confirm_prompt("Do you want to automatically scaffold the SSR backend now?"):
+                    os.makedirs("backend", exist_ok=True)
+                    with open("backend/__init__.py", "w") as f: pass
+                    
+                    with open("backend/apiConfig.py", "w") as f:
+                        f.write(API_CONFIG_PY_CODE.strip())
+                    
+                    with open("backend/api.py", "w") as f:
+                        f.write(API_PY_CODE.strip())
+                    
+                    # Update config
+                    if os.path.exists("dars.config.json"):
+                        import json
+                        try:
+                            with open("dars.config.json", "r") as f:
+                                config = json.load(f)
+                            if "backendEntry" not in config:
+                                config["backendEntry"] = "backend.api:app"
+                                with open("dars.config.json", "w") as f:
+                                    json.dump(config, f, indent=2)
+                                console.print("[green]SUCCESS: Updated dars.config.json with backendEntry.[/green]")
+                        except:
+                            pass
+                    
+                    console.print("[green]SUCCESS: SSR Backend scaffolded at /backend[/green]")
+                    console.print("[yellow]Note: Remember to run 'dars dev --backend' to start the SSR server.[/yellow]")
+            
+        with open(file_path, "w") as f:
+            f.write(content)
+        console.print(f"[green]SUCCESS: Page {name} generated successfully at {file_path}[/green]")
+        
+        # Inject to main.py
+        auto_inject = args.yes
+        if not auto_inject:
+            auto_inject = confirm_prompt(f"Do you want to automatically add this page to your main app file?")
+            
+        if auto_inject:
+            entry_file = "main.py"
+            if os.path.exists("dars.config.json"):
+                import json
+                try:
+                    with open("dars.config.json", "r") as f:
+                        config = json.load(f)
+                    entry_file = config.get("entry", "main.py")
+                except:
+                    pass
+                    
+            if not os.path.exists(entry_file):
+                if os.path.exists("index.py"):
+                    entry_file = "index.py"
+                else:
+                    console.print(f"[red]Error: Could not find main application file ({entry_file}). Please add the page manually.[/red]")
+                    console.print(f"[cyan]{import_statement}[/cyan]")
+                    console.print(f"[cyan]{inject_statement}[/cyan]")
+                    return
+            
+            try:
+                with open(entry_file, "r") as f:
+                    lines = f.readlines()
+                
+                content_all = "".join(lines)
+                
+                # Default app variable name might be different
+                app_var_match = re.search(r'([a-zA-Z0-9_]+)\s*=\s*App\(', content_all)
+                app_var = app_var_match.group(1) if app_var_match else "app"
+                
+                if app_var != "app":
+                    inject_statement = inject_statement.replace("app.", f"{app_var}.")
+
+                # 1. Inject Import
+                last_import_line = -1
+                for i, line in enumerate(lines):
+                    if line.strip().startswith(("import ", "from ")):
+                        last_import_line = i
+                
+                if last_import_line != -1:
+                    lines.insert(last_import_line + 1, import_statement + "\n")
+                else:
+                    lines.insert(0, import_statement + "\n")
+                    
+                # 2. Inject add_page
+                last_add_page_line = -1
+                for i, line in enumerate(lines):
+                    if f"{app_var}.add_page(" in line:
+                        last_add_page_line = i
+                
+                if last_add_page_line != -1:
+                    lines.insert(last_add_page_line + 1, inject_statement + "\n")
+                else:
+                    # Fallback: after app = App(...)
+                    app_def_line = -1
+                    for i, line in enumerate(lines):
+                        if f"{app_var} = App(" in line:
+                            app_def_line = i
+                            break
+                    if app_def_line != -1:
+                        lines.insert(app_def_line + 1, "\n" + inject_statement + "\n")
+                    else:
+                        lines.append("\n" + inject_statement + "\n")
+                
+                with open(entry_file, "w") as f:
+                    f.writelines(lines)
+                
+                console.print(f"[green]SUCCESS: Successfully added {name} to {entry_file}[/green]")
+            except Exception as e:
+                console.print(f"[red]Failed to auto-inject: {str(e)}[/red]")
+                console.print(f"[yellow]Please add manually:[/yellow]")
+                console.print(f"[cyan]{import_statement}[/cyan]")
+                console.print(f"[cyan]{inject_statement}[/cyan]")