shipit-cli 0.21.6__tar.gz → 0.22.0__tar.gz

{shipit_cli-0.21.6 → shipit_cli-0.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shipit-cli
-Version: 0.21.6
+Version: 0.22.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
@@ -66,8 +66,8 @@ uvx shipit-cli generate .
 ```
 
 Create or refresh the `Shipit` file. Override build and run commands with
-`--install-command`, `--build-command`, or `--start-command`. Pick a exlicit provider
-with `--use-provider`.
+`--install-command`, `--build-command`, or `--start-command`. Pick an explicit
+provider with `--use-provider`.
 
 ### `plan`
 
@@ -106,6 +106,30 @@ uvx shipit-cli deploy
 Deploy a Wasmer package generated by `shipit build --wasmer`. Use
 `--wasmer-deploy-config` to write deployment metadata instead of publishing.
 
+## The Shipit file
+
+`shipit generate` writes a small, editable Starlark file that pairs a
+provider build with a serve:
+
+```python
+load("//shipit/tools:python.shipit", "python_build", "python_serve")
+
+build = python_build(config)
+
+python_serve(config, build, name = "my-app")
+```
+
+The file is yours: add steps around the build (`build_pre` / `build_post`),
+extend the runtime (`extra_deps`, `extra_env`), attach services, or compose
+builds and serves from different providers (a Hugo build served by the
+shared static serve, a PHP build with a Node asset build folded in). Any
+config field can also be overridden without editing anything, via `SHIPIT_*`
+environment variables (e.g. `SHIPIT_PHPIX=true`) or `--config` JSON.
+
+See [docs/shipit-files.md](docs/shipit-files.md) for the full format
+reference: builtins, `file_exists()`, load labels, the serve override
+surface, and composition examples.
+
 ## Supported Technologies
 
 Shipit works with three execution environments:
@@ -140,6 +164,14 @@ You can run the e2e tests in parallel (`-n 8`) with:
 uv run pytest -m e2e -v "tests/test_e2e.py" -s -n 8
 ```
 
+You can also run one technology slice at a time with `e2e_static`,
+`e2e_staticpython`, `e2e_staticnode1`, `e2e_staticnode2`, `e2e_python`,
+`e2e_node`, or `e2e_php`, for example:
+
+```bash
+uv run pytest -m "e2e and e2e_staticnode1" -v "tests/test_e2e.py" -s -n 4
+```
+
 The e2e tests will:
 * Build the project (locally, or with docker)
 * Run the project (locally or with Wasmer)

{shipit_cli-0.21.6 → shipit_cli-0.22.0}/README.md

@@ -43,8 +43,8 @@ uvx shipit-cli generate .
 ```
 
 Create or refresh the `Shipit` file. Override build and run commands with
-`--install-command`, `--build-command`, or `--start-command`. Pick a exlicit provider
-with `--use-provider`.
+`--install-command`, `--build-command`, or `--start-command`. Pick an explicit
+provider with `--use-provider`.
 
 ### `plan`
 
@@ -83,6 +83,30 @@ uvx shipit-cli deploy
 Deploy a Wasmer package generated by `shipit build --wasmer`. Use
 `--wasmer-deploy-config` to write deployment metadata instead of publishing.
 
+## The Shipit file
+
+`shipit generate` writes a small, editable Starlark file that pairs a
+provider build with a serve:
+
+```python
+load("//shipit/tools:python.shipit", "python_build", "python_serve")
+
+build = python_build(config)
+
+python_serve(config, build, name = "my-app")
+```
+
+The file is yours: add steps around the build (`build_pre` / `build_post`),
+extend the runtime (`extra_deps`, `extra_env`), attach services, or compose
+builds and serves from different providers (a Hugo build served by the
+shared static serve, a PHP build with a Node asset build folded in). Any
+config field can also be overridden without editing anything, via `SHIPIT_*`
+environment variables (e.g. `SHIPIT_PHPIX=true`) or `--config` JSON.
+
+See [docs/shipit-files.md](docs/shipit-files.md) for the full format
+reference: builtins, `file_exists()`, load labels, the serve override
+surface, and composition examples.
+
 ## Supported Technologies
 
 Shipit works with three execution environments:
@@ -117,6 +141,14 @@ You can run the e2e tests in parallel (`-n 8`) with:
 uv run pytest -m e2e -v "tests/test_e2e.py" -s -n 8
 ```
 
+You can also run one technology slice at a time with `e2e_static`,
+`e2e_staticpython`, `e2e_staticnode1`, `e2e_staticnode2`, `e2e_python`,
+`e2e_node`, or `e2e_php`, for example:
+
+```bash
+uv run pytest -m "e2e and e2e_staticnode1" -v "tests/test_e2e.py" -s -n 4
+```
+
 The e2e tests will:
 * Build the project (locally, or with docker)
 * Run the project (locally or with Wasmer)

{shipit_cli-0.21.6 → shipit_cli-0.22.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shipit-cli"
-version = "0.21.6"
+version = "0.22.0"
 description = "Shipit CLI is the best way to build, serve and deploy your projects anywhere."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -55,6 +55,13 @@ dev = [
 asyncio_mode = "auto"
 markers = [
     "e2e: end-to-end tests that require external runtimes and network access",
+    "e2e_static: static-site end-to-end tests",
+    "e2e_staticnode1: first Node-built static-site end-to-end test shard",
+    "e2e_staticnode2: second Node-built static-site end-to-end test shard",
+    "e2e_staticpython: Python-built static-site end-to-end tests",
+    "e2e_python: Python end-to-end tests",
+    "e2e_node: Node.js end-to-end tests",
+    "e2e_php: PHP and WordPress end-to-end tests",
 ]
 
 [tool.mypy]
@@ -67,20 +74,5 @@ ignore_missing_imports = true
 warn_redundant_casts = true
 warn_unused_ignores = true
 
-[[tool.mypy.overrides]]
-module = [
-    "shipit.cli",
-    "shipit.generator",
-    "shipit.providers.go",
-    "shipit.providers.hugo",
-    "shipit.providers.jekyll",
-    "shipit.providers.node_static",
-    "shipit.providers.python",
-    "shipit.providers.staticfile",
-    "shipit.runners.wasmer",
-    "tests.test_e2e",
-]
-ignore_errors = true
-
 [tool.uv.workspace]
 exclude = ["examples/*"]

{shipit_cli-0.21.6 → shipit_cli-0.22.0}/src/shipit/builders/base.py

@@ -2,7 +2,7 @@ from pathlib import Path
 from typing import Dict, List, Optional, Protocol, TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from shipit.cli import Mount, Step
+    from shipit.shipit_types import Mount, Step
 
 
 class BuildBackend(Protocol):