Render product mockups with Django

Use this pre-built prompt to get started faster.

Prerequisites

An API key, which begins with sm_
A PSD at a public URL
A Django app you can add a view and a management command to

Guide

Install

Add the Python client to the project.

pip install sudomock

uv add sudomock

poetry add sudomock

Configure the project

The key and the two uuids from the next step live in the environment, so a missing value stops the project at startup rather than on the first render.

settings.py

import os

SUDOMOCK_API_KEY = os.environ["SUDOMOCK_API_KEY"]
SUDOMOCK_MOCKUP_UUID = os.environ["SUDOMOCK_MOCKUP_UUID"]
SUDOMOCK_SMART_OBJECT = os.environ["SUDOMOCK_SMART_OBJECT"]

Build the client once and import it where a view needs it.

mockups/client.py

from django.conf import settings
from sudomock import SudoMock

client = SudoMock(api_key=settings.SUDOMOCK_API_KEY)

Upload the template once

A PSD is uploaded once and rendered many times, so this belongs in a management command rather than in request handling.

mockups/management/commands/upload_mockup.py

from django.core.management.base import BaseCommand

from mockups.client import client


class Command(BaseCommand):
    help = "Upload a PSD and print the uuids a render needs."

    def add_arguments(self, parser):
        parser.add_argument("psd_url")
        parser.add_argument("name")

    def handle(self, *args, **options):
        mockup = client.psd.upload(
            url=options["psd_url"],
            name=options["name"],
        )
        self.stdout.write(f"mockup: {mockup.uuid}")
        for layer in mockup.smart_objects:
            self.stdout.write(
                f"smart object {layer.name}: {layer.uuid}"
            )

Run it once, and keep the two uuids it prints as SUDOMOCK_MOCKUP_UUID and SUDOMOCK_SMART_OBJECT.

python manage.py upload_mockup \
  https://example.com/heavyweight-tee.psd \
  "Heavyweight tee front"

mockup: 8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8
smart object Front print: b41a7e52-93c8-4d61-8f07-2ae5c9d04713

Render from a view

The view takes an artwork URL, fills the smart object with it, and answers with the finished image.

mockups/views.py

import json

from django.conf import settings
from django.http import JsonResponse
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_POST
from sudomock import SudoMockError

from mockups.client import client


@csrf_exempt
@require_POST
def render_mockup(request):
    artwork_url = json.loads(request.body)["artwork_url"]

    try:
        render = client.renders.create(
            mockup_uuid=settings.SUDOMOCK_MOCKUP_UUID,
            smart_objects=[
                {
                    "uuid": settings.SUDOMOCK_SMART_OBJECT,
                    "asset": {"url": artwork_url, "fit": "crop"},
                }
            ],
            export_options={
                "image_format": "webp",
                "image_size": 1920,
                "quality": 90,
            },
        )
    except SudoMockError as error:
        return JsonResponse(
            {"error": error.message, "code": error.error_code},
            status=error.status_code or 502,
        )

    return JsonResponse({"url": render.url})

csrf_exempt suits a route your own backend calls; a route a browser form posts to keeps the token instead. Wire the view into urls.py and post an artwork URL to it.

Next steps

Render a PSD mockup

Every field the render call accepts.

Create a mockup from a PSD

What an upload answers with.

Retrieve a single job

Collect a background render by its job id.

Errors

Each error_code, and which statuses are worth retrying.

Webhooks

Let a finished render call your Django route back.

SDKs

Every resource the Python client exposes, and the Node one.

Get started

Learn

Resources

Render product mockups with Django

Prerequisites

Guide

Next steps

Render a PSD mockup

Create a mockup from a PSD

Retrieve a single job

Errors

Webhooks

SDKs

​Prerequisites

​Guide

​Next steps

Render a PSD mockup

Create a mockup from a PSD

Retrieve a single job

Errors

Webhooks

SDKs

Prerequisites

Guide

Next steps