Skip to main content

A library for basic data persistence in Nuke

Project description

https://img.shields.io/pypi/l/nukedatastore.svg https://img.shields.io/pypi/pyversions/nukedatastore.svg https://img.shields.io/pypi/v/nukedatastore.svg https://img.shields.io/pypi/wheel/nukedatastore.svg https://readthedocs.org/projects/nukedatastore/badge/?version=latest

A library for basic data persistence in Nuke

Full Documentation

Installation

To install nukedatastore, type:

$ pip install nukedatastore

Open Nuke’s init.py file and add:

nuke.pluginAddPath('/path/to/your/local/python/site-packages')

Getting Started

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

import nukedatastore

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:

ds.list()
# ['project_data']

To retrieve stored data from the NukeDataStore, type:

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

A NukeDataStore can be frozen, to freeze, type:

ds.freeze()

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:

ds.unfreeze()

NukeAPICache

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

api_cache = nukedatastore.NukeAPICache('api_cache')
api.cache.register('project_data', 'https://project.your.domain.com')

To read the cached API data, type:

api_cache['project_data']

To update the API data, type:

api_cache.update('project_data')

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

api_cache.diff('project_data')
# {'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.

Files for nukedatastore, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size nukedatastore-0.2.0-py2-none-any.whl (8.4 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size nukedatastore-0.2.0.tar.gz (15.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page