machgen-client 0.1.0__tar.gz

machgen_client-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 MachGen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

machgen_client-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: machgen-client
+Version: 0.1.0
+Summary: External client for the MachGen platform - submit tasks via the public API.
+Author: MachGen
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://www.machgen.ai
+Project-URL: Documentation, https://www.machgen.ai/docs
+Project-URL: Repository, https://github.com/MachGen/machgen-client
+Project-URL: Issues, https://github.com/MachGen/machgen-client/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: httpx-sse>=0.4.0
+Dynamic: license-file
+
+# machgen-client
+
+External Python client for the MachGen platform.
+
+## Installation
+
+```bash
+pip install machgen-client
+```
+
+Requires Python 3.11 or newer.
+
+To install the latest source snapshot for development:
+
+```bash
+pip install "git+https://github.com/MachGen/machgen-client.git"
+```
+
+## Quick Start
+
+Check the [docs](https://www.machgen.ai/docs/`) on how authentication
+works and get an API key from there.
+
+Populate the API key either in env var `MACHGEN_API_KEY`
+or set it when creating the client `MachGenClient(api_key="...")`.
+
+```python
+from machgen.client import MachGenClient, TaskInput, TaskOutputType, VideoConfig
+
+with MachGenClient() as client:
+    handle = client.submit_task(
+        TaskInput(
+            prompt="...",
+            model="Wan2.2-T2V-A14B",
+            task_type="T2V",
+            video_config=VideoConfig(duration_secs=5, height=720, width=1280, fps=16),
+        )
+    )
+    result = client.wait(handle)
+    print(result.task_output[TaskOutputType.VIDEO])
+```
+
+## Documentation
+
+Full docs are published at https://www.machgen.ai/docs.
+
+Runnable scripts for each task type live in the
+[examples directory](https://github.com/MachGen/machgen-client/tree/main/examples).

machgen_client-0.1.0/README.md

@@ -0,0 +1,48 @@
+# machgen-client
+
+External Python client for the MachGen platform.
+
+## Installation
+
+```bash
+pip install machgen-client
+```
+
+Requires Python 3.11 or newer.
+
+To install the latest source snapshot for development:
+
+```bash
+pip install "git+https://github.com/MachGen/machgen-client.git"
+```
+
+## Quick Start
+
+Check the [docs](https://www.machgen.ai/docs/`) on how authentication
+works and get an API key from there.
+
+Populate the API key either in env var `MACHGEN_API_KEY`
+or set it when creating the client `MachGenClient(api_key="...")`.
+
+```python
+from machgen.client import MachGenClient, TaskInput, TaskOutputType, VideoConfig
+
+with MachGenClient() as client:
+    handle = client.submit_task(
+        TaskInput(
+            prompt="...",
+            model="Wan2.2-T2V-A14B",
+            task_type="T2V",
+            video_config=VideoConfig(duration_secs=5, height=720, width=1280, fps=16),
+        )
+    )
+    result = client.wait(handle)
+    print(result.task_output[TaskOutputType.VIDEO])
+```
+
+## Documentation
+
+Full docs are published at https://www.machgen.ai/docs.
+
+Runnable scripts for each task type live in the
+[examples directory](https://github.com/MachGen/machgen-client/tree/main/examples).

machgen_client-0.1.0/machgen/client/__init__.py

@@ -0,0 +1,36 @@
+from machgen.client._models import (
+    GenerateResponse,
+    ModerationResult,
+    ModerationStage,
+    TaskMetadata,
+    TaskOutputType,
+    TaskStatusResponse,
+    UploadResponse,
+)
+from machgen.client.api import (
+    ImageConfig,
+    TaskInput,
+    TaskStatus,
+    TaskUpdate,
+    VideoConfig,
+)
+from machgen.client.client import MachGenClient, SseRetryConfig
+from machgen.client.task_handle import TaskHandle
+
+__all__ = [
+    "GenerateResponse",
+    "ImageConfig",
+    "MachGenClient",
+    "ModerationResult",
+    "ModerationStage",
+    "SseRetryConfig",
+    "TaskHandle",
+    "TaskInput",
+    "TaskMetadata",
+    "TaskOutputType",
+    "TaskStatus",
+    "TaskStatusResponse",
+    "TaskUpdate",
+    "UploadResponse",
+    "VideoConfig",
+]

machgen_client-0.1.0/machgen/client/_models.py

@@ -0,0 +1,138 @@
+"""Wire-level response models shared between client and server.
+
+The server ([frontend/api_server.py](frontend/api_server.py)) and the external
+client both import these so the JSON schema stays in lock-step.
+
+**Schema evolution policy.** Every model here sets ``extra="ignore"`` so an
+older peer (client *or* server) silently drops fields it doesn't know about.
+That means new fields can be added without coordinating a release across both
+sides — but it requires:
+
+- New fields are always **optional** (carry a default).
+- Existing required fields are **never removed or renamed**.
+- Enum members are **never removed** (additions are tolerated by the receiver
+  only if the receiver doesn't dispatch on the enum value).
+
+These rules are enforced by reviewer discipline, not by code; the test
+[tests/api/test_wire_compat.py](tests/api/test_wire_compat.py) pins the
+``extra="ignore"`` behavior so a regression flips a red light.
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from machgen.client.api import TaskStatus
+
+_WIRE_MODEL_CONFIG = ConfigDict(extra="ignore")
+
+
+class TaskMetadata(BaseModel):
+    model_config = _WIRE_MODEL_CONFIG
+
+    prompt: str = Field(description="Prompt the task was submitted with.")
+    model: str | None = Field(default=None, description="Resolved model id.")
+    task_type: str | None = Field(default=None, description="Resolved task type.")
+    seed: int | None = Field(default=None, description="Seed used for generation.")
+    fps: int | None = Field(default=None, description="Frames per second (video).")
+    height: int | None = Field(default=None, description="Output height in pixels.")
+    width: int | None = Field(default=None, description="Output width in pixels.")
+    aspect_ratio: str | None = Field(default=None, description="Output aspect ratio.")
+    duration_secs: int | None = Field(
+        default=None, description="Clip duration in seconds (video)."
+    )
+    src_image_urls: list[str] | None = Field(
+        default=None, description="Source / reference image refs."
+    )
+    src_video_url: str | None = Field(
+        default=None, description="Source video ref (video-to-video)."
+    )
+    acceleration: str | None = Field(
+        default=None, description="Acceleration profile applied by the backend."
+    )
+
+
+class TaskOutputType(StrEnum):
+    """A task may have 1 or more types of output."""
+
+    TEXT = "text"
+    VIDEO = "video"
+    IMAGE = "image"
+    AUDIO = "audio"
+
+
+class ModerationStage(StrEnum):
+    INPUT = "input"
+    OUTPUT = "output"
+
+
+class ModerationResult(BaseModel):
+    model_config = _WIRE_MODEL_CONFIG
+
+    flagged: bool = Field(
+        default=False, description="Whether moderation matched a block category."
+    )
+    stage: ModerationStage | None = Field(
+        default=None, description="Which stage flagged (input or output)."
+    )
+    surface: str | None = Field(
+        default=None, description='Surface that tripped: "text" or "image".'
+    )
+    categories: list[str] = Field(
+        default_factory=list, description="Matched block categories."
+    )
+    source: str | None = Field(
+        default=None,
+        description='Who produced the verdict: "machgen" (OpenAI) or "vendor".',
+    )
+    moderation_time_secs: float | None = Field(
+        default=None, description="Wall-clock time spent in the moderation call(s)."
+    )
+
+
+class GenerateResponse(BaseModel):
+    model_config = _WIRE_MODEL_CONFIG
+
+    task_id: str = Field(
+        description="Server-assigned id; poll status and download the asset with it."
+    )
+    metadata: TaskMetadata = Field(description="Echo of the resolved task parameters.")
+    task_output: dict[TaskOutputType, str] | None = Field(
+        default=None,
+        description="Per output-type asset locators, as they become available.",
+    )
+    moderation: ModerationResult | None = Field(
+        default=None,
+        description="Set when moderation rejected the request at admission. The task was admitted then immediately failed (refunded); no generation work was done.",
+    )
+
+
+class TaskStatusResponse(GenerateResponse):
+    status: TaskStatus = Field(description="Current task status.")
+    error_msg: str | None = Field(
+        default=None, description="Failure reason, set when status is FAILED."
+    )
+    generation_time_secs: float | None = Field(
+        default=None, description="Time spent on actual generation."
+    )
+    upload_time_secs: float | None = Field(
+        default=None, description="Time spent uploading the asset after generation."
+    )
+    queue_time_secs: float | None = Field(
+        default=None,
+        description="Time spent waiting in the queue for generation to begin.",
+    )
+    moderation: ModerationResult | None = Field(
+        default=None,
+        description="Structured moderation verdict when the task failed or was blocked by moderation.",
+    )
+
+
+class UploadResponse(BaseModel):
+    model_config = _WIRE_MODEL_CONFIG
+
+    artifact_path: str = Field(
+        description="Storage path of the uploaded input; reference it as @input/<artifact_path>."
+    )

machgen_client-0.1.0/machgen/client/_sse_executor.py

@@ -0,0 +1,82 @@
+"""Process-global thread pool for ``TaskHandle`` SSE consumers.
+
+All handles across all ``MachGenClient`` instances submit their stream
+consumption work to one ``ThreadPoolExecutor`` so the per-process worker
+count stays bounded — the alternative (one ad-hoc daemon thread per
+handle) blows up when callers spin up many clients with many handles.
+
+Cap: ``MACHGEN_CLIENT_MAX_SSE_WORKERS`` env var (default 256). The pool
+grows lazily up to that cap.
+
+Atexit handling: at program shutdown we signal stop on every live stream
+state before the pool's own atexit hook fires, so workers blocked on
+``iter_sse()`` are unstuck and the pool's join doesn't hang. Atexit is
+LIFO and the pool's hook is registered the first time a
+``ThreadPoolExecutor`` is created — we register ours after that, so ours
+runs first.
+"""
+
+from __future__ import annotations
+
+import atexit
+import logging
+import os
+import threading
+import weakref
+from concurrent.futures import Future, ThreadPoolExecutor
+from typing import TYPE_CHECKING, Callable
+
+if TYPE_CHECKING:
+    from machgen.client.task_handle import _StreamState
+
+logger = logging.getLogger(__name__)
+
+_DEFAULT_MAX_WORKERS = int(os.environ.get("MACHGEN_CLIENT_MAX_SSE_WORKERS", "256"))
+
+_executor: ThreadPoolExecutor | None = None
+_executor_lock = threading.Lock()
+_active_states: "weakref.WeakSet[_StreamState]" = weakref.WeakSet()
+_active_lock = threading.Lock()
+
+
+def _ensure_executor() -> ThreadPoolExecutor:
+    global _executor
+    if _executor is not None:
+        return _executor
+    with _executor_lock:
+        if _executor is None:
+            _executor = ThreadPoolExecutor(
+                max_workers=_DEFAULT_MAX_WORKERS,
+                thread_name_prefix="machgen-sse",
+            )
+            atexit.register(_atexit_shutdown)
+    return _executor
+
+
+def submit(fn: Callable[..., None], *args, **kwargs) -> Future:
+    """Submit an SSE consumer function to the shared pool."""
+    return _ensure_executor().submit(fn, *args, **kwargs)
+
+
+def register_state(state: "_StreamState") -> None:
+    """Track *state* so atexit can stop its worker before pool shutdown."""
+    with _active_lock:
+        _active_states.add(state)
+
+
+def _atexit_shutdown() -> None:
+    """Signal stop on every live state, then shut down the pool.
+
+    Runs before ``concurrent.futures.thread._python_exit`` (LIFO atexit
+    order). ``signal_stop`` wakes any worker blocked on ``iter_sse()``;
+    the pool's subsequent join then proceeds promptly.
+    """
+    with _active_lock:
+        states = list(_active_states)
+    for state in states:
+        try:
+            state.signal_stop(terminal_message="process exiting")
+        except Exception:
+            logger.warning("error stopping SSE worker at exit", exc_info=True)
+    if _executor is not None:
+        _executor.shutdown(wait=False)