stackmachine 0.2.1__tar.gz → 0.3.1__tar.gz

stackmachine-0.3.1/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: stackmachine
+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
+Project-URL: Issues, https://github.com/stackmachine/sdks/issues
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+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
+
+# StackMachine Python SDK
+
+Python SDK for StackMachine. It mirrors the JavaScript SDK surface with a
+Pythonic sync client and a native async client.
+
+## Installation
+
+```bash
+uv add stackmachine
+```
+
+## Usage
+
+```python
+from stackmachine import StackMachine
+
+with StackMachine("sk_stackmachine_...") as stackmachine:
+    app = stackmachine.apps.retrieve_by_name("my-app")
+    print(app.url)
+```
+
+```python
+from stackmachine import AsyncStackMachine
+
+async with AsyncStackMachine("sk_stackmachine_...") as stackmachine:
+    app = await stackmachine.apps.retrieve_by_name("my-app")
+    print(app.url)
+```
+
+## Clients
+
+`StackMachine` exposes sync methods. `AsyncStackMachine` exposes the same
+resource tree with awaitable methods.
+
+```python
+from stackmachine import AsyncStackMachine, StackMachine
+
+stackmachine = StackMachine("sk_stackmachine_...")
+async_stackmachine = AsyncStackMachine("sk_stackmachine_...")
+```
+
+Both clients accept JavaScript-style aliases during initialization:
+
+```python
+stackmachine = StackMachine.init(
+    {
+        "token": "sk_stackmachine_...",
+        "apiUrl": "https://api.stackmachine.com/graphql",
+        "maxNetworkRetries": 2,
+    }
+)
+```
+
+## Apps
+
+```python
+apps = stackmachine.apps.list(limit=10)
+
+for app in apps:
+    print(app.id, app.name)
+
+app = stackmachine.apps.retrieve("app_id")
+app = stackmachine.apps.retrieve_by_name("my-app")
+apps = stackmachine.apps.retrieve_many(["app_1", "app_2"])
+stackmachine.apps.delete("app_id")
+```
+
+Async lists can either be awaited for the first page or iterated directly:
+
+```python
+apps = async_stackmachine.apps.list(limit=10)
+first_page = await apps
+
+async for app in apps:
+    print(app.name)
+```
+
+## Deployments
+
+```python
+deployment = stackmachine.deployments.create(
+    {
+        "file": "https://example.com/app.zip",
+        "name": "my-app",
+    }
+)
+
+version = deployment.wait()
+```
+
+```python
+deployment = stackmachine.apps.autobuild(
+    {
+        "file": "https://example.com/app.zip",
+        "name": "my-app",
+    }
+)
+```
+
+## Files
+
+```python
+from stackmachine import create_zip
+
+zip_bytes = create_zip({"index.html": "<h1>Hello</h1>"})
+url = stackmachine.files.upload(zip_bytes)
+```
+
+## Domains
+
+```python
+domain = stackmachine.apps.domains.create(
+    app="app_id",
+    hostname="example.com",
+)
+
+is_verified = stackmachine.apps.domains.verify(domain.id)
+stackmachine.apps.domains.delete(domain.id)
+```
+
+## SSH
+
+```python
+server = stackmachine.apps.ssh.retrieve("app_id")
+server = stackmachine.apps.ssh.update("app_id", enabled=True)
+token = stackmachine.apps.ssh.tokens.create(app="app_id")
+
+users = stackmachine.apps.ssh.users.list(app="app_id")
+user = stackmachine.apps.ssh.users.retrieve("ssh_user_id")
+password = stackmachine.apps.ssh.users.passwords.rotate("ssh_user_id")
+
+key = stackmachine.apps.ssh.users.authorized_keys.create(
+    user="ssh_user_id",
+    public_key="ssh-ed25519 AAAA...",
+)
+```
+
+## Request Options
+
+Most methods accept `request_options` for per-request configuration:
+
+```python
+app = stackmachine.apps.retrieve(
+    "app_id",
+    request_options={
+        "api_key": "sk_stackmachine_other",
+        "timeout": 30,
+        "idempotency_key": "deploy-123",
+    },
+)
+```
+
+## Development
+
+```bash
+cd python
+uv sync --dev
+uv run ruff check src examples tests
+uv run mypy
+uv run pytest
+uv build --no-sources
+```
+
+## Manual Publish
+
+Use this path only for manual package uploads:
+
+```bash
+cd python
+uv sync --dev
+uv build --no-sources
+uv publish
+```

