PyPI - stackmachine - Versions diffs - 0.3.2__tar.gz → 0.3.3__tar.gz - Mend

stackmachine 0.3.2tar.gz → 0.3.3tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

{stackmachine-0.3.2 → stackmachine-0.3.3}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackmachine
-Version: 0.3.2
+Version: 0.3.3
 Summary: Python SDK for StackMachine.
 Project-URL: Homepage, https://github.com/stackmachine/sdks/tree/main/python
 Project-URL: Repository, https://github.com/stackmachine/sdks
@@ -99,8 +99,12 @@ async for app in apps:
 ```python
 deployment = stackmachine.deployments.create(
-    upload_url="https://example.com/app.zip",
-    app_name="my-app",
+    app_name="hello-stackmachine",
+    owner="stackmachine",
+    files={
+        "index.html": "<html><body><h1>Hello StackMachine</h1></body></html>",
+    },
+    on_upload_progress=lambda progress: print("Uploading", progress.percent * 100),
 )
 version = deployment.wait()
@@ -108,13 +112,18 @@ version = deployment.wait()
 ```python
 deployment = stackmachine.apps.autobuild(
-    upload_url="https://example.com/app.zip",
-    app_name="my-app",
+    app_name="hello-stackmachine",
+    owner="stackmachine",
+    files={
+        "index.html": "<html><body><h1>Hello StackMachine</h1></body></html>",
+    },
 )
 ```
 ## Files
+Use this path only for manual package uploads:
 ```python
 from stackmachine import create_zip

{stackmachine-0.3.2 → stackmachine-0.3.3}/README.md RENAMED Viewed

@@ -77,8 +77,12 @@ async for app in apps:
 ```python
 deployment = stackmachine.deployments.create(
-    upload_url="https://example.com/app.zip",
-    app_name="my-app",
+    app_name="hello-stackmachine",
+    owner="stackmachine",
+    files={
+        "index.html": "<html><body><h1>Hello StackMachine</h1></body></html>",
+    },
+    on_upload_progress=lambda progress: print("Uploading", progress.percent * 100),
 )
 version = deployment.wait()
@@ -86,13 +90,18 @@ version = deployment.wait()
 ```python
 deployment = stackmachine.apps.autobuild(
-    upload_url="https://example.com/app.zip",
-    app_name="my-app",
+    app_name="hello-stackmachine",
+    owner="stackmachine",
+    files={
+        "index.html": "<html><body><h1>Hello StackMachine</h1></body></html>",
+    },
 )
 ```
 ## Files
+Use this path only for manual package uploads:
 ```python
 from stackmachine import create_zip

{stackmachine-0.3.2 → stackmachine-0.3.3}/pyproject.toml RENAMED Viewed

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 [project]
 name = "stackmachine"
-version = "0.3.2"
+version = "0.3.3"
 description = "Python SDK for StackMachine."
 readme = "README.md"
 requires-python = ">=3.9"

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/__init__.py RENAMED Viewed

@@ -54,6 +54,7 @@ from ._types import (
     DeployAppsSortBy,
     DeployAppVersionsSortBy,
     DeployAppWordPressExtraData,
+    DeploymentFilesInput,
     DeploymentProgressCallback,
     FileInput,
     Headers,
@@ -74,7 +75,7 @@ from ._uploads import create_zip
 try:
     __version__ = version("stackmachine")
 except PackageNotFoundError:
-    __version__ = "0.3.2"
+    __version__ = "0.3.3"
 __all__ = [
     "AppAlias",
@@ -105,6 +106,7 @@ __all__ = [
     "DeployAppWordPressExtraData",
     "DeployAppsListInput",
     "DeployAppsSortBy",
+    "DeploymentFilesInput",
     "DeploymentProgress",
     "DeploymentProgressCallback",
     "ExpectedDNSRecord",

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_types.py RENAMED Viewed

@@ -178,6 +178,7 @@ class DeployAppAutobuildInput(TypedDict, total=False):
     envVars: Optional[Sequence[Optional[DeployAppEnvVarInput]]]
     extra_data: Optional[DeployAppAutobuildExtraData]
     extraData: Optional[DeployAppAutobuildExtraData]
+    files: Optional[DeploymentFilesInput]
     install_cmd: Optional[str]
     installCmd: Optional[str]
     jobs: Optional[Sequence[Optional[DeployAppJobDefinitionInput]]]
@@ -240,15 +241,16 @@ class Readable(Protocol):
 FileInput = Union[str, bytes, bytearray, memoryview, Path, Readable]
 CreateZipFiles = Mapping[str, FileInput]
+DeploymentFilesInput = CreateZipFiles
 class UploadProgressCallback(Protocol):
-    def __call__(self, progress: "UploadProgress") -> None:
+    def __call__(self, progress: "UploadProgress", /) -> None:
         ...
 class DeploymentProgressCallback(Protocol):
-    def __call__(self, progress: "DeploymentProgress") -> None:
+    def __call__(self, progress: "DeploymentProgress", /) -> None:
         ...

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/apps.py RENAMED Viewed

@@ -20,8 +20,8 @@ from .._types import (
     DeployAppsSortBy,
     PaginationOptions,
     RequestOptionsLike,
+    UploadProgressCallback,
 )
-from .._utils import camelize, merge_input
 from ._shared import page_variables, resource_missing_error
 from .deployments import (
     AsyncDeployment,
@@ -148,10 +148,20 @@ class DeployAppsResource:
         input: Optional[DeployAppAutobuildInput] = None,
         *,
         request_options: Optional[RequestOptionsLike] = None,
+        chunk_size: Optional[int] = None,
+        on_upload_progress: Optional[UploadProgressCallback] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
         **kwargs: Unpack[DeployAppAutobuildInput],
     ) -> Deployment:
         return self._deployments.create(
-            camelize(merge_input(input, **kwargs)), request_options=request_options
+            input,
+            request_options=request_options,
+            chunk_size=chunk_size,
+            on_upload_progress=on_upload_progress,
+            timeout=timeout,
+            max_network_retries=max_network_retries,
+            **kwargs,
         )
     del_ = delete
@@ -273,10 +283,20 @@ class AsyncDeployAppsResource:
         input: Optional[DeployAppAutobuildInput] = None,
         *,
         request_options: Optional[RequestOptionsLike] = None,
+        chunk_size: Optional[int] = None,
+        on_upload_progress: Optional[UploadProgressCallback] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
         **kwargs: Unpack[DeployAppAutobuildInput],
     ) -> AsyncDeployment:
         return await self._deployments.create(
-            camelize(merge_input(input, **kwargs)), request_options=request_options
+            input,
+            request_options=request_options,
+            chunk_size=chunk_size,
+            on_upload_progress=on_upload_progress,
+            timeout=timeout,
+            max_network_retries=max_network_retries,
+            **kwargs,
         )
     del_ = delete

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/deployments.py RENAMED Viewed

@@ -3,24 +3,47 @@ from __future__ import annotations
 import asyncio
 import threading
 import warnings
-from typing import Any, Callable, Mapping, Optional
+from typing import Any, Callable, Mapping, Optional, cast
 from typing_extensions import Unpack
-from .._errors import StackMachineAPIError
+from .._errors import StackMachineAPIError, StackMachineValidationError
 from .._graphql import operations as gql
 from .._models import DeployAppVersion, DeploymentProgress
 from .._types import (
+    CreateZipFiles,
     DeployAppAutobuildInput,
     DeploymentProgressCallback,
     RequestOptionsLike,
+    UploadProgressCallback,
 )
+from .._uploads import create_zip
 from .._utils import camelize, merge_input
 from ._shared import required_payload, resource_missing_error
 FAILED_STATUSES = {"CANCELLED", "FAILED", "INTERNAL_ERROR", "TIMEOUT"}
+def _merge_deployment_create_input(
+    input: Optional[DeployAppAutobuildInput],
+    kwargs: DeployAppAutobuildInput,
+) -> tuple[dict[str, object], Optional[CreateZipFiles]]:
+    deployment_input = merge_input(input, **kwargs)
+    files = deployment_input.pop("files", None)
+    has_upload_url = (
+        deployment_input.get("upload_url") is not None
+        or deployment_input.get("uploadUrl") is not None
+    )
+    if files is not None and has_upload_url:
+        raise StackMachineValidationError(
+            "`files` cannot be passed together with `upload_url`; "
+            "pass one deployment source.",
+            code="invalid_deployment_source",
+            param="files",
+        )
+    return deployment_input, cast(Optional[CreateZipFiles], files)
 class Deployment:
     def __init__(
         self,
@@ -275,11 +298,27 @@ class DeploymentsResource:
         input: Optional[DeployAppAutobuildInput] = None,
         *,
         request_options: Optional[RequestOptionsLike] = None,
+        chunk_size: Optional[int] = None,
+        on_upload_progress: Optional[UploadProgressCallback] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
         **kwargs: Unpack[DeployAppAutobuildInput],
     ) -> Deployment:
+        deployment_input, files = _merge_deployment_create_input(input, kwargs)
+        if files is not None:
+            upload_url = self._client.files.upload(
+                create_zip(files),
+                chunk_size=chunk_size,
+                on_progress=on_upload_progress,
+                timeout=timeout,
+                max_network_retries=max_network_retries,
+                request_options=request_options,
+            )
+            deployment_input["upload_url"] = upload_url
         response = self._client._mutation(
             gql.AUTOBUILD_MUTATION,
-            {"input": camelize(merge_input(input, **kwargs))},
+            {"input": camelize(deployment_input)},
             request_options=request_options,
         )
         payload = required_payload(
@@ -358,11 +397,27 @@ class AsyncDeploymentsResource:
         input: Optional[DeployAppAutobuildInput] = None,
         *,
         request_options: Optional[RequestOptionsLike] = None,
+        chunk_size: Optional[int] = None,
+        on_upload_progress: Optional[UploadProgressCallback] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
         **kwargs: Unpack[DeployAppAutobuildInput],
     ) -> AsyncDeployment:
+        deployment_input, files = _merge_deployment_create_input(input, kwargs)
+        if files is not None:
+            upload_url = await self._client.files.upload(
+                create_zip(files),
+                chunk_size=chunk_size,
+                on_progress=on_upload_progress,
+                timeout=timeout,
+                max_network_retries=max_network_retries,
+                request_options=request_options,
+            )
+            deployment_input["upload_url"] = upload_url
         response = await self._client._mutation(
             gql.AUTOBUILD_MUTATION,
-            {"input": camelize(merge_input(input, **kwargs))},
+            {"input": camelize(deployment_input)},
             request_options=request_options,
         )
         payload = required_payload(

{stackmachine-0.3.2 → stackmachine-0.3.3}/tests/test_package.py RENAMED Viewed

@@ -18,6 +18,7 @@ from stackmachine import (
     StackMachineValidationError,
     create_zip,
 )
+from stackmachine.resources.deployments import DeploymentsResource
 from stackmachine.resources.files import FilesResource
@@ -51,9 +52,11 @@ def test_exports_clients_and_models() -> None:
 def test_exports_public_input_types() -> None:
     assert "DeployAppAutobuildInput" in stackmachine.__all__
+    assert "DeploymentFilesInput" in stackmachine.__all__
     assert "RequestOptionsInput" in stackmachine.__all__
     assert "FileInput" in stackmachine.__all__
     assert stackmachine.DeployAppAutobuildInput.__name__ == "DeployAppAutobuildInput"
+    assert stackmachine.DeploymentFilesInput == stackmachine.CreateZipFiles
     assert stackmachine.RequestOptionsInput.__name__ == "RequestOptionsInput"
@@ -65,6 +68,14 @@ def test_file_upload_signature_uses_public_types() -> None:
     assert hints["request_options"] == Optional[stackmachine.RequestOptionsLike]
+def test_deployment_create_signature_uses_upload_progress_type() -> None:
+    hints = get_type_hints(DeploymentsResource.create)
+    assert hints["on_upload_progress"] == Optional[
+        stackmachine.UploadProgressCallback
+    ]
 def test_client_constructor_accepts_configuration_aliases() -> None:
     client = StackMachine(
         "token-1",
@@ -138,6 +149,127 @@ def test_request_options_override_auth_and_mutation_id() -> None:
     assert seen["body"]["variables"]["input"]["clientMutationId"] == "mutation-1"
+def test_deployments_create_accepts_files_and_upload_progress() -> None:
+    seen: dict[str, Any] = {}
+    upload_progress: list[stackmachine.UploadProgress] = []
+    def on_upload_progress(progress: stackmachine.UploadProgress) -> None:
+        upload_progress.append(progress)
+    def handler(request: httpx.Request) -> httpx.Response:
+        if str(request.url) == "https://storage.example.test/app.zip":
+            assert request.method == "POST"
+            return httpx.Response(
+                200, headers={"Location": "https://storage.example.test/session"}
+            )
+        if str(request.url) == "https://storage.example.test/session":
+            assert request.method == "PUT"
+            seen["archive"] = request.content
+            return httpx.Response(200)
+        body = json.loads(request.content)
+        if body["operationName"] == "uploadQuery":
+            return graphql_response(
+                {"getSignedUrl": {"url": "https://storage.example.test/app.zip"}}
+            )
+        if body["operationName"] == "srcAutobuildMutation":
+            seen["mutation"] = body
+            return graphql_response(
+                {"deployViaAutobuild": {"success": True, "buildId": "build-files"}}
+            )
+        raise AssertionError(f"Unexpected operation {body['operationName']}")
+    with StackMachine("secret", http_transport=httpx.MockTransport(handler)) as client:
+        deployment = client.deployments.create(
+            app_name="hello-stackmachine",
+            owner="tester",
+            files={"index.html": "<html><body><h1>Hello</h1></body></html>"},
+            chunk_size=10_000_000,
+            on_upload_progress=on_upload_progress,
+        )
+    assert deployment.build_id == "build-files"
+    assert seen["mutation"]["variables"]["input"] == {
+        "appName": "hello-stackmachine",
+        "owner": "tester",
+        "uploadUrl": "https://storage.example.test/app.zip",
+    }
+    assert "files" not in seen["mutation"]["variables"]["input"]
+    assert upload_progress[0].loaded == 0
+    assert upload_progress[-1].percent == 1
+    with zipfile.ZipFile(BytesIO(seen["archive"])) as archive:
+        assert archive.read("index.html") == b"<html><body><h1>Hello</h1></body></html>"
+async def test_async_deployments_create_accepts_files() -> None:
+    seen: dict[str, Any] = {}
+    async def handler(request: httpx.Request) -> httpx.Response:
+        if str(request.url) == "https://storage.example.test/app.zip":
+            return httpx.Response(
+                200, headers={"Location": "https://storage.example.test/session"}
+            )
+        if str(request.url) == "https://storage.example.test/session":
+            return httpx.Response(200)
+        body = json.loads(request.content)
+        if body["operationName"] == "uploadQuery":
+            return graphql_response(
+                {"getSignedUrl": {"url": "https://storage.example.test/app.zip"}}
+            )
+        if body["operationName"] == "srcAutobuildMutation":
+            seen["mutation"] = body
+            return graphql_response(
+                {
+                    "deployViaAutobuild": {
+                        "success": True,
+                        "buildId": "build-files-async",
+                    }
+                }
+            )
+        raise AssertionError(f"Unexpected operation {body['operationName']}")
+    client = AsyncStackMachine("secret", http_transport=httpx.MockTransport(handler))
+    try:
+        deployment = await client.deployments.create(
+            app_name="hello-stackmachine",
+            owner="tester",
+            files={"index.html": "<h1>Hello</h1>"},
+            chunk_size=10_000_000,
+        )
+    finally:
+        await client.close()
+    assert deployment.build_id == "build-files-async"
+    assert seen["mutation"]["variables"]["input"] == {
+        "appName": "hello-stackmachine",
+        "owner": "tester",
+        "uploadUrl": "https://storage.example.test/app.zip",
+    }
+def test_deployments_create_rejects_files_with_upload_url() -> None:
+    calls = 0
+    def handler(_: httpx.Request) -> httpx.Response:
+        nonlocal calls
+        calls += 1
+        return graphql_response({})
+    with StackMachine("secret", http_transport=httpx.MockTransport(handler)) as client:
+        with pytest.raises(StackMachineValidationError) as exc_info:
+            client.deployments.create(
+                app_name="ambiguous",
+                owner="tester",
+                upload_url="https://storage.example.test/app.zip",
+                files={"index.html": "<h1>Hello</h1>"},
+            )
+    assert exc_info.value.code == "invalid_deployment_source"
+    assert exc_info.value.param == "files"
+    assert calls == 0
 def test_graphql_errors_are_mapped() -> None:
     def handler(_: httpx.Request) -> httpx.Response:
         return httpx.Response(

{stackmachine-0.3.2 → stackmachine-0.3.3}/.gitignore RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/examples/async_usage.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/examples/basic_usage.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/examples/deploy_app.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/examples/list_apps.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_async_client.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_client.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_config.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_errors.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_graphql/__init__.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_graphql/operations.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_models.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_pagination.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_transport.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_uploads.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/_utils.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/py.typed RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/__init__.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/_shared.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/domains.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/files.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/ssh.py RENAMED Viewed

File without changes

{stackmachine-0.3.2 → stackmachine-0.3.3}/src/stackmachine/resources/versions.py RENAMED Viewed

File without changes

stackmachine 0.3.2__tar.gz → 0.3.3__tar.gz

stackmachine 0.3.2tar.gz → 0.3.3tar.gz