Skip to main content

ranchcomputing SDK stands as a bridge between external pipelines and our rendering services

Project description

Ranch python SDK

This Python-based API SDK Designed with future production in mind, its goal is to unify the development of the Ranchecker application and facilitate external customers in integrating their pipelines with our render farm. This SDK stands as a bridge between external pipelines and our rendering services, potentially opening new avenues for collaboration and efficiency in rendering workflows.

Example python script

Here is a little simple script with python submit a job to the ranchcomputing render farm with cinema 4d R23 and Arnold renderer

import os
from ranch.connection import Connect
from ranch import ranchecker

RANCH_API_KEY = os.getenv("RANCH_API_KEY")
Username = os.environ.get("g_licenseUsername")
Password = os.environ.get("g_licensePassword")
# Replace the scene variable with the destination of your scene.
scene = "C:\\Users\\username\\jobs\\cinema4d\\sdk.c4d"
c4d_commandline = "C:\\Maxon\\C4D2023\\Commandline.exe"

conn = Connect(RANCH_API_KEY)
ranch_rc = ranchecker.Ranchecker()
vuc_archive_path = ranch_rc.create_archive(software_commandline=c4d_commandline, 
            g_licenseUsername=Username, 
            g_licensePassword=Password, 
            scene_destination=scene)
job = conn.create_job(
            archive_path=vuc_archive_path,
            job_name="sdk_job",
            priority="cpu-low",
            software="cinema4d",
            software_version="R23",
            renderer_name="Arnold",
        )
res = conn.submit(job)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ranch_sdk-1.0.18-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file ranch_sdk-1.0.18-py3-none-any.whl.

File metadata

  • Download URL: ranch_sdk-1.0.18-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.0

File hashes

Hashes for ranch_sdk-1.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 225408d9b4bca07b2f8b6c8d654ef533d75c48b21e629327bbf061eb27c40ab5
MD5 d487f30678c6da665699b9205e4d394e
BLAKE2b-256 6549bf65ba21196fd3cb9e9dd5611abbd037ecaeafa8ff130bd3802d41a7872b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page