API Documentation

class nukedatastore.NukeDataStoreError(message)

Exception indicating an error related to the Nuke Data Store, inherits from ValueError.

class nukedatastore.NukeDataStore(name)

NukeDataStore class, wrapper around Nuke’s NoOp node.

Parameters:name (str) – Data store name

Usage:

>>> from nukedatastore import NukeDataStore
>>> ds = NukeDataStore('data_store')
>>> ds['project_data'] = {'id': 1234, 'name': 'project name'}
>>> print ds['project_data']
>>> {'id': 1234, 'name': 'project name'}

freeze()

Freeze the data in the NukeDataStore and make it unchangeable.

is_frozen()

Return whether the data in the NukeDataStore is frozen and therefore unchangeable.

list()

List all available keys in the NukeDataStore.

store

Return the data store’s Nuke node

Returns:Data store node Return type:Node

unfreeze()

Unfreeze the data in the NukeDataStore and make it changeable.

class nukedatastore.NukeAPICache(name)

NukeAPICache class, inherits from NukeDataStore.

Parameters:name (str) – Data store name

Usage:

>>> from nukedatastore import NukeAPICache
>>> api_cache = NukeAPICache('api_cache')
>>> api_cache.register('project_data', 'https://project.your.domain.com/api')
>>> print api_cache['project_data']
>>> {'id': 1234, 'name': 'project name'}

diff(*args)

Given *args, diff specified APIs, if no APIs are specified, diff all registered APIs.

Parameters:*args (str) – API names Returns:Diff Return type:dict

register(name, url, update=True, ignore_exists=True)

Given a name and a url, register a new API in the cache.

Parameters:

• name (str) – API name
• url (str) – API URL
• update (bool) – Update API data after registering, default: True
• ignore_exists (bool) – Ignore API is already registered, default: True

timestamp(*args)

Given *args, return timestamps for specified APIs, if no APIs are specified, return timestamps for all registered APIs.

Parameters:*args (str) – API names Returns:List of timestamp tuples (api_name, timestamp) Return type:list

update(*args)

Given *args, update specified APIs, if no APIs are specified, update all registered APIs.

Parameters:*args (str) – API names