runapi-midjourney 0.1.0__tar.gz

runapi_midjourney-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: runapi-midjourney
+Version: 0.1.0
+Summary: RunAPI Midjourney SDK for image generation, editing, image-to-video, and image helper workflows in JavaScript, Python, Ruby, Go, Java, and PHP
+Project-URL: Homepage, https://runapi.ai/models/midjourney
+Project-URL: Documentation, https://runapi.ai/docs#sdk-midjourney
+Project-URL: Source, https://github.com/runapi-ai/midjourney-sdk
+Project-URL: Issues, https://github.com/runapi-ai/midjourney-sdk/issues
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: api,golang,gradle,image-generation,java,maven,midjourney,midjourney-api,python,ruby,runapi,runapi-ai,sdk,typescript,video-generation
+Requires-Python: >=3.9
+Requires-Dist: runapi-core>=0.1.5
+Description-Content-Type: text/markdown
+
+# Midjourney Python SDK for RunAPI
+
+Use `runapi-midjourney` for Midjourney image generation, editing, image-to-video, image-to-prompt, and seed lookup in Python applications and workers.
+
+## Install
+
+```bash
+pip install runapi-midjourney
+```
+
+## Quick Start
+
+```python
+from runapi.midjourney import MidjourneyClient
+
+client = MidjourneyClient()
+result = client.text_to_image.run(
+    model="midjourney-v8.1",
+    prompt="A cobalt blue ceramic vase on white marble",
+)
+print(result.images[0].url)
+```
+
+Use `create`, `get`, and `run` for `text_to_image`, `edit_image`, and `image_to_video`. Use `run` directly for `image_to_prompt` and `get_seed`. Generated media URLs are temporary and should be stored in durable storage.
+
+## Links
+
+- Model page: https://runapi.ai/models/midjourney
+- Product docs: https://runapi.ai/docs#midjourney
+- SDK docs: https://runapi.ai/docs#sdk-midjourney
+- V8.1 details: https://runapi.ai/models/midjourney/v8.1
+- Image editing details: https://runapi.ai/models/midjourney/edit-image
+- Image-to-video details: https://runapi.ai/models/midjourney/image-to-video
+- Repository: https://github.com/runapi-ai/midjourney-sdk
+
+Licensed under the Apache License, Version 2.0.

runapi_midjourney-0.1.0/README.md

@@ -0,0 +1,36 @@
+# Midjourney Python SDK for RunAPI
+
+Use `runapi-midjourney` for Midjourney image generation, editing, image-to-video, image-to-prompt, and seed lookup in Python applications and workers.
+
+## Install
+
+```bash
+pip install runapi-midjourney
+```
+
+## Quick Start
+
+```python
+from runapi.midjourney import MidjourneyClient
+
+client = MidjourneyClient()
+result = client.text_to_image.run(
+    model="midjourney-v8.1",
+    prompt="A cobalt blue ceramic vase on white marble",
+)
+print(result.images[0].url)
+```
+
+Use `create`, `get`, and `run` for `text_to_image`, `edit_image`, and `image_to_video`. Use `run` directly for `image_to_prompt` and `get_seed`. Generated media URLs are temporary and should be stored in durable storage.
+
+## Links
+
+- Model page: https://runapi.ai/models/midjourney
+- Product docs: https://runapi.ai/docs#midjourney
+- SDK docs: https://runapi.ai/docs#sdk-midjourney
+- V8.1 details: https://runapi.ai/models/midjourney/v8.1
+- Image editing details: https://runapi.ai/models/midjourney/edit-image
+- Image-to-video details: https://runapi.ai/models/midjourney/image-to-video
+- Repository: https://github.com/runapi-ai/midjourney-sdk
+
+Licensed under the Apache License, Version 2.0.

runapi_midjourney-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "runapi-midjourney"
+version = "0.1.0"
+description = "RunAPI Midjourney SDK for image generation, editing, image-to-video, and image helper workflows in JavaScript, Python, Ruby, Go, Java, and PHP"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+authors = [{ name = "RunAPI", email = "contact@runapi.ai" }]
+keywords = ["runapi", "runapi-ai", "midjourney", "api", "sdk", "typescript", "python", "ruby", "golang", "java", "maven", "gradle", "image-generation", "video-generation", "midjourney-api"]
+dependencies = ["runapi-core>=0.1.5"]
+
+[project.urls]
+Homepage = "https://runapi.ai/models/midjourney"
+Documentation = "https://runapi.ai/docs#sdk-midjourney"
+Source = "https://github.com/runapi-ai/midjourney-sdk"
+Issues = "https://github.com/runapi-ai/midjourney-sdk/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/runapi"]
+
+[tool.uv]
+package = true
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[tool.runapi]
+slug = "midjourney"

