shipit-cli 0.11.3__tar.gz → 0.13.0__tar.gz

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shipit-cli
-Version: 0.11.3
+Version: 0.13.0
 Summary: Shipit CLI is the best way to build, serve and deploy your projects anywhere.
 Project-URL: homepage, https://wasmer.io
 Project-URL: repository, https://github.com/wasmerio/shipit

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shipit-cli"
-version = "0.11.3"
+version = "0.13.0"
 description = "Shipit CLI is the best way to build, serve and deploy your projects anywhere."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -45,3 +45,6 @@ dev-dependencies = [
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
+
+[tool.uv.workspace]
+exclude = ["examples/*"]

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/assets/wordpress/install.sh

@@ -4,6 +4,13 @@ IFS=$'\n\t'
 export COLUMNS=80  # Prevent WP-CLI from asking for TTY size
 export PAGER="cat"
 
+WP_ADMIN_EMAIL=${WP_ADMIN_EMAIL:-"admin@example.com"}
+WP_ADMIN_USERNAME=${WP_ADMIN_USERNAME:-"admin"}
+WP_ADMIN_PASSWORD=${WP_ADMIN_PASSWORD:-"admin"}
+WP_LOCALE=${WP_LOCALE:-"en_US"}
+WP_SITEURL=${WP_SITEURL:-"http://localhost"}
+WP_SITE_TITLE=${WP_SITE_TITLE:-"WordPress"}
+
 wp() {
   php /opt/assets/wp-cli.phar --allow-root --path=/app "$@"
 }

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/cli.py

@@ -1,4 +1,5 @@
-import logging
+import tempfile
+import hashlib
 import requests
 import os
 import shlex
@@ -1138,6 +1139,28 @@ class WasmerBuilder:
             *(extra_args or []), _out=write_stdout, _err=write_stderr, _env=os.environ
         )
 
+    def deploy_config(self, config_path: Path) -> None:
+        package_webc_path = self.wasmer_dir_path / "package.webc"
+        app_yaml_path = self.wasmer_dir_path / "app.yaml"
+        package_webc_path.parent.mkdir(parents=True, exist_ok=True)
+        self.run_command(
+            self.bin,
+            ["package", "build", self.wasmer_dir_path, "--out", package_webc_path],
+        )
+        config_path.write_text(
+            json.dumps(
+                {
+                    "app_yaml_path": str(app_yaml_path.absolute()),
+                    "package_webc_path": str(package_webc_path.absolute()),
+                    "package_webc_size": package_webc_path.stat().st_size,
+                    "package_webc_sha256": hashlib.sha256(
+                        package_webc_path.read_bytes()
+                    ).hexdigest(),
+                }
+            )
+        )
+        console.print(f"\n[bold]Saved deploy config to {config_path}[/bold]")
+
     def deploy(
         self, app_owner: Optional[str] = None, app_name: Optional[str] = None
     ) -> str:
@@ -1354,12 +1377,7 @@ class Ctx:
         }
 
 
-def evaluate_shipit(path: Path, builder: Builder) -> Tuple[Ctx, Serve]:
-    shipit_file = path / "Shipit"
-    if not shipit_file.exists():
-        raise FileNotFoundError(
-            f"Shipit file not found at {shipit_file}. Run `shipit generate {path}` to create it."
-        )
+def evaluate_shipit(shipit_file: Path, builder: Builder) -> Tuple[Ctx, Serve]:
     source = shipit_file.read_text()
     ctx = Ctx(builder)
     glb = sl.Globals.standard()
@@ -1447,14 +1465,22 @@ def auto(
         None,
         help="Regenerate the Shipit file.",
     ),