stackmachine-0.3.1/README.md

@@ -0,0 +1,173 @@
+# StackMachine Python SDK
+
+Python SDK for StackMachine. It mirrors the JavaScript SDK surface with a
+Pythonic sync client and a native async client.
+
+## Installation
+
+```bash
+uv add stackmachine
+```
+
+## Usage
+
+```python
+from stackmachine import StackMachine
+
+with StackMachine("sk_stackmachine_...") as stackmachine:
+    app = stackmachine.apps.retrieve_by_name("my-app")
+    print(app.url)
+```
+
+```python
+from stackmachine import AsyncStackMachine
+
+async with AsyncStackMachine("sk_stackmachine_...") as stackmachine:
+    app = await stackmachine.apps.retrieve_by_name("my-app")
+    print(app.url)
+```
+
+## Clients
+
+`StackMachine` exposes sync methods. `AsyncStackMachine` exposes the same
+resource tree with awaitable methods.
+
+```python
+from stackmachine import AsyncStackMachine, StackMachine
+
+stackmachine = StackMachine("sk_stackmachine_...")
+async_stackmachine = AsyncStackMachine("sk_stackmachine_...")
+```
+
+Both clients accept JavaScript-style aliases during initialization:
+
+```python
+stackmachine = StackMachine.init(
+    {
+        "token": "sk_stackmachine_...",
+        "apiUrl": "https://api.stackmachine.com/graphql",
+        "maxNetworkRetries": 2,
+    }
+)
+```
+
+## Apps
+
+```python
+apps = stackmachine.apps.list(limit=10)
+
+for app in apps:
+    print(app.id, app.name)
+
+app = stackmachine.apps.retrieve("app_id")
+app = stackmachine.apps.retrieve_by_name("my-app")
+apps = stackmachine.apps.retrieve_many(["app_1", "app_2"])
+stackmachine.apps.delete("app_id")
+```
+
+Async lists can either be awaited for the first page or iterated directly:
+
+```python
+apps = async_stackmachine.apps.list(limit=10)
+first_page = await apps
+
+async for app in apps:
+    print(app.name)
+```
+
+## Deployments
+
+```python
+deployment = stackmachine.deployments.create(
+    {
+        "file": "https://example.com/app.zip",
+        "name": "my-app",
+    }
+)
+
+version = deployment.wait()
+```
+
+```python
+deployment = stackmachine.apps.autobuild(
+    {
+        "file": "https://example.com/app.zip",
+        "name": "my-app",
+    }
+)
+```
+
+## Files
+
+```python
+from stackmachine import create_zip
+
+zip_bytes = create_zip({"index.html": "<h1>Hello</h1>"})
+url = stackmachine.files.upload(zip_bytes)
+```
+
+## Domains
+
+```python
+domain = stackmachine.apps.domains.create(
+    app="app_id",
+    hostname="example.com",
+)
+
+is_verified = stackmachine.apps.domains.verify(domain.id)
+stackmachine.apps.domains.delete(domain.id)
+```
+
+## SSH
+
+```python
+server = stackmachine.apps.ssh.retrieve("app_id")
+server = stackmachine.apps.ssh.update("app_id", enabled=True)
+token = stackmachine.apps.ssh.tokens.create(app="app_id")
+
+users = stackmachine.apps.ssh.users.list(app="app_id")
+user = stackmachine.apps.ssh.users.retrieve("ssh_user_id")
+password = stackmachine.apps.ssh.users.passwords.rotate("ssh_user_id")
+
+key = stackmachine.apps.ssh.users.authorized_keys.create(
+    user="ssh_user_id",
+    public_key="ssh-ed25519 AAAA...",
+)
+```
+
+## Request Options
+
+Most methods accept `request_options` for per-request configuration:
+
+```python
+app = stackmachine.apps.retrieve(
+    "app_id",
+    request_options={
+        "api_key": "sk_stackmachine_other",
+        "timeout": 30,
+        "idempotency_key": "deploy-123",
+    },
+)
+```
+
+## Development
+
+```bash
+cd python
+uv sync --dev
+uv run ruff check src examples tests
+uv run mypy
+uv run pytest
+uv build --no-sources
+```
+
+## Manual Publish
+
+Use this path only for manual package uploads:
+
+```bash
+cd python
+uv sync --dev
+uv build --no-sources
+uv publish
+```