runapi_midjourney-0.1.0/src/runapi/midjourney/__init__.py

@@ -0,0 +1,24 @@
+"""Midjourney client for RunAPI."""
+
+from runapi.core import (
+    AuthenticationError,
+    InsufficientCreditsError,
+    NotFoundError,
+    RateLimitError,
+    TaskFailedError,
+    TaskTimeoutError,
+    ValidationError,
+)
+
+from .client import MidjourneyClient
+
+__all__ = [
+    "MidjourneyClient",
+    "AuthenticationError",
+    "RateLimitError",
+    "InsufficientCreditsError",
+    "NotFoundError",
+    "ValidationError",
+    "TaskFailedError",
+    "TaskTimeoutError",
+]

runapi_midjourney-0.1.0/src/runapi/midjourney/client.py

@@ -0,0 +1,25 @@
+"""Midjourney client."""
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.edit_image import EditImage
+from .resources.get_seed import GetSeed
+from .resources.image_to_prompt import ImageToPrompt
+from .resources.image_to_video import ImageToVideo
+from .resources.text_to_image import TextToImage
+
+
+class MidjourneyClient:
+    """Midjourney image generation, editing, image-to-video, and helper client."""
+
+    def __init__(self, api_key: Optional[str] = None, **options: Any) -> None:
+        resolved_api_key = resolve_api_key(api_key)
+        client_options = ClientOptions(api_key=resolved_api_key, **options)
+        http = client_options.http_client or HttpClient(client_options)
+        self.text_to_image = TextToImage(http)
+        self.edit_image = EditImage(http)
+        self.image_to_video = ImageToVideo(http)
+        self.image_to_prompt = ImageToPrompt(http)
+        self.get_seed = GetSeed(http)

runapi_midjourney-0.1.0/src/runapi/midjourney/contract_gen.py