-    regenerate_path: Optional[Path] = typer.Option(
+    shipit_path: Optional[Path] = typer.Option(
         None,
-        help="Regenerate the Shipit file onto the provided path.",
+        help="The path to the Shipit file (defaults to Shipit in the provided path).",
+    ),
+    temp_shipit: bool = typer.Option(
+        False,
+        help="Use a temporary Shipit file in the system temporary directory.",
     ),
     wasmer_deploy: Optional[bool] = typer.Option(
         False,
         help="Deploy the project to Wasmer.",
     ),
+    wasmer_deploy_config: Optional[Path] = typer.Option(
+        None,
+        help="Save the output of the Wasmer build to a json file",
+    ),
     wasmer_token: Optional[str] = typer.Option(
         None,
         help="Wasmer token.",
@@ -1499,10 +1525,24 @@ def auto(
     if not path.exists():
         raise Exception(f"The path {path} does not exist")
 
-    if not (path / "Shipit").exists() or regenerate or regenerate_path is not None:
+    if temp_shipit:
+        if shipit_path:
+            raise Exception("Cannot use both --temp-shipit and --shipit-path")
+        temp_shipit = tempfile.NamedTemporaryFile(
+            delete=False, delete_on_close=False, prefix="Shipit"
+        )
+        shipit_path = Path(temp_shipit.name)
+
+    if not regenerate:
+        if shipit_path and not shipit_path.exists():
+            regenerate = True
+        elif not (path / "Shipit").exists():
+            regenerate = True
+
+    if regenerate:
         generate(
             path,
-            out=regenerate_path,
+            out=shipit_path,
             use_procfile=use_procfile,
             install_command=install_command,
             build_command=build_command,
@@ -1512,6 +1552,7 @@ def auto(
 
     build(
         path,
+        shipit_path=shipit_path,
         wasmer=(wasmer or wasmer_deploy),
         docker=docker,
         docker_client=docker_client,
@@ -1522,7 +1563,7 @@ def auto(
         skip_prepare=skip_prepare,
         env_name=env_name,
     )
-    if start or wasmer_deploy:
+    if start or wasmer_deploy or wasmer_deploy_config:
         serve(
             path,
             wasmer=wasmer,
@@ -1535,6 +1576,7 @@ def auto(
             wasmer_deploy=wasmer_deploy,
             wasmer_app_owner=wasmer_app_owner,
             wasmer_app_name=wasmer_app_name,
+            wasmer_deploy_config=wasmer_deploy_config,
         )
     # deploy(path)
 
@@ -1548,6 +1590,10 @@ def generate(
     ),
     out: Optional[Path] = typer.Option(
         None,
+        "-o",
+        "--out",
+        "--output",
+        "--shipit-path",
         help="Output path (defaults to the Shipit file in the provided path).",
     ),
     use_procfile: bool = typer.Option(
@@ -1672,6 +1718,10 @@ def serve(
         None,
         help="Name of the Wasmer app.",
     ),
+    wasmer_deploy_config: Optional[Path] = typer.Option(
+        None,
+        help="Save the output of the Wasmer build to a json file",
+    ),
 ) -> None:
     if not path.exists():
         raise Exception(f"The path {path} does not exist")
@@ -1681,18 +1731,17 @@ def serve(
         builder = DockerBuilder(path, docker_client)
     else:
         builder = LocalBuilder(path)
-    if wasmer or wasmer_deploy:
+    if wasmer or wasmer_deploy or wasmer_deploy_config:
         builder = WasmerBuilder(
             builder, path, registry=wasmer_registry, token=wasmer_token, bin=wasmer_bin
         )
-    if start:
-        builder.run_serve_command("start")
 
-    if wasmer_deploy:
-        if isinstance(builder, WasmerBuilder):
-            builder.deploy(app_owner=wasmer_app_owner, app_name=wasmer_app_name)
-        else:
-            raise Exception("Wasmer deploy is only supported for Wasmer builders")
+    if wasmer_deploy_config:
+        builder.deploy_config(wasmer_deploy_config)
+    elif wasmer_deploy:
+        builder.deploy(app_owner=wasmer_app_owner, app_name=wasmer_app_name)
+    elif start:
+        builder.run_serve_command("start")
 
 
 @app.command(name="plan")
@@ -1702,6 +1751,25 @@ def plan(
         help="Project path (defaults to current directory).",
         show_default=False,
     ),
+    out: Optional[Path] = typer.Option(
+        None,
+        "-o",
+        "--out",
+        "--output",
+        help="Output path of the plan (defaults to stdout).",
+    ),
+    temp_shipit: bool = typer.Option(
+        False,
+        help="Use a temporary Shipit file in the system temporary directory.",
+    ),
+    regenerate: bool = typer.Option(
+        False,
+        help="Regenerate the Shipit file.",
+    ),
+    shipit_path: Optional[Path] = typer.Option(
+        None,
+        help="The path to the Shipit file (defaults to Shipit in the provided path).",
+    ),
     wasmer: bool = typer.Option(
         False,
         help="Use Wasmer to evaluate the project.",
@@ -1726,10 +1794,55 @@ def plan(
         None,
         help="Use a specific Docker client (such as depot, podman, etc.)",
     ),
+    use_procfile: bool = typer.Option(
+        True,
+        help="Use the Procfile to generate the default custom commands (install, build, start, after_deploy).",
+    ),
+    install_command: Optional[str] = typer.Option(
+        None,
+        help="The install command to use (overwrites the default)",
+    ),
+    build_command: Optional[str] = typer.Option(
+        None,
+        help="The build command to use (overwrites the default)",
+    ),
+    start_command: Optional[str] = typer.Option(
+        None,
+        help="The start command to use (overwrites the default)",
+    ),
+    use_provider: Optional[str] = typer.Option(
+        None,
+        help="Use a specific provider to build the project.",
+    ),
 ) -> None:
     if not path.exists():
         raise Exception(f"The path {path} does not exist")
 
+    if temp_shipit:
+        if shipit_path:
+            raise Exception("Cannot use both --temp-shipit and --shipit-path")
+        temp_shipit = tempfile.NamedTemporaryFile(
+            delete=False, delete_on_close=False, prefix="Shipit"
+        )
+        shipit_path = Path(temp_shipit.name)
+
+    if not regenerate:
+        if shipit_path and not shipit_path.exists():
+            regenerate = True
+        elif not (path / "Shipit").exists():
+            regenerate = True
+
+    if regenerate:
+        generate(
+            path,
+            out=shipit_path,
+            use_procfile=use_procfile,
+            install_command=install_command,
+            build_command=build_command,
+            start_command=start_command,
+            use_provider=use_provider,
+        )
+
     custom_commands = CustomCommands()
     procfile_path = path / "Procfile"
     if procfile_path.exists():
@@ -1739,6 +1852,8 @@ def plan(
         except Exception:
             pass
 
+    shipit_file = get_shipit_path(path, shipit_path)
+
     builder: Builder
     if docker or docker_client:
         builder = DockerBuilder(path, docker_client)
@@ -1749,7 +1864,7 @@ def plan(
             builder, path, registry=wasmer_registry, token=wasmer_token, bin=wasmer_bin
         )
 
-    ctx, serve = evaluate_shipit(path, builder)
+    ctx, serve = evaluate_shipit(shipit_file, builder)
     metadata_commands: Dict[str, Optional[str]] = {
         "start": serve.commands.get("start"),
         "after_deploy": serve.commands.get("after_deploy"),
@@ -1789,7 +1904,14 @@ def plan(
             for svc in (serve.services or [])
         ],
     }
-    print(json.dumps(plan_output, indent=4))
+    json_output = json.dumps(plan_output, indent=4)
+    if out:
+        out.parent.mkdir(parents=True, exist_ok=True)
+        out.write_text(json_output)
+        console.print(f"[bold]Plan saved to {out.absolute()}[/bold]")
+    else:
+        sys.stdout.write(json_output + "\n")
+        sys.stdout.flush()
 
 
 @app.command(name="build")
@@ -1799,6 +1921,10 @@ def build(
         help="Project path (defaults to current directory).",
         show_default=False,
     ),
+    shipit_path: Optional[Path] = typer.Option(
+        None,
+        help="The path to the Shipit file (defaults to Shipit in the provided path).",
+    ),
     wasmer: bool = typer.Option(
         False,
         help="Use Wasmer to build and serve the project.",
@@ -1839,6 +1965,8 @@ def build(
     if not path.exists():
         raise Exception(f"The path {path} does not exist")
 
+    shipit_file = get_shipit_path(path, shipit_path)
+
     builder: Builder
     if docker or docker_client:
         builder = DockerBuilder(path, docker_client)
@@ -1849,7 +1977,7 @@ def build(
             builder, path, registry=wasmer_registry, token=wasmer_token, bin=wasmer_bin
         )
 
-    ctx, serve = evaluate_shipit(path, builder)
+    ctx, serve = evaluate_shipit(shipit_file, builder)
     env = {
         "PATH": "",
         "COLORTERM": os.environ.get("COLORTERM", ""),
@@ -1868,6 +1996,7 @@ def build(
             )
             return build(
                 path,
+                shipit_path=shipit_path,
                 wasmer=wasmer,
                 skip_prepare=skip_prepare,
                 wasmer_bin=wasmer_bin,
@@ -1898,6 +2027,20 @@ def build(
         builder.prepare(env, serve.prepare)
 
 
+def get_shipit_path(path: Path, shipit_path: Optional[Path] = None) -> Path:
+    if shipit_path is None:
+        shipit_path = path / "Shipit"
+        if not shipit_path.exists():
+            raise Exception(
+                f"Shipit file not found at {shipit_path}. Run `shipit generate {path}` to create it."
+            )
+    elif not shipit_path.exists():
+        raise Exception(
+            f"Shipit file not found at {shipit_path}. Run `shipit generate {path} -o {shipit_path}` to create it."
+        )
+    return shipit_path
+
+
 def main() -> None:
     args = sys.argv[1:]
     # If no subcommand or first token looks like option/path → default to "build"
@@ -1909,7 +2052,8 @@ def main() -> None:
         app()
     except Exception as e:
         console.print(f"[bold red]{type(e).__name__}[/bold red]: {e}")
-        # raise e
+        if os.environ.get("SHIPIT_DEBUG", "false").lower() in ["1", "true", "yes", "y"]:
+            raise e
 
 
 if __name__ == "__main__":

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/generator.py

@@ -95,7 +95,7 @@ def generate_shipit(path: Path, custom_commands: CustomCommands, use_provider: O
     # Collect parts
     plan = ProviderPlan(
         serve_name=provider.serve_name(),
-        provider=provider.provider_kind(),
+        provider=provider.name(),
         platform=provider.platform(),
         mounts=provider.mounts(),
         volumes=provider.volumes(),

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/base.py

@@ -28,7 +28,6 @@ class Provider(Protocol):
     def initialize(self) -> None: ...
     # Structured plan steps (no path args; use self.path)
     def serve_name(self) -> str: ...
-    def provider_kind(self) -> str: ...
     def platform(self) -> Optional[str]: ...
     def dependencies(self) -> list["DependencySpec"]: ...
     def declarations(self) -> Optional[str]: ...

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/hugo.py

@@ -27,9 +27,6 @@ class HugoProvider(StaticFileProvider):
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "staticsite"
-
     def platform(self) -> Optional[str]:
         return "hugo"
 

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/laravel.py

@@ -36,9 +36,6 @@ class LaravelProvider:
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "php"
-
     def platform(self) -> Optional[str]:
         return "laravel"
 

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/mkdocs.py

@@ -40,11 +40,8 @@ class MkdocsProvider(StaticFileProvider):
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "mkdocs-site"
-
     def platform(self) -> Optional[str]:
-        return "mkdocs"
+        return None
 
     def dependencies(self) -> list[DependencySpec]:
         return [

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/node_static.py

@@ -231,9 +231,6 @@ class NodeStaticProvider(StaticFileProvider):
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "staticsite"
-
     def platform(self) -> Optional[str]:
         return self.static_generator.value if self.static_generator else None
 

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/php.py

@@ -52,9 +52,6 @@ class PhpProvider:
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "php"
-
     def platform(self) -> Optional[str]:
         return None
 

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/python.py

@@ -226,9 +226,6 @@ class PythonProvider:
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "python"
-
     def platform(self) -> Optional[str]:
         return self.framework.value if self.framework else None
 
@@ -327,8 +324,8 @@ class PythonProvider:
         elif has_requirements or extra_deps:
             steps += [
                 'env(UV_PROJECT_ENVIRONMENT=local_venv["build"] if cross_platform else venv["build"])',
-                'run(f"uv init --no-workspace", inputs=[], outputs=["uv.lock"], group="install")',
-                'copy(".", ".")' if self.install_requires_all_files else None,
+                'run(f"uv init", inputs=[], outputs=["uv.lock"], group="install")',
+                'copy(".", ".", ignore=[".venv", ".git", "__pycache__"])' if self.install_requires_all_files else None,
             ]
             if has_requirements:
                 steps += [
@@ -347,7 +344,7 @@ class PythonProvider:
 
         steps += [
             'path((local_venv["build"] if cross_platform else venv["build"]) + "/bin")',
-            'copy(".", ".", ignore=[".venv", ".git", "__pycache__"])',
+            'copy(".", ".", ignore=[".venv", ".git", "__pycache__"])' if not self.install_requires_all_files else None,
         ]
         if self.framework == PythonFramework.MCP:
             steps += [

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/staticfile.py

@@ -58,9 +58,6 @@ class StaticFileProvider:
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "staticfile"
-
     def platform(self) -> Optional[str]:
         return None
 

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/src/shipit/providers/wordpress.py

@@ -43,11 +43,8 @@ class WordPressProvider(PhpProvider):
     def serve_name(self) -> str:
         return self.path.name
 
-    def provider_kind(self) -> str:
-        return "php"
-
     def platform(self) -> Optional[str]:
-        return "wordpress"
+        return None
 
     def dependencies(self) -> list[DependencySpec]:
         return [

shipit_cli-0.13.0/src/shipit/version.py

@@ -0,0 +1,5 @@
+__all__ = ["version", "version_info"]
+
+
+version = "0.13.0"
+version_info = (0, 13, 0, "final", 0)

{shipit_cli-0.11.3 → shipit_cli-0.13.0}/tests/test_e2e.py

@@ -165,7 +165,7 @@ class E2ECase(NamedTuple):
     ],
     ids=lambda c: str(c),
 )
-@pytest.mark.flaky(reruns=5, reruns_delay=2)
+@pytest.mark.flaky(reruns=2, reruns_delay=2)
 @pytest.mark.parametrize(
     "build_mode",
     [

shipit_cli-0.11.3/src/shipit/version.py

@@ -1,5 +0,0 @@
-__all__ = ["version", "version_info"]
-
-
-version = "0.11.3"
-version_info = (0, 11, 3, "final", 0)