stackmachine-0.3.1/examples/async_usage.py

@@ -0,0 +1,16 @@
+import asyncio
+import os
+
+from stackmachine import AsyncStackMachine
+
+
+async def main():
+    async with AsyncStackMachine(os.environ["STACKMACHINE_API_KEY"]) as client:
+        viewer = await client.viewer()
+        print(viewer.username if viewer else "anonymous")
+
+        async for app in client.apps.list(limit=10):
+            print(app.name, app.url)
+
+
+asyncio.run(main())

stackmachine-0.3.1/examples/basic_usage.py

@@ -0,0 +1,13 @@
+import os
+
+from stackmachine import StackMachine
+
+client = StackMachine(os.environ["STACKMACHINE_API_KEY"])
+
+viewer = client.viewer()
+print(viewer.username if viewer else "anonymous")
+
+for app in client.apps.list(limit=10):
+    print(app.name, app.url)
+
+client.close()

stackmachine-0.3.1/examples/deploy_app.py

@@ -0,0 +1,31 @@
+import os
+
+from stackmachine import StackMachine, create_zip
+
+client = StackMachine(os.environ["STACKMACHINE_API_KEY"])
+
+zip_file = create_zip(
+    {
+        "index.php": "<html><body><h1>Hello StackMachine</h1></body></html>",
+    }
+)
+
+upload_url = client.files.upload(
+    zip_file,
+    on_progress=lambda progress: print("Uploading", progress.percent * 100, "%"),
+)
+
+deployment = client.deployments.create(
+    app_name="hello-stackmachine",
+    owner="stackmachine",
+    upload_url=upload_url,
+)
+
+app_version = deployment.wait(
+    on_progress=lambda event: print(
+        event.datetime, event.stream, event.kind, event.message
+    )
+)
+
+print(app_version.app.url)
+client.close()

stackmachine-0.3.1/examples/list_apps.py

@@ -0,0 +1,10 @@
+import os
+
+from stackmachine import StackMachine
+
+with StackMachine(os.environ["STACKMACHINE_API_KEY"]) as client:
+    apps = client.apps.list(limit=25)
+    print("First page:", len(apps.data))
+
+    for app in apps:
+        print(app.name, app.url)

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

@@ -4,11 +4,16 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stackmachine"
-version = "0.2.1"
+version = "0.3.1"
 description = "Python SDK for StackMachine."
 readme = "README.md"
 requires-python = ">=3.9"
-dependencies = []
+dependencies = [
+  "httpx>=0.27,<1",
+  "typing-extensions>=4.10,<5",
+  "websocket-client>=1.8,<2",
+  "websockets>=12,<16",
+]
 classifiers = [
   "Development Status :: 2 - Pre-Alpha",
   "Intended Audience :: Developers",
@@ -27,19 +32,42 @@ Issues = "https://github.com/stackmachine/sdks/issues"
 
 [dependency-groups]
 dev = [
+  "mypy>=1.13,<2",
   "pytest>=8.0",
+  "pytest-asyncio>=0.24",
+  "ruff>=0.8",
 ]
 
+[tool.ruff]
+line-length = 88
+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"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/stackmachine"]
 
 [tool.hatch.build.targets.sdist]
 include = [
   "/README.md",
+  "/examples",
   "/pyproject.toml",
   "/src",
   "/tests",
 ]
-
-[tool.pytest.ini_options]
-testpaths = ["tests"]

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",
+]