@@ -0,0 +1,58 @@
+CONTRACT = {
+    "edit-image": {
+        "models": ["midjourney-edit-image"],
+        "fields_by_model": {
+            "midjourney-edit-image": {
+                "prompt": {
+                    "required": True
+                },
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "get-seed": {
+        "models": [],
+        "fields_by_model": {
+            "_": {
+                "image_id": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "image-to-prompt": {
+        "models": [],
+        "fields_by_model": {
+            "_": {
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "image-to-video": {
+        "models": ["midjourney-image-to-video"],
+        "fields_by_model": {
+            "midjourney-image-to-video": {
+                "output_resolution": {
+                    "enum": ["480p"]
+                },
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "text-to-image": {
+        "models": ["midjourney-v8.1"],
+        "fields_by_model": {
+            "midjourney-v8.1": {
+                "prompt": {
+                    "required": True
+                }
+            }
+        }
+    }
+}

runapi_midjourney-0.1.0/src/runapi/midjourney/resources/__init__.py

@@ -0,0 +1,7 @@
+from .edit_image import EditImage
+from .get_seed import GetSeed
+from .image_to_prompt import ImageToPrompt
+from .image_to_video import ImageToVideo
+from .text_to_image import TextToImage
+
+__all__ = ["TextToImage", "EditImage", "ImageToVideo", "ImageToPrompt", "GetSeed"]

runapi_midjourney-0.1.0/src/runapi/midjourney/resources/edit_image.py

@@ -0,0 +1,29 @@
+"""Midjourney edit-image resource."""
+
+from typing import Any, Dict, Optional
+
+from runapi.core import RequestOptions, Resource
+
+from ..contract_gen import CONTRACT
+from ..types import CompletedImageTaskResponse, ImageTaskResponse
+
+
+class EditImage(Resource):
+    ENDPOINT = "/api/v1/midjourney/edit_image"
+    RESPONSE_CLASS = ImageTaskResponse
+    COMPLETED_RESPONSE_CLASS = CompletedImageTaskResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        task = self.create(options=options, **params)
+        return self._poll_until_complete(lambda: self.get(task.id, options=options))
+
+    def create(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        compacted = self._compact_params(params)
+        self._validate_params(compacted)
+        return self._request("post", self.ENDPOINT, body=compacted, options=options)
+
+    def get(self, id: str, options: Optional[RequestOptions] = None) -> Any:
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        self._validate_contract(CONTRACT["edit-image"], params)

runapi_midjourney-0.1.0/src/runapi/midjourney/resources/get_seed.py

@@ -0,0 +1,18 @@
+"""Midjourney get-seed resource."""
+
+from typing import Any, Optional
+
+from runapi.core import RequestOptions, Resource
+
+from ..contract_gen import CONTRACT
+from ..types import GetSeedResponse
+
+
+class GetSeed(Resource):
+    ENDPOINT = "/api/v1/midjourney/get_seed"
+    RESPONSE_CLASS = GetSeedResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["get-seed"], compacted)
+        return self._request("post", self.ENDPOINT, body=compacted, options=options)

runapi_midjourney-0.1.0/src/runapi/midjourney/resources/image_to_prompt.py

@@ -0,0 +1,18 @@
+"""Midjourney image-to-prompt resource."""
+
+from typing import Any, Dict, Optional
+
+from runapi.core import RequestOptions, Resource
+
+from ..contract_gen import CONTRACT
+from ..types import ImageToPromptResponse
+
+
+class ImageToPrompt(Resource):
+    ENDPOINT = "/api/v1/midjourney/image_to_prompt"
+    RESPONSE_CLASS = ImageToPromptResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["image-to-prompt"], compacted)
+        return self._request("post", self.ENDPOINT, body=compacted, options=options)

runapi_midjourney-0.1.0/src/runapi/midjourney/resources/image_to_video.py

@@ -0,0 +1,29 @@
+"""Midjourney image-to-video resource."""
+
+from typing import Any, Dict, Optional
+
+from runapi.core import RequestOptions, Resource
+
+from ..contract_gen import CONTRACT
+from ..types import CompletedVideoTaskResponse, VideoTaskResponse
+
+
+class ImageToVideo(Resource):
+    ENDPOINT = "/api/v1/midjourney/image_to_video"
+    RESPONSE_CLASS = VideoTaskResponse
+    COMPLETED_RESPONSE_CLASS = CompletedVideoTaskResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        task = self.create(options=options, **params)
+        return self._poll_until_complete(lambda: self.get(task.id, options=options))
+
+    def create(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        compacted = self._compact_params(params)
+        self._validate_params(compacted)
+        return self._request("post", self.ENDPOINT, body=compacted, options=options)
+
+    def get(self, id: str, options: Optional[RequestOptions] = None) -> Any:
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        self._validate_contract(CONTRACT["image-to-video"], params)

runapi_midjourney-0.1.0/src/runapi/midjourney/resources/text_to_image.py

@@ -0,0 +1,29 @@
+"""Midjourney text-to-image resource."""
+
+from typing import Any, Dict, Optional
+
+from runapi.core import RequestOptions, Resource
+
+from ..contract_gen import CONTRACT
+from ..types import CompletedImageTaskResponse, ImageTaskResponse
+
+
+class TextToImage(Resource):
+    ENDPOINT = "/api/v1/midjourney/text_to_image"
+    RESPONSE_CLASS = ImageTaskResponse
+    COMPLETED_RESPONSE_CLASS = CompletedImageTaskResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        task = self.create(options=options, **params)
+        return self._poll_until_complete(lambda: self.get(task.id, options=options))
+
+    def create(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        compacted = self._compact_params(params)
+        self._validate_params(compacted)
+        return self._request("post", self.ENDPOINT, body=compacted, options=options)
+
+    def get(self, id: str, options: Optional[RequestOptions] = None) -> Any:
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        self._validate_contract(CONTRACT["text-to-image"], params)

runapi_midjourney-0.1.0/src/runapi/midjourney/types.py

@@ -0,0 +1,44 @@
+"""Midjourney response models."""
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class MediaUrl(BaseModel):
+    url = optional(str)
+
+
+class ImageTaskResponse(TaskResponse):
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    images = optional([lambda: MediaUrl])
+    image_id = optional(str)
+    actions = optional([str])
+    progress = optional(int)
+    error = optional(str)
+
+
+class CompletedImageTaskResponse(ImageTaskResponse):
+    images = required([lambda: MediaUrl])
+
+
+class VideoTaskResponse(TaskResponse):
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: MediaUrl])
+    video_id = optional(str)
+    progress = optional(int)
+    error = optional(str)
+
+
+class CompletedVideoTaskResponse(VideoTaskResponse):
+    videos = required([lambda: MediaUrl])
+
+
+class ImageToPromptResponse(BaseModel):
+    prompts = required([str])
+    error = optional(str)
+
+
+class GetSeedResponse(BaseModel):
+    seed = optional(int)
+    error = optional(str)

runapi_midjourney-0.1.0/tests/test_client.py

@@ -0,0 +1,132 @@
+import pytest
+
+from runapi.core import config
+from runapi.core.errors import AuthenticationError, ValidationError
+from runapi.midjourney import MidjourneyClient
+from runapi.midjourney.resources import EditImage, GetSeed, ImageToPrompt, ImageToVideo, TextToImage
+from runapi.midjourney.types import GetSeedResponse, ImageToPromptResponse
+
+
+class FakeHttp:
+    def __init__(self, *responses):
+        self._responses = list(responses)
+        self.calls = []
+
+    def request(self, method, path, body=None, options=None):
+        self.calls.append((method, path, body))
+        if self._responses:
+            return self._responses.pop(0)
+        return {"id": "task_1", "status": "processing"}
+
+
+@pytest.fixture(autouse=True)
+def reset_config(monkeypatch):
+    monkeypatch.delenv("RUNAPI_API_KEY", raising=False)
+    monkeypatch.setattr(config, "api_key", None)
+    yield
+
+
+def test_requires_api_key():
+    with pytest.raises(AuthenticationError, match="API key is required"):
+        MidjourneyClient()
+
+
+def test_exposes_resources_with_injected_http():
+    fake = FakeHttp()
+    client = MidjourneyClient(api_key="k", http_client=fake)
+
+    assert isinstance(client.text_to_image, TextToImage)
+    assert isinstance(client.edit_image, EditImage)
+    assert isinstance(client.image_to_video, ImageToVideo)
+    assert isinstance(client.image_to_prompt, ImageToPrompt)
+    assert isinstance(client.get_seed, GetSeed)
+    assert client.text_to_image._http is fake
+
+
+def test_async_resources_use_public_paths_and_flat_bodies():
+    fake = FakeHttp()
+    client = MidjourneyClient(api_key="k", http_client=fake)
+
+    client.text_to_image.create(
+        model="midjourney-v8.1",
+        prompt="A cobalt vase",
+        include_split_images=False,
+    )
+    client.text_to_image.get("task_1")
+    client.edit_image.create(
+        model="midjourney-edit-image",
+        prompt="Change the vase color",
+        source_image_url="https://cdn.runapi.ai/public/samples/source.png",
+        mask_url="https://cdn.runapi.ai/public/samples/mask.png",
+    )
+    client.image_to_video.create(
+        model="midjourney-image-to-video",
+        source_image_url="https://cdn.runapi.ai/public/samples/source.png",
+        output_resolution="480p",
+        enable_loop=False,
+    )
+
+    assert fake.calls == [
+        (
+            "post",
+            "/api/v1/midjourney/text_to_image",
+            {"model": "midjourney-v8.1", "prompt": "A cobalt vase", "include_split_images": False},
+        ),
+        ("get", "/api/v1/midjourney/text_to_image/task_1", None),
+        (
+            "post",
+            "/api/v1/midjourney/edit_image",
+            {
+                "model": "midjourney-edit-image",
+                "prompt": "Change the vase color",
+                "source_image_url": "https://cdn.runapi.ai/public/samples/source.png",
+                "mask_url": "https://cdn.runapi.ai/public/samples/mask.png",
+            },
+        ),
+        (
+            "post",
+            "/api/v1/midjourney/image_to_video",
+            {
+                "model": "midjourney-image-to-video",
+                "source_image_url": "https://cdn.runapi.ai/public/samples/source.png",
+                "output_resolution": "480p",
+                "enable_loop": False,
+            },
+        ),
+    ]
+
+
+def test_synchronous_helpers_decode_responses():
+    fake = FakeHttp(
+        {"prompts": ["one", "two", "three", "four"]},
+        {"seed": 8675309},
+    )
+    client = MidjourneyClient(api_key="k", http_client=fake)
+
+    prompts = client.image_to_prompt.run(source_image_url="https://cdn.runapi.ai/public/samples/source.png")
+    seed = client.get_seed.run(image_id="image-1")
+
+    assert isinstance(prompts, ImageToPromptResponse)
+    assert prompts.prompts == ["one", "two", "three", "four"]
+    assert isinstance(seed, GetSeedResponse)
+    assert seed.seed == 8675309
+
+
+def test_get_seed_preserves_error_response_without_seed():
+    fake = FakeHttp({"error": "Seed lookup failed"})
+    client = MidjourneyClient(api_key="k", http_client=fake)
+
+    result = client.get_seed.run(image_id="image-1")
+
+    assert isinstance(result, GetSeedResponse)
+    assert result.seed is None
+    assert result.error == "Seed lookup failed"
+
+
+def test_edit_image_requires_prompt_from_generated_contract():
+    client = MidjourneyClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="prompt is required"):
+        client.edit_image.create(
+            model="midjourney-edit-image",
+            source_image_url="https://cdn.runapi.ai/public/samples/source.png",
+        )