Skip to main content

A library for basic data persistence in Nuke

Project description

A library for basic data persistence in Nuke

Full Documentation


To install nukedatastore, type:

$ pip install nukedatastore

Open Nuke’s file and add:


Getting Started

To get started with nukedatastore, type in the Nuke Script Editor:

import nukedatastore


To initialise a NukeDataStore, type:

ds = nukedatastore.NukeDataStore('data_store')

To store data in the NukeDataStore, type:

ds['project_data'] = {'id': 1234, 'name': 'project name'}

To list all available keys in the NukeDataStore, type:

# ['project_data']

To retrieve stored data from the NukeDataStore, type:

# {'id': 1234, 'name': 'project name'}

A NukeDataStore can be frozen, to freeze, type:


Any further attempt to set data on the NukeDataStore will result in an error:

ds['color_data'] = {'id': 'AB-123', 'name': 'White'}
# nukedatastore.NukeDataStoreError: Cannot mutate frozen NukeDataStore

To un-freeze, type:



Working with the NukeAPICache is very similar. To register an API, type:

api_cache = nukedatastore.NukeAPICache('api_cache')
api.cache.register('project_data', '')

To read the cached API data, type:


To update the API data, type:


To diff existing API data with new API data, type:

# {'project_data': {'values_changed': {"root['headers']['X-Request-Id']": {'new_value': u'f5800c5e-4edb-4509-8339-4bcdf0b32732', 'old_value': u'd8ed6737-e5c8-49aa-b42e-58eb2ba472b9'}}}}

Project details

Download files

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

Source Distribution

nukedatastore-0.2.0.tar.gz (15.2 kB view hashes)

Uploaded source

Built Distribution

nukedatastore-0.2.0-py2-none-any.whl (8.4 kB view hashes)

Uploaded py2

Supported by

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