API Reference

This section contains the complete API reference for the nk2dl package.

nk2dl Package

Nuke to Deadline Submitter - Core Library

A pure Python library for submitting nukescripts to Thinkbox Deadline.

nk2dl.submit_nuke_script(script_path, **kwargs)[source]

Submit a Nuke script to Deadline render farm.

This is the primary entry point for the nk2dl package. It handles parsing the script, configuring job parameters, and submitting to Deadline.

Parameters:

  • script_path (str) – Path to the Nuke script file (.nk)

  • **kwargs – Submission parameters

  • list (# For full parameter)

  • documentation (see the NukeSubmission class)

Returns:

List of dictionaries containing job information:

  • job_id (str): The Deadline job ID

  • render_order (int): The render order value

  • plugin_info (dict): Plugin info used for submission

  • job_info (dict): Job info used for submission

  • deadline_return (dict): Raw return data from Deadline

Return type:

list

Examples

Basic usage:

from nk2dl import submit_nuke_script
submit_nuke_script("path/to/script.nk")

With specific write nodes:

submit_nuke_script("path/to/script.nk", write_nodes=["Write1", "Write2"])

With job parameters:

submit_nuke_script(
    "path/to/script.nk",
    priority=80,
    pool="nuke",
    chunk_size=10,
    comment="Render {script} on farm"
)

Submit as a Python script job (ScriptJob in Deadline):

submit_nuke_script(
    "path/to/script.nk",
    submission_as_script_job=True
)
Raises:

NK2DLError – For configuration or submission errors