skeleton-framework 0.1.1__tar.gz → 0.1.3__tar.gz

{skeleton_framework-0.1.1 → skeleton_framework-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skeleton-framework
-Version: 0.1.1
+Version: 0.1.3
 Summary: A full-stack app framework: Python orchestration + FastAPI + WebPack frontend.
 Author-email: lambdadotjoburg <lambdadotjoburg@gmail.com>
 License-Expression: LicenseRef-Proprietary
@@ -68,9 +68,9 @@ Install Skeleton from PyPI:
 python -m pip install skeleton-framework
 ```
 
-![client-venv](docs/gif/client/00_client_venv.gif)
+![client-venv](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/00_client_venv.gif)
 
-![client-pip-install-skeleton-framework](docs/gif/client/01_client_pip_install_skeleton_framework.gif)
+![client-pip-install-skeleton-framework](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/01_client_pip_install_skeleton_framework.gif)
 
 The installed Python distribution provides the `skeleton` command.
 
@@ -89,7 +89,7 @@ Configure the project, initialize its files, and install its dependencies:
 skeleton --quickstart
 ```
 
-![client-venv](docs/gif/client/04_client_quickstart.gif)
+![client-venv](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/04_client_quickstart.gif)
 
 This combines the configuration, initialization, and installation stages.
 
@@ -107,11 +107,28 @@ Skeleton also exposes the individual stages when you want to configure the appli
 
 ### 1. Generate configuration
 
+Generate the project configuration files before initialization.
+Skeleton supports React and SolidJS frontend profiles.
+
+Select the desired frontend framework using the `--config` command:
+
+```bash
+skeleton --config react
+```
+
+Or select SolidJS:
+
+```bash
+skeleton --config solid
+```
+
+If no framework is specified, React is selected by default:
+
 ```bash
 skeleton --config
 ```
 
-![client-config-init](docs/gif/client/02_client_config_init.gif)
+![client-config-init](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/02_client_config_init.gif)
 
 This generates the project's configuration files:
 
@@ -129,7 +146,7 @@ Review and customize these files before initialization if necessary.
 skeleton --init
 ```
 
-![client-config-init](docs/gif/client/02_client_config_init.gif)
+![client-config-init](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/02_client_config_init.gif)
 
 Initialization creates the configured frontend and backend structure from the framework's templates, prepares dependency manifests, and configures the local frontend tooling packages.
 
@@ -139,7 +156,7 @@ Initialization creates the configured frontend and backend structure from the fr
 skeleton --install
 ```
 
-![client-install](docs/gif/client/03_client_install.gif)
+![client-install](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/03_client_install.gif)
 
 This installs frontend dependencies using npm and backend Python dependencies into the backend's `.venv` environment.
 
@@ -155,7 +172,7 @@ You can also explicitly select services:
 skeleton --start frontend gateway --open
 ```
 
-![client-start](docs/gif/client/05_client_start.gif)
+![client-start](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/05_client_start.gif)
 
 The selected services and runtime options determine which processes are started.
 
@@ -321,9 +338,9 @@ These commands are intended for contributors working in the Skeleton framework s
 
 To get the skeleton framework onto your local machine for development, clone:
 
-[https://github.com/lambdadotjoburg/skeleton.git](https://github.com/lambdadotjoburg/skeleton.git)
+[Skeleton Github repository](https://github.com/lambdadotjoburg/skeleton.git)
 
-![dev-clone](docs/gif/dev/00_dev_clone.gif)
+![dev-clone](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/dev/00_dev_clone.gif)
 
 ### Initialize the framework development environment
 
@@ -331,7 +348,7 @@ To get the skeleton framework onto your local machine for development, clone:
 python run.py --bootstrap
 ```
 
-![dev-bootstrap](docs/gif/dev/01_dev_bootstrap.gif)
+![dev-bootstrap](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/dev/01_dev_bootstrap.gif)
 
 This combines `--init` and `--install` to initialize and install the framework's development environment.
 
@@ -341,7 +358,7 @@ This combines `--init` and `--install` to initialize and install the framework's
 python run.py --dist
 ```
 
-![dev-dist](docs/gif/dev/02_dev_dist.gif)
+![dev-dist](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/dev/02_dev_dist.gif)
 
 This combines `--pack` and `--build`.
 
@@ -400,7 +417,7 @@ source .venv/bin/activate
 From the test project directory:
 
 ```bash
-python -m pip install --force-reinstall ../framework/dist/skeleton_framework-0.1.0-py3-none-any.whl
+python -m pip install --force-reinstall ../framework/dist/skeleton_framework-0.1.3-py3-none-any.whl
 ```
 
 Adjust the relative path, wheel filename & version to match your framework checkout and build output.

{skeleton_framework-0.1.1 → skeleton_framework-0.1.3}/README.md

@@ -50,9 +50,9 @@ Install Skeleton from PyPI:
 python -m pip install skeleton-framework
 ```
 
-![client-venv](docs/gif/client/00_client_venv.gif)
+![client-venv](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/00_client_venv.gif)
 
-![client-pip-install-skeleton-framework](docs/gif/client/01_client_pip_install_skeleton_framework.gif)
+![client-pip-install-skeleton-framework](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/01_client_pip_install_skeleton_framework.gif)
 
 The installed Python distribution provides the `skeleton` command.
 
@@ -71,7 +71,7 @@ Configure the project, initialize its files, and install its dependencies:
 skeleton --quickstart
 ```
 
-![client-venv](docs/gif/client/04_client_quickstart.gif)
+![client-venv](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/04_client_quickstart.gif)
 
 This combines the configuration, initialization, and installation stages.
 
@@ -89,11 +89,28 @@ Skeleton also exposes the individual stages when you want to configure the appli
 
 ### 1. Generate configuration
 
+Generate the project configuration files before initialization.
+Skeleton supports React and SolidJS frontend profiles.
+
+Select the desired frontend framework using the `--config` command:
+
+```bash
+skeleton --config react
+```
+
+Or select SolidJS:
+
+```bash
+skeleton --config solid
+```
+
+If no framework is specified, React is selected by default:
+
 ```bash
 skeleton --config
 ```
 
-![client-config-init](docs/gif/client/02_client_config_init.gif)
+![client-config-init](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/02_client_config_init.gif)
 
 This generates the project's configuration files:
 
@@ -111,7 +128,7 @@ Review and customize these files before initialization if necessary.
 skeleton --init
 ```
 
-![client-config-init](docs/gif/client/02_client_config_init.gif)
+![client-config-init](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/02_client_config_init.gif)
 
 Initialization creates the configured frontend and backend structure from the framework's templates, prepares dependency manifests, and configures the local frontend tooling packages.
 
@@ -121,7 +138,7 @@ Initialization creates the configured frontend and backend structure from the fr
 skeleton --install
 ```
 
-![client-install](docs/gif/client/03_client_install.gif)
+![client-install](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/03_client_install.gif)
 
 This installs frontend dependencies using npm and backend Python dependencies into the backend's `.venv` environment.
 
@@ -137,7 +154,7 @@ You can also explicitly select services:
 skeleton --start frontend gateway --open
 ```
 
-![client-start](docs/gif/client/05_client_start.gif)
+![client-start](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/client/05_client_start.gif)
 
 The selected services and runtime options determine which processes are started.
 
@@ -303,9 +320,9 @@ These commands are intended for contributors working in the Skeleton framework s
 
 To get the skeleton framework onto your local machine for development, clone:
 
-[https://github.com/lambdadotjoburg/skeleton.git](https://github.com/lambdadotjoburg/skeleton.git)
+[Skeleton Github repository](https://github.com/lambdadotjoburg/skeleton.git)
 
-![dev-clone](docs/gif/dev/00_dev_clone.gif)
+![dev-clone](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/dev/00_dev_clone.gif)
 
 ### Initialize the framework development environment
 
@@ -313,7 +330,7 @@ To get the skeleton framework onto your local machine for development, clone:
 python run.py --bootstrap
 ```
 
-![dev-bootstrap](docs/gif/dev/01_dev_bootstrap.gif)
+![dev-bootstrap](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/dev/01_dev_bootstrap.gif)
 
 This combines `--init` and `--install` to initialize and install the framework's development environment.
 
@@ -323,7 +340,7 @@ This combines `--init` and `--install` to initialize and install the framework's
 python run.py --dist
 ```
 
-![dev-dist](docs/gif/dev/02_dev_dist.gif)
+![dev-dist](https://raw.githubusercontent.com/lambdadotjoburg/skeleton/main/docs/gif/dev/02_dev_dist.gif)
 
 This combines `--pack` and `--build`.
 
@@ -382,7 +399,7 @@ source .venv/bin/activate
 From the test project directory:
 
 ```bash
-python -m pip install --force-reinstall ../framework/dist/skeleton_framework-0.1.0-py3-none-any.whl
+python -m pip install --force-reinstall ../framework/dist/skeleton_framework-0.1.3-py3-none-any.whl
 ```
 
 Adjust the relative path, wheel filename & version to match your framework checkout and build output.

{skeleton_framework-0.1.1 → skeleton_framework-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "skeleton-framework"
-version = "0.1.1"
+version = "0.1.3"
 description = "A full-stack app framework: Python orchestration + FastAPI + WebPack frontend."
 readme = "README.md"
 requires-python = ">=3.11"

{skeleton_framework-0.1.1 → skeleton_framework-0.1.3}/skeleton/cli.py

@@ -27,10 +27,15 @@ from pathlib import Path
 # ============================================================
 
 # skeleton --config
+# skeleton --config react
+# skeleton --config solid
+# skeleton --config vue
+
 # skeleton --init
 # skeleton --install
 # skeleton --start
 # skeleton --start frontend gateway --open
+
 # skeleton --quickstart
 
 # skeleton --serve

{skeleton_framework-0.1.1 → skeleton_framework-0.1.3}/skeleton/client.py

@@ -176,11 +176,13 @@ def main(
 
         from skeleton.infrastructure.bootstrap.src.config import config
 
+        framework = args[1] if len(args) > 1 else None
+
         config(
             framework_root=framework_root,
             project_root=project_root,
+            framework=framework,
         )
-
         return 0
 
     if command == "--init":

{skeleton_framework-0.1.1 → skeleton_framework-0.1.3}/skeleton/infrastructure/bootstrap/src/commands/client/init.py

@@ -362,6 +362,7 @@ def init(
         target=project_root,
         frontend=layout["frontend"],
         backend=layout["backend"],
+        framework_root=framework_root,
     )
 
     # ---------------------------------------------------------

skeleton_framework-0.1.3/skeleton/infrastructure/bootstrap/src/config.py

@@ -0,0 +1,153 @@
+import json, shutil
+from pathlib import Path
+
+SUPPORTED_FRAMEWORKS = {"react", "solid"} # add vue
+
+def read_json(path: Path) -> dict:
+    with path.open("r", encoding="utf-8") as file:
+        data = json.load(file)
+
+    if not isinstance(data, dict):
+        raise ValueError(f"Expected a JSON object: {path}")
+
+    return data
+
+
+def write_json(path: Path, data: dict) -> None:
+    with path.open("w", encoding="utf-8") as file:
+        json.dump(data, file, indent=4)
+        file.write("\n")
+
+
+def config(
+    framework_root: Path,
+    project_root: Path,
+    framework: str | None = None,
+) -> None:
+
+    templates_root = (
+        framework_root
+        / "skeleton"
+        / "infrastructure"
+        / "bootstrap"
+        / "src"
+        / "templates"
+    )
+
+    config_templates = templates_root / "config"
+    profiles_root = templates_root / "profiles"
+
+    if not config_templates.is_dir():
+        raise FileNotFoundError(
+            f"Configuration templates not found: {config_templates}"
+        )
+
+    if not profiles_root.is_dir():
+        raise FileNotFoundError(
+            f"Framework profiles not found: {profiles_root}"
+        )
+
+    if framework is not None:
+        framework = framework.strip().lower()
+
+        if framework not in SUPPORTED_FRAMEWORKS:
+            supported = ", ".join(sorted(SUPPORTED_FRAMEWORKS))
+            raise ValueError(
+                f"Unsupported frontend framework: {framework!r}. "
+                f"Choose one of: {supported}"
+            )
+
+    project_root = project_root.resolve()
+    project_root.mkdir(parents=True, exist_ok=True)
+
+    # ---------------------------------------------------------
+    # Copy shared project configuration.
+    # ---------------------------------------------------------
+
+    for template in config_templates.iterdir():
+        destination = project_root / template.name
+
+        if destination.exists():
+            print(f"INFO: Preserving existing file: {destination}")
+            continue
+
+        if template.is_dir():
+            shutil.copytree(template, destination)
+        else:
+            shutil.copy2(template, destination)
+
+        print(f"INFO: Created: {destination}")
+
+    # ---------------------------------------------------------
+    # Determine the selected framework.
+    # ---------------------------------------------------------
+
+    frontend_config_path = project_root / "skeleton-config.json"
+    dependencies_path = project_root / "skeleton-dependencies.json"
+
+    if framework is not None:
+        selected_framework = framework
+
+    elif frontend_config_path.is_file():
+        existing_config = read_json(frontend_config_path)
+        selected_framework = existing_config.get("framework", "react")
+
+        if (
+            not isinstance(selected_framework, str)
+            or selected_framework not in SUPPORTED_FRAMEWORKS
+        ):
+            raise ValueError(
+                f"Invalid framework in {frontend_config_path}: "
+                f"{selected_framework!r}"
+            )
+
+    else:
+        selected_framework = "react"
+
+    profile = profiles_root / selected_framework
+
+    if not profile.is_dir():
+        raise FileNotFoundError(
+            f"Framework profile not found: {profile}"
+        )
+
+    profile_config_path = profile / "skeleton-config.json"
+    profile_dependencies_path = profile / "skeleton-dependencies.json"
+
+    for path in (profile_config_path, profile_dependencies_path):
+        if not path.is_file():
+            raise FileNotFoundError(
+                f"Required framework profile file not found: {path}"
+            )
+
+    # Read and validate both profile files before writing either.
+    frontend_config = read_json(profile_config_path)
+    dependencies = read_json(profile_dependencies_path)
+
+    # Ensure the selected profile identifies itself correctly.
+    frontend_config["framework"] = selected_framework
+
+    # ---------------------------------------------------------
+    # Generate the root-level framework configuration.
+    # ---------------------------------------------------------
+
+    # Explicit selection resets both framework-managed files
+    # to the chosen profile defaults.
+    #
+    # Without an explicit selection, preserve existing files
+    # and create only files that are missing.
+
+    if framework is not None or not frontend_config_path.exists():
+        write_json(frontend_config_path, frontend_config)
+        print(f"INFO: Created/updated: {frontend_config_path}")
+    else:
+        print(f"INFO: Preserving existing file: {frontend_config_path}")
+
+    if framework is not None or not dependencies_path.exists():
+        write_json(dependencies_path, dependencies)
+        print(f"INFO: Created/updated: {dependencies_path}")
+    else:
+        print(f"INFO: Preserving existing file: {dependencies_path}")
+
+    print(f"INFO: Selected frontend framework: {selected_framework}")
+    print("INFO: Configuration complete")