stackmachine 0.3.0__tar.gz → 0.3.1__tar.gz

{stackmachine-0.3.0 → stackmachine-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackmachine
-Version: 0.3.0
+Version: 0.3.1
 Summary: Python SDK for StackMachine.
 Project-URL: Homepage, https://github.com/stackmachine/sdks/tree/main/python
 Project-URL: Repository, https://github.com/stackmachine/sdks
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Requires-Dist: httpx<1,>=0.27
+Requires-Dist: typing-extensions<5,>=4.10
 Requires-Dist: websocket-client<2,>=1.8
 Requires-Dist: websockets<16,>=12
 Description-Content-Type: text/markdown
@@ -177,6 +178,7 @@ app = stackmachine.apps.retrieve(
 cd python
 uv sync --dev
 uv run ruff check src examples tests
+uv run mypy
 uv run pytest
 uv build --no-sources
 ```

{stackmachine-0.3.0 → stackmachine-0.3.1}/README.md

@@ -156,6 +156,7 @@ app = stackmachine.apps.retrieve(
 cd python
 uv sync --dev
 uv run ruff check src examples tests
+uv run mypy
 uv run pytest
 uv build --no-sources
 ```

{stackmachine-0.3.0 → stackmachine-0.3.1}/pyproject.toml

@@ -4,12 +4,13 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stackmachine"
-version = "0.3.0"
+version = "0.3.1"
 description = "Python SDK for StackMachine."
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [
   "httpx>=0.27,<1",
+  "typing-extensions>=4.10,<5",
   "websocket-client>=1.8,<2",
   "websockets>=12,<16",
 ]
@@ -31,6 +32,7 @@ Issues = "https://github.com/stackmachine/sdks/issues"
 
 [dependency-groups]
 dev = [
+  "mypy>=1.13,<2",
   "pytest>=8.0",
   "pytest-asyncio>=0.24",
   "ruff>=0.8",
@@ -43,6 +45,17 @@ target-version = "py39"
 [tool.ruff.lint]
 select = ["E", "F", "I", "B"]
 
+[tool.mypy]
+python_version = "3.9"
+files = ["src", "examples", "tests"]
+pretty = true
+show_error_codes = true
+warn_unused_ignores = true
+
+[[tool.mypy.overrides]]
+module = ["pytest", "pytest.*"]
+follow_imports = "skip"
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 asyncio_mode = "auto"

stackmachine-0.3.1/src/stackmachine/__init__.py

@@ -0,0 +1,144 @@
+"""StackMachine Python SDK."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from ._async_client import AsyncStackMachine
+from ._client import StackMachine
+from ._config import RequestOptions
+from ._errors import (
+    StackMachineAPIError,
+    StackMachineAuthenticationError,
+    StackMachineConnectionError,
+    StackMachineError,
+    StackMachineGraphQLError,
+    StackMachineInvalidRequestError,
+    StackMachinePermissionError,
+    StackMachineRateLimitError,
+    StackMachineValidationError,
+    is_stackmachine_error,
+)
+from ._models import (
+    AppAlias,
+    AppSshServer,
+    DeployApp,
+    DeployAppKindWordPress,
+    DeployAppVersion,
+    DeploymentProgress,
+    ExpectedDNSRecord,
+    Log,
+    SshAuthorizedKey,
+    SshUser,
+    UploadProgress,
+    Viewer,
+)
+from ._pagination import AsyncStackMachineList, StackMachineList
+from ._types import (
+    AppAliasSortBy,
+    AppsDomainsCreateInput,
+    AppsDomainsListInput,
+    AppsSshAuthorizedKeysCreateInput,
+    AppsSshAuthorizedKeysDeleteInput,
+    AppsSshAuthorizedKeysListInput,
+    AppsSshServerUpdateInput,
+    AppsSshUsersListInput,
+    AppsSshUsersUpdateInput,
+    AppsVersionsListInput,
+    AppsVersionsLogsListInput,
+    AsyncStackMachineInitSettings,
+    CreateZipFiles,
+    DeployAppAutobuildExtraData,
+    DeployAppAutobuildInput,
+    DeployAppEnvVarInput,
+    DeployAppJobDefinitionInput,
+    DeployAppsListInput,
+    DeployAppsSortBy,
+    DeployAppVersionsSortBy,
+    DeployAppWordPressExtraData,
+    DeploymentProgressCallback,
+    FileInput,
+    Headers,
+    LogStream,
+    PaginationOptions,
+    Readable,
+    RequestOptionsInput,
+    RequestOptionsLike,
+    SshAuthenticationMethod,
+    SshTokenCreateResult,
+    SshUserPasswordRevealResult,
+    SshUserPasswordRotateResult,
+    StackMachineInitSettings,
+    UploadProgressCallback,
+)
+from ._uploads import create_zip
+
+try:
+    __version__ = version("stackmachine")
+except PackageNotFoundError:
+    __version__ = "0.3.1"
+
+__all__ = [
+    "AppAlias",
+    "AppAliasSortBy",
+    "AppSshServer",
+    "AppsDomainsCreateInput",
+    "AppsDomainsListInput",
+    "AppsSshAuthorizedKeysCreateInput",
+    "AppsSshAuthorizedKeysDeleteInput",
+    "AppsSshAuthorizedKeysListInput",
+    "AppsSshServerUpdateInput",
+    "AppsSshUsersListInput",
+    "AppsSshUsersUpdateInput",
+    "AppsVersionsListInput",
+    "AppsVersionsLogsListInput",
+    "AsyncStackMachine",
+    "AsyncStackMachineInitSettings",
+    "AsyncStackMachineList",
+    "CreateZipFiles",
+    "DeployApp",
+    "DeployAppAutobuildExtraData",
+    "DeployAppAutobuildInput",
+    "DeployAppEnvVarInput",
+    "DeployAppJobDefinitionInput",
+    "DeployAppKindWordPress",
+    "DeployAppVersion",
+    "DeployAppVersionsSortBy",
+    "DeployAppWordPressExtraData",
+    "DeployAppsListInput",
+    "DeployAppsSortBy",
+    "DeploymentProgress",
+    "DeploymentProgressCallback",
+    "ExpectedDNSRecord",
+    "FileInput",
+    "Headers",
+    "Log",
+    "LogStream",
+    "PaginationOptions",
+    "Readable",
+    "RequestOptions",
+    "RequestOptionsInput",
+    "RequestOptionsLike",
+    "SshAuthenticationMethod",
+    "SshAuthorizedKey",
+    "SshTokenCreateResult",
+    "SshUser",
+    "SshUserPasswordRevealResult",
+    "SshUserPasswordRotateResult",
+    "StackMachine",
+    "StackMachineAPIError",
+    "StackMachineAuthenticationError",
+    "StackMachineConnectionError",
+    "StackMachineError",
+    "StackMachineGraphQLError",
+    "StackMachineInvalidRequestError",
+    "StackMachineList",
+    "StackMachineInitSettings",
+    "StackMachinePermissionError",
+    "StackMachineRateLimitError",
+    "StackMachineValidationError",
+    "UploadProgress",
+    "UploadProgressCallback",
+    "Viewer",
+    "__version__",
+    "create_zip",
+    "is_stackmachine_error",
+]

{stackmachine-0.3.0 → stackmachine-0.3.1}/src/stackmachine/_async_client.py

@@ -13,6 +13,7 @@ from ._config import (
 from ._graphql import operations as gql
 from ._models import Viewer
 from ._transport import AsyncTransport
+from ._types import AsyncStackMachineInitSettings, Headers, RequestOptionsLike
 from ._uploads import AsyncUploader
 from .resources.apps import AsyncDeployAppsResource
 from .resources.deployments import AsyncDeploymentsResource
@@ -25,7 +26,7 @@ class AsyncStackMachine:
         api_key: str,
         *,
         api_url: str = DEFAULT_API_URL,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Optional[Headers] = None,
         timeout: float = DEFAULT_TIMEOUT,
         max_network_retries: int = DEFAULT_MAX_NETWORK_RETRIES,
         http_client: Optional[httpx.AsyncClient] = None,
@@ -56,16 +57,79 @@ class AsyncStackMachine:
     @classmethod
     def init(
         cls,
-        settings: Optional[Mapping[str, Any]] = None,
-        **kwargs: Any,
+        settings: Optional[AsyncStackMachineInitSettings] = None,
+        *,
+        api_key: Optional[str] = None,
+        apiKey: Optional[str] = None,
+        token: Optional[str] = None,
+        api_url: Optional[str] = None,
+        apiUrl: Optional[str] = None,
+        headers: Optional[Headers] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
+        maxNetworkRetries: Optional[int] = None,
+        http_client: Optional[httpx.AsyncClient] = None,
+        http_transport: Optional[httpx.AsyncBaseTransport] = None,
     ) -> "AsyncStackMachine":
-        values = {**dict(settings or {}), **kwargs}
-        api_key = values.pop("api_key", None) or values.pop("token", None) or ""
-        if "apiUrl" in values:
-            values["api_url"] = values.pop("apiUrl")
-        if "maxNetworkRetries" in values:
-            values["max_network_retries"] = values.pop("maxNetworkRetries")
-        return cls(api_key, **values)
+        values: AsyncStackMachineInitSettings = {} if settings is None else settings
+        resolved_api_key = (
+            api_key
+            if api_key is not None
+            else apiKey
+            if apiKey is not None
+            else token
+            if token is not None
+            else values.get("api_key")
+            or values.get("apiKey")
+            or values.get("token")
+            or ""
+        )
+        settings_timeout = values.get("timeout")
+        resolved_timeout = (
+            timeout
+            if timeout is not None
+            else settings_timeout
+            if settings_timeout is not None
+            else DEFAULT_TIMEOUT
+        )
+        resolved_api_url = (
+            api_url
+            if api_url is not None
+            else apiUrl
+            if apiUrl is not None
+            else values.get("api_url")
+            or values.get("apiUrl")
+            or DEFAULT_API_URL
+        )
+        settings_max_retries = (
+            values.get("max_network_retries")
+            if values.get("max_network_retries") is not None
+            else values.get("maxNetworkRetries")
+        )
+        resolved_max_retries = (
+            max_network_retries
+            if max_network_retries is not None
+            else maxNetworkRetries
+            if maxNetworkRetries is not None
+            else settings_max_retries
+            if settings_max_retries is not None
+            else DEFAULT_MAX_NETWORK_RETRIES
+        )
+        return cls(
+            resolved_api_key,
+            api_url=resolved_api_url,
+            headers=headers if headers is not None else values.get("headers"),
+            timeout=resolved_timeout,
+            max_network_retries=resolved_max_retries,
+            http_client=(
+                http_client if http_client is not None else values.get("http_client")
+            ),
+            http_transport=(
+                http_transport
+                if http_transport is not None
+                else values.get("http_transport")
+            ),
+        )
 
     async def close(self) -> None:
         await self._transport.close()
@@ -81,7 +145,7 @@ class AsyncStackMachine:
         query: str,
         variables: Optional[Mapping[str, Any]] = None,
         *,
-        request_options: Optional[Mapping[str, Any]] = None,
+        request_options: Optional[RequestOptionsLike] = None,
     ) -> Any:
         return await self._transport.execute(
             query,
@@ -94,7 +158,7 @@ class AsyncStackMachine:
         query: str,
         variables: Optional[Mapping[str, Any]] = None,
         *,
-        request_options: Optional[Mapping[str, Any]] = None,
+        request_options: Optional[RequestOptionsLike] = None,
     ) -> Any:
         return await self._transport.execute(
             query,
@@ -104,7 +168,7 @@ class AsyncStackMachine:
         )
 
     def _subscribe_deployment(
-        self, build_id: str, request_options: Optional[Mapping[str, Any]] = None
+        self, build_id: str, request_options: Optional[RequestOptionsLike] = None
     ):
         return self._transport.subscribe(
             gql.AUTOBUILD_SUBSCRIPTION,
@@ -113,7 +177,7 @@ class AsyncStackMachine:
         )
 
     async def viewer(
-        self, *, request_options: Optional[Mapping[str, Any]] = None
+        self, *, request_options: Optional[RequestOptionsLike] = None
     ) -> Optional[Viewer]:
         response = await self._query(
             gql.VIEWER_QUERY, {}, request_options=request_options

stackmachine-0.3.1/src/stackmachine/_client.py

@@ -0,0 +1,184 @@
+from __future__ import annotations
+
+from typing import Any, Mapping, Optional
+
+import httpx
+
+from ._config import (
+    DEFAULT_API_URL,
+    DEFAULT_MAX_NETWORK_RETRIES,
+    DEFAULT_TIMEOUT,
+    ClientConfig,
+)
+from ._graphql import operations as gql
+from ._models import Viewer
+from ._transport import SyncTransport
+from ._types import Headers, RequestOptionsLike, StackMachineInitSettings
+from ._uploads import SyncUploader
+from .resources.apps import DeployAppsResource
+from .resources.deployments import DeploymentsResource
+from .resources.files import FilesResource
+
+
+class StackMachine:
+    def __init__(
+        self,
+        api_key: str,
+        *,
+        api_url: str = DEFAULT_API_URL,
+        headers: Optional[Headers] = None,
+        timeout: float = DEFAULT_TIMEOUT,
+        max_network_retries: int = DEFAULT_MAX_NETWORK_RETRIES,
+        http_client: Optional[httpx.Client] = None,
+        http_transport: Optional[httpx.BaseTransport] = None,
+    ) -> None:
+        self.api_key = api_key
+        self.api_url = api_url
+        self.apiUrl = api_url
+        self.timeout = timeout
+        self.max_network_retries = max_network_retries
+        self.maxNetworkRetries = max_network_retries
+        self._config = ClientConfig(
+            api_url=api_url,
+            headers=headers,
+            timeout=timeout,
+            max_network_retries=max_network_retries,
+        )
+        self._transport = SyncTransport(
+            api_key,
+            self._config,
+            http_client=http_client,
+            http_transport=http_transport,
+        )
+        self.deployments = DeploymentsResource(self)
+        self.apps = DeployAppsResource(self, self.deployments)
+        self.files = FilesResource(self, SyncUploader(self._transport))
+
+    @classmethod
+    def init(
+        cls,
+        settings: Optional[StackMachineInitSettings] = None,
+        *,
+        api_key: Optional[str] = None,
+        apiKey: Optional[str] = None,
+        token: Optional[str] = None,
+        api_url: Optional[str] = None,
+        apiUrl: Optional[str] = None,
+        headers: Optional[Headers] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
+        maxNetworkRetries: Optional[int] = None,
+        http_client: Optional[httpx.Client] = None,
+        http_transport: Optional[httpx.BaseTransport] = None,
+    ) -> "StackMachine":
+        values: StackMachineInitSettings = {} if settings is None else settings
+        resolved_api_key = (
+            api_key
+            if api_key is not None
+            else apiKey
+            if apiKey is not None
+            else token
+            if token is not None
+            else values.get("api_key")
+            or values.get("apiKey")
+            or values.get("token")
+            or ""
+        )
+        settings_timeout = values.get("timeout")
+        resolved_timeout = (
+            timeout
+            if timeout is not None
+            else settings_timeout
+            if settings_timeout is not None
+            else DEFAULT_TIMEOUT
+        )
+        resolved_api_url = (
+            api_url
+            if api_url is not None
+            else apiUrl
+            if apiUrl is not None
+            else values.get("api_url")
+            or values.get("apiUrl")
+            or DEFAULT_API_URL
+        )
+        settings_max_retries = (
+            values.get("max_network_retries")
+            if values.get("max_network_retries") is not None
+            else values.get("maxNetworkRetries")
+        )
+        resolved_max_retries = (
+            max_network_retries
+            if max_network_retries is not None
+            else maxNetworkRetries
+            if maxNetworkRetries is not None
+            else settings_max_retries
+            if settings_max_retries is not None
+            else DEFAULT_MAX_NETWORK_RETRIES
+        )
+        return cls(
+            resolved_api_key,
+            api_url=resolved_api_url,
+            headers=headers if headers is not None else values.get("headers"),
+            timeout=resolved_timeout,
+            max_network_retries=resolved_max_retries,
+            http_client=(
+                http_client if http_client is not None else values.get("http_client")
+            ),
+            http_transport=(
+                http_transport
+                if http_transport is not None
+                else values.get("http_transport")
+            ),
+        )
+
+    def close(self) -> None:
+        self._transport.close()
+
+    def __enter__(self) -> "StackMachine":
+        return self
+
+    def __exit__(self, *exc_info: object) -> None:
+        self.close()
+
+    def _query(
+        self,
+        query: str,
+        variables: Optional[Mapping[str, Any]] = None,
+        *,
+        request_options: Optional[RequestOptionsLike] = None,
+    ) -> Any:
+        return self._transport.execute(
+            query,
+            variables,
+            request_options=request_options,
+        )
+
+    def _mutation(
+        self,
+        query: str,
+        variables: Optional[Mapping[str, Any]] = None,
+        *,
+        request_options: Optional[RequestOptionsLike] = None,
+    ) -> Any:
+        return self._transport.execute(
+            query,
+            variables,
+            request_options=request_options,
+            mutation=True,
+        )
+
+    def _subscribe_deployment(
+        self, build_id: str, request_options: Optional[RequestOptionsLike] = None
+    ):
+        return self._transport.subscribe(
+            gql.AUTOBUILD_SUBSCRIPTION,
+            {"buildId": build_id},
+            request_options=request_options,
+        )
+
+    def viewer(
+        self, *, request_options: Optional[RequestOptionsLike] = None
+    ) -> Optional[Viewer]:
+        response = self._query(gql.VIEWER_QUERY, {}, request_options=request_options)
+        viewer = response.get("viewer") if response else None
+        return Viewer(username=viewer["username"]) if viewer else None

{stackmachine-0.3.0 → stackmachine-0.3.1}/src/stackmachine/_config.py

@@ -11,11 +11,15 @@ DEFAULT_MAX_NETWORK_RETRIES = 1
 @dataclass
 class RequestOptions:
     api_key: Optional[str] = None
+    apiKey: Optional[str] = None
     headers: Optional[Mapping[str, str]] = None
     timeout: Optional[float] = None
     max_network_retries: Optional[int] = None
+    maxNetworkRetries: Optional[int] = None
     idempotency_key: Optional[str] = None
+    idempotencyKey: Optional[str] = None
     client_mutation_id: Optional[str] = None
+    clientMutationId: Optional[str] = None
     force: Optional[bool] = None
 
 

{stackmachine-0.3.0 → stackmachine-0.3.1}/src/stackmachine/_pagination.py

@@ -12,6 +12,7 @@ from typing import (
     Mapping,
     Optional,
     TypeVar,
+    cast,
 )
 
 from ._errors import StackMachineValidationError
@@ -299,7 +300,7 @@ class AsyncStackMachineList(Generic[T]):
         async for item in self:
             result = handler(item)
             if hasattr(result, "__await__"):
-                result = await result  # type: ignore[assignment]
+                result = await cast(Awaitable[Optional[bool]], result)
             if result is False:
                 return