shipit-cli 0.9.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

shipit/assets/php/php.ini

@@ -2,7 +2,7 @@
 
 [PHP]
 engine = On
-short_open_tag = Off
+short_open_tag = On
 precision = 14
 output_buffering = 4096
 zlib.output_compression = Off

shipit/assets/wordpress/install.sh

@@ -1,19 +1,15 @@
-# Needed to get the WP-CLI commands to avoid asking for the TTY size, which
-# doesn't work because we don't have the stty command it uses.
+# Needed to get the WP-CLI commands to avoid asking for the TTY size
 export COLUMNS=80
 
 echo "Creating required directories..."
 
 mkdir -p wp-content/plugins
-echo "" > wp-content/plugins/.keep
-
 mkdir -p wp-content/upgrade
-echo "" > wp-content/upgrade/.keep
 
 echo "Installing WordPress core..."
 
 wp core install \
-  --url="$WASMER_APP_URL"  \
+  --url="$WP_SITE_URL"  \
   --title="$WP_SITE_TITLE" \
   --admin_user="$WP_ADMIN_USERNAME" \
   --admin_password="$WP_ADMIN_PASSWORD" \
@@ -22,6 +18,7 @@ wp core install \
 
 
 if [ -z "$WP_UPDATE_DB" ]; then
+    echo "Updating database..."
     wp core update-db
 fi
 

shipit/assets/wordpress/wp-config.php

@@ -28,9 +28,11 @@ function get_env_var(string $name, string $default = ''): string
 	    return $_ENV[$name];
     }
 
-    $stderr = fopen("php://stderr", "wb");
-    fwrite($stderr, "Configuration error: environment variable " . $name . " not provided. Using default value: " . $default . PHP_EOL);
-    fclose($stderr);
+    if ($default === '') {
+        $stderr = fopen("php://stderr", "wb");
+        fwrite($stderr, "Configuration error: environment variable " . $name . " not provided. Using default value: " . $default . PHP_EOL);
+        fclose($stderr);
+    }
 
     return $default;
 }

shipit/cli.py

@@ -90,6 +90,8 @@ class Package:
     version: Optional[str] = None
 
     def __str__(self) -> str:  # pragma: no cover - simple representation
+        if self.version is None:
+            return self.name
         return f"{self.name}@{self.version}"
 
 
@@ -298,14 +300,15 @@ class DockerBuilder:
         #             "--mount",
         #             f"type=volume,source={vol.name},target={str(vol.serve_path)}",
         #         ]
-        return sh.Command(
-            "docker"
-        )(
+        return sh.Command("docker")(
             *docker_args,
             image_name,
             command,
             *(extra_args or []),
-            _env={"DOCKER_BUILDKIT": "1", **os.environ},  # Pass the current environment variables to the Docker client
+            _env={
+                "DOCKER_BUILDKIT": "1",
+                **os.environ,
+            },  # Pass the current environment variables to the Docker client
             _out=write_stdout,
             _err=write_stderr,
         )
@@ -439,10 +442,18 @@ RUN curl https://mise.run | sh
                         raise Exception(f"Asset {step.source} does not exist")
                 else:
                     if step.ignore:
-                        exclude = " \\\n" +" \\\n".join([f"  --exclude={ignore}" for ignore in step.ignore]) + " \\\n "
+                        exclude = (
+                            " \\\n"
+                            + " \\\n".join(
+                                [f"  --exclude={ignore}" for ignore in step.ignore]
+                            )
+                            + " \\\n "
+                        )
                     else:
                         exclude = ""
-                    self.docker_file_contents += f"COPY{exclude} {step.source} {step.target}\n"
+                    self.docker_file_contents += (
+                        f"COPY{exclude} {step.source} {step.target}\n"
+                    )
             elif isinstance(step, EnvStep):
                 env_vars = " ".join(
                     [f"{key}={value}" for key, value in step.variables.items()]
@@ -517,7 +528,9 @@ class LocalBuilder:
     def execute_step(self, step: Step, env: Dict[str, str]) -> None:
         build_path = self.workdir
         if isinstance(step, UseStep):
-            console.print(f"[bold]Using dependencies:[/bold] {step.dependencies}")
+            console.print(
+                f"[bold]Using dependencies:[/bold] {', '.join([str(dep) for dep in step.dependencies])}"
+            )
         elif isinstance(step, WorkdirStep):
             console.print(f"[bold]Working in {step.path}[/bold]")
             self.workdir = step.path
@@ -560,17 +573,14 @@ class LocalBuilder:
                 ignore_extra = (
                     f" [bright_black]# ignoring {', '.join(step.ignore)}[/bright_black]"
                 )
-            if step.target == ".":
-                console.print(f"[bold]Copy from {step.source}[/bold]{ignore_extra}")
-            else:
-                console.print(
-                    f"[bold]Copy to {step.target} from {step.source}[/bold]{ignore_extra}"
-                )
             ignore_matches = step.ignore if step.ignore else []
             ignore_matches.append(".shipit")
             ignore_matches.append("Shipit")
 
             if step.is_download():
+                console.print(
+                    f"[bold]Download from {step.source} to {step.target}[/bold]"
+                )
                 download_file(step.source, (build_path / step.target))
             else:
                 if step.base == "source":
@@ -580,6 +590,10 @@ class LocalBuilder:
                 else:
                     raise Exception(f"Unknown base: {step.base}")
 
+                console.print(
+                    f"[bold]Copy to {step.target} from {step.source}[/bold]{ignore_extra}"
+                )
+
                 if (base / step.source).is_dir():
                     copytree(
                         (base / step.source),
@@ -607,7 +621,7 @@ class LocalBuilder:
     def build(
         self, env: Dict[str, str], mounts: List[Mount], steps: List[Step]
     ) -> None:
-        console.print(f"\n[bold]Building package[/bold]")
+        console.print(f"\n[bold]Building... 🚀[/bold]")
         base_path = self.local_path
         shutil.rmtree(base_path, ignore_errors=True)
         base_path.mkdir(parents=True, exist_ok=True)
@@ -907,7 +921,7 @@ class WasmerBuilder:
                 deps.append(Package("bash"))
 
         if deps:
-            console.print(f"[bold]Mapping dependencies:[/bold]")
+            console.print(f"[bold]Mapping dependencies to Wasmer packages:[/bold]")
         for dep in deps:
             if dep.name in self.mapper:
                 version = dep.version or "latest"
@@ -970,9 +984,7 @@ class WasmerBuilder:
                     env.update(serve.env)
                 if env:
                     arr = array([f"{k}={v}" for k, v in env.items()]).multiline(True)
-                    wasi_args.add(
-                        "env", arr
-                    )
+                    wasi_args.add("env", arr)
                 title = string("annotations.wasi", literal=False)
                 command.add(title, wasi_args)
 
@@ -1049,7 +1061,9 @@ class WasmerBuilder:
             )
             yaml_config["jobs"] = jobs
 
-        app_yaml = yaml.dump(yaml_config,)
+        app_yaml = yaml.dump(
+            yaml_config,
+        )
 
         console.print(f"\n[bold]Created app.yaml manifest ✅[/bold]")
         app_yaml_panel = Panel(
@@ -1344,6 +1358,10 @@ def auto(
         None,
         help="Use a specific Docker client (such as depot, podman, etc.)",
     ),
+    skip_docker_if_safe_build: Optional[bool] = typer.Option(
+        True,
+        help="Skip Docker if the build can be done safely locally (only copy commands).",
+    ),
     skip_prepare: bool = typer.Option(
         False,
         help="Run the prepare command after building (defaults to True).",
@@ -1419,6 +1437,7 @@ def auto(
         wasmer=(wasmer or wasmer_deploy),
         docker=docker,
         docker_client=docker_client,
+        skip_docker_if_safe_build=skip_docker_if_safe_build,
         wasmer_registry=wasmer_registry,
         wasmer_token=wasmer_token,
         wasmer_bin=wasmer_bin,
@@ -1628,6 +1647,10 @@ def build(
         None,
         help="Use a specific Docker client (such as depot, podman, etc.)",
     ),
+    skip_docker_if_safe_build: Optional[bool] = typer.Option(
+        True,
+        help="Skip Docker if the build can be done safely locally (only copy commands).",
+    ),
     env_name: Optional[str] = typer.Option(
         None,
         help="The environment to use (defaults to `.env`, it will use .env.<env_name> if provided)",
@@ -1684,6 +1707,28 @@ def build(
         "CLICOLOR": os.environ.get("CLICOLOR", "0"),
     }
     serve = next(iter(ctx.serves.values()))
+
+    if skip_docker_if_safe_build and serve.build and len(serve.build) > 0:
+        # If it doesn't have a run step, then it's safe to skip Docker and run all the
+        # steps locally.
+        has_run = any(isinstance(step, RunStep) for step in serve.build)
+        if not has_run:
+            console.print(
+                f"[bold]ℹ️ Building locally instead of Docker to speed up the build, as all commands are safe to run locally[/bold]"
+            )
+            return build(
+                path,
+                wasmer=wasmer,
+                skip_prepare=skip_prepare,
+                wasmer_bin=wasmer_bin,
+                wasmer_registry=wasmer_registry,
+                wasmer_token=wasmer_token,
+                docker=False,
+                docker_client=None,
+                skip_docker_if_safe_build=False,
+                env_name=env_name,
+            )
+
     serve.env = serve.env or {}
     if (path / ".env").exists():
         env_vars = dotenv_values(path / ".env")
@@ -1720,5 +1765,6 @@ def main() -> None:
 if __name__ == "__main__":
     main()
 
+
 def flatten(xss):
     return [x for xs in xss for x in xs]

shipit/providers/node_static.py

@@ -327,7 +327,7 @@ class NodeStaticProvider(StaticFileProvider):
         return None
 
     def mounts(self) -> list[MountSpec]:
-        return [MountSpec("temp"), *super().mounts()]
+        return [MountSpec("temp", attach_to_serve=False), *super().mounts()]
 
     def volumes(self) -> list[VolumeSpec]:
         return []

shipit/providers/php.py

@@ -29,7 +29,7 @@ class PhpProvider:
     def detect(cls, path: Path, custom_commands: CustomCommands) -> Optional[DetectResult]:
         if _exists(path, "composer.json") and _exists(path, "public/index.php"):
             return DetectResult(cls.name(), 60)
-        if _exists(path, "index.php") and not _exists(path, "composer.json"):
+        if _exists(path, "index.php") or _exists(path, "public/index.php") or _exists(path, "app/index.php"):
             return DetectResult(cls.name(), 10)
         if custom_commands.start and custom_commands.start.startswith("php "):
             return DetectResult(cls.name(), 70)
@@ -92,9 +92,12 @@ class PhpProvider:
 
     def base_commands(self) -> Dict[str, str]:
         if _exists(self.path, "public/index.php"):
-            return {"start": 'f"php -S localhost:{PORT} -t public"'}
+            return {"start": '"php -S localhost:{} -t {}/public".format(PORT, app["serve"])'}
+        elif _exists(self.path, "app/index.php"):
+            return {"start": '"php -S localhost:{} -t {}/app".format(PORT, app["serve"])'}
         elif _exists(self.path, "index.php"):
-            return {"start": 'f"php -S localhost:{PORT} -t ."'}
+            return {"start": '"php -S localhost:{} -t {}".format(PORT, app["serve"])'}
+        return {}
 
     def mounts(self) -> list[MountSpec]:
         return [

shipit/providers/staticfile.py

@@ -37,14 +37,18 @@ class StaticFileProvider:
         return "staticfile"
 
     @classmethod
-    def detect(cls, path: Path, custom_commands: CustomCommands) -> Optional[DetectResult]:
+    def detect(
+        cls, path: Path, custom_commands: CustomCommands
+    ) -> Optional[DetectResult]:
         if _exists(path, "Staticfile"):
             return DetectResult(cls.name(), 50)
         if _exists(path, "index.html") and not _exists(
             path, "package.json", "pyproject.toml", "composer.json"
         ):
             return DetectResult(cls.name(), 10)
-        if custom_commands.start and custom_commands.start.startswith("static-web-server "):
+        if custom_commands.start and custom_commands.start.startswith(
+            "static-web-server "
+        ):
             return DetectResult(cls.name(), 70)
         return None
 
@@ -70,7 +74,9 @@ class StaticFileProvider:
     def build_steps(self) -> list[str]:
         return [
             'workdir(app["build"])',
-            'copy({}, ".", ignore=[".git"])'.format(json.dumps(self.config and self.config.get("root") or "."))
+            'copy({}, ".", ignore=[".git"])'.format(
+                json.dumps(self.config and self.config.get("root") or ".")
+            ),
         ]
 
     def prepare_steps(self) -> Optional[list[str]]:
@@ -92,6 +98,6 @@ class StaticFileProvider:
 
     def env(self) -> Optional[Dict[str, str]]:
         return None
-    
+
     def services(self) -> list[ServiceSpec]:
         return []

shipit/providers/wordpress.py

@@ -27,8 +27,14 @@ class WordPressProvider(PhpProvider):
         return "wordpress"
 
     @classmethod
-    def detect(cls, path: Path, custom_commands: CustomCommands) -> Optional[DetectResult]:
-        if _exists(path, "wp-content") and _exists(path, "index.php") and _exists(path, "wp-load.php"):
+    def detect(
+        cls, path: Path, custom_commands: CustomCommands
+    ) -> Optional[DetectResult]:
+        if (
+            _exists(path, "wp-content")
+            and _exists(path, "index.php")
+            and _exists(path, "wp-load.php")
+        ):
             return DetectResult(cls.name(), 80)
         return None
 
@@ -49,11 +55,11 @@ class WordPressProvider(PhpProvider):
 
     def declarations(self) -> Optional[str]:
         return super().declarations() + (
-            "wp_cli_version = getenv(\"SHIPIT_WPCLI_VERSION\")\n"
+            'wp_cli_version = getenv("SHIPIT_WPCLI_VERSION")\n'
             "if wp_cli_version:\n"
-            "    wp_cli_download_url = f\"https://github.com/wp-cli/wp-cli/releases/download/v{wp_cli_version}/wp-cli-{wp_cli_version}.phar\"\n"
+            '    wp_cli_download_url = f"https://github.com/wp-cli/wp-cli/releases/download/v{wp_cli_version}/wp-cli-{wp_cli_version}.phar"\n'
             "else:\n"
-            "    wp_cli_download_url = \"https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar\"\n"
+            '    wp_cli_download_url = "https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar"\n'
         )
 
     def build_steps(self) -> list[str]:
@@ -62,27 +68,39 @@ class WordPressProvider(PhpProvider):
             'copy("wordpress/install.sh", "{}/wordpress-install.sh".format(assets["build"]), base="assets")',
         ]
         if not _exists(self.path, "wp-config.php"):
-            steps.append('copy("wordpress/wp-config.php", "{}/wp-config.php".format(app["build"]), base="assets")')
+            steps.append(
+                'copy("wordpress/wp-config.php", "{}/wp-config.php".format(app["build"]), base="assets")'
+            )
         return steps + super().build_steps()
 
     def prepare_steps(self) -> Optional[list[str]]:
         return super().prepare_steps()
 
     def commands(self) -> Dict[str, str]:
+        commands = super().commands()
         return {
-            "start": 'f"php -S localhost:{PORT} -t ."',
-            "wp": '"php {}/wp-cli.phar --allow-root --path={}".format(assets[\"serve\"], app[\"serve\"])',
+            "wp": '"php {}/wp-cli.phar --allow-root --path={}".format(assets["serve"], app["serve"])',
             "after_deploy": '"bash {}/wordpress-install.sh".format(assets["serve"])',
+            **commands,
         }
 
     def mounts(self) -> list[MountSpec]:
         return super().mounts()
 
     def volumes(self) -> list[VolumeSpec]:
-        return [VolumeSpec(name="wp-content", serve_path="\"{}/wp-content/\".format(app[\"serve\"])", var_name="wp_content")]
+        return [
+            VolumeSpec(
+                name="wp-content",
+                serve_path='"{}/wp-content/".format(app["serve"])',
+                var_name="wp_content",
+            )
+        ]
 
     def env(self) -> Optional[Dict[str, str]]:
-        return None
-    
+        return {
+            "PAGER": '"cat"',
+            **(super().env() or {}),
+        }
+
     def services(self) -> list[ServiceSpec]:
         return [ServiceSpec(name="database", provider="mysql")]

shipit/version.py

@@ -1,5 +1,5 @@
 __all__ = ["version", "version_info"]
 
 
-version = "0.9.1"
-version_info = (0, 9, 1, "final", 0)
+version = "0.10.0"
+version_info = (0, 10, 0, "final", 0)

{shipit_cli-0.9.1.dist-info → shipit_cli-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shipit-cli
-Version: 0.9.1
+Version: 0.10.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.10.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+shipit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+shipit/cli.py,sha256=k60mGxpBoyxYgdsFfosc3HuSm5m7Nus5I9RnAaP8X0E,60820
+shipit/generator.py,sha256=W4MynSFwId4PRWWrF0R3NsANye_Zv8TwXCUXai94pW0,6553
+shipit/procfile.py,sha256=GlfdwzFUr0GWGKaaiXlLKNFInWaRNMy_wN14UEyU_5Q,2974
+shipit/version.py,sha256=kFcU-e4oDxwCFdfvjlVkQgvkQaOBmtFeg-EaPmeM9c0,97
+shipit/assets/php/php.ini,sha256=9STxIKCYaku3rbfWP9VwUGaG40zuS6bCd_psNpx9BQk,2530
+shipit/assets/wordpress/install.sh,sha256=YyYzX43I_vlzAKcm7nSOSflxbEaLQgovnrle9oCkEyU,557
+shipit/assets/wordpress/wp-config.php,sha256=bqtT3ep1SfG9H2zdyYHACN4eehLBzYs4ZP0L-uiCWyQ,4179
+shipit/providers/base.py,sha256=-lraLhnXtc2SfYNIUiyry7xD2NL4q0n6voNjr6qfRis,2994
+shipit/providers/gatsby.py,sha256=kzfS-z040GaJ0a9u2_6S6K-ykGSX2yPG17VpjUWBOBA,2393
+shipit/providers/hugo.py,sha256=l3IZ14LGYc3wQ7Uk0iQMDNN9Syd1G4HPzm0ePCGFyzE,1808
+shipit/providers/laravel.py,sha256=2rCuOi2kC5OYQfAG7C0NMhG7KEgzfudwUT_CvVFz4hM,3031
+shipit/providers/mkdocs.py,sha256=mDJpT3rzYAr5Vw-yt5fCpV0QgBZyksn9MrkPd4nzROU,2200
+shipit/providers/node_static.py,sha256=tkttFRB2KEfhZYK_qzcdf7ulEepZEJq9EqkAUo2KYWs,12358
+shipit/providers/php.py,sha256=B5CEvYX51IXWrleNNa6eq-d8xGI8xP4k0Pl8Rpi5cLo,3786
+shipit/providers/python.py,sha256=kQpaaQi8ajHM_SFk2xI5lRIeOc6PXSKumb-Tv_5n6m0,20954
+shipit/providers/registry.py,sha256=JCuQaYTvJcWK1nS-om9TIQgGW6pT5BuNLIRzChLLFWE,731
+shipit/providers/staticfile.py,sha256=hs8ER8rATTho8pBJ6b6ibaOqAfbNZKmlRqbalSdeYY0,2740
+shipit/providers/wordpress.py,sha256=6wd0wPBlE9DvNQgmcEKnH0TArGDkHfRvT9XhqnfOWTU,3258
+shipit_cli-0.10.0.dist-info/METADATA,sha256=94O3cZZT3pBMq20dhD7ph1-vljYQP--Wc6F8g83TId0,616
+shipit_cli-0.10.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+shipit_cli-0.10.0.dist-info/entry_points.txt,sha256=7AE1NjSrHaSDfbfsRRO50KKnHFTbB0Imsccd1WynzAQ,72
+shipit_cli-0.10.0.dist-info/RECORD,,

shipit_cli-0.9.1.dist-info/RECORD

@@ -1,23 +0,0 @@
-shipit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-shipit/cli.py,sha256=NMZ6xSLq8MlV9yT3FLi9XZ5IBw2IMppoPna_vl9LK1Y,59170
-shipit/generator.py,sha256=W4MynSFwId4PRWWrF0R3NsANye_Zv8TwXCUXai94pW0,6553
-shipit/procfile.py,sha256=GlfdwzFUr0GWGKaaiXlLKNFInWaRNMy_wN14UEyU_5Q,2974
-shipit/version.py,sha256=lVDUJez84exvM3cupsLPLkgwODb6keB_FDCxjb0ObkA,95
-shipit/assets/php/php.ini,sha256=f4irndAjB4GuuouEImRkNV22Q-yw1KqR-43jAMDw730,2531
-shipit/assets/wordpress/install.sh,sha256=fJkVeGAw_dj-ywmQipAWRjaz57sayD6F0OFvZKMIKug,669
-shipit/assets/wordpress/wp-config.php,sha256=IdGQoeg8E89JiqwxO2i8WnGMzmhNWgRz80X6lbU5GXc,4134
-shipit/providers/base.py,sha256=-lraLhnXtc2SfYNIUiyry7xD2NL4q0n6voNjr6qfRis,2994
-shipit/providers/gatsby.py,sha256=kzfS-z040GaJ0a9u2_6S6K-ykGSX2yPG17VpjUWBOBA,2393
-shipit/providers/hugo.py,sha256=l3IZ14LGYc3wQ7Uk0iQMDNN9Syd1G4HPzm0ePCGFyzE,1808
-shipit/providers/laravel.py,sha256=2rCuOi2kC5OYQfAG7C0NMhG7KEgzfudwUT_CvVFz4hM,3031
-shipit/providers/mkdocs.py,sha256=mDJpT3rzYAr5Vw-yt5fCpV0QgBZyksn9MrkPd4nzROU,2200
-shipit/providers/node_static.py,sha256=1eWjhcrKZF8DE9EwlEXwFYrbD2AkeabZjIo1_BocWJk,12335
-shipit/providers/php.py,sha256=BSOqS3UhABoe_ued8aXtyn0KdqWbOCq6VV2ehtoBlmk,3547
-shipit/providers/python.py,sha256=kQpaaQi8ajHM_SFk2xI5lRIeOc6PXSKumb-Tv_5n6m0,20954
-shipit/providers/registry.py,sha256=JCuQaYTvJcWK1nS-om9TIQgGW6pT5BuNLIRzChLLFWE,731
-shipit/providers/staticfile.py,sha256=F4thEuihDW-h5DO-lotrjSdHYWzoXofQPpsAgWonvpY,2677
-shipit/providers/wordpress.py,sha256=Wjc1fgFburewlf4hQ2ZmxTQko_SHQW-8jrDukzKx0Gs,3019
-shipit_cli-0.9.1.dist-info/METADATA,sha256=i8nzdCcT8qJFNNazduiVP1afqfxv1g2rlyCpDfCTcXQ,615
-shipit_cli-0.9.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-shipit_cli-0.9.1.dist-info/entry_points.txt,sha256=7AE1NjSrHaSDfbfsRRO50KKnHFTbB0Imsccd1WynzAQ,72
-shipit_cli-0.9.1.dist-info/RECORD,,