API Reference

• Zoo Config Manager
  • Zoo
    • Zoo.coreVersion()
    • Zoo.buildVersion()
    • Zoo.buildPackagePath()
    • Zoo.isAdmin
    • Zoo.commands
    • Zoo.rootPath
    • Zoo.configPath
    • Zoo.corePath
    • Zoo.packagesPath
    • Zoo.pythonPath
    • Zoo.resolver
    • Zoo.commandLibrary
    • Zoo.descriptorLibrary
    • Zoo.preferenceRootsPath()
    • Zoo.preferenceRootsConfig()
    • Zoo.cacheFolderPath()
    • Zoo.sitePackagesPath()
    • Zoo.descriptorFromDict()
    • Zoo.descriptorForPackageName()
    • Zoo.descriptorsForPackageNames()
    • Zoo.descriptorFromPath()
    • Zoo.runCommand()
    • Zoo.shutdown()
    • Zoo.reload()
  • currentConfig()
  • setCurrentConfig()
  • zooFromPath()
• Zoo tools Host Engine
  • HostApplication
    • HostApplication.executable
    • HostApplication.installLocation
    • HostApplication.isHeadless
    • HostApplication.qtMainWindow
    • HostApplication.pythonExecutable
    • HostApplication.quit()
  • Engine
    • Engine.init()
    • Engine.initialized
    • Engine.host
    • Engine.postInit()
    • Engine.preEnvInit()
    • Engine.postEnvInit()
    • Engine.shutdownEngine()
    • Engine.showDialog()
    • Engine.closeDialog()
    • Engine.closeAllDialogs()
    • Engine.registerDialog()
    • Engine.unregisterDialog()
    • Engine.dialogsByName()
    • Engine.setStyleSheet()
  • currentEngine()
  • setCurrentEngine()
  • startEngine()
  • shutdownEngine()
• Constants
  • ZOO_CFG_PATH_ENV
  • ZOO_PKG_PATH_ENV
  • ZOO_PKG_VERSION_PATH
  • ZOO_PACKAGE_VERSION_FILE
  • CACHE_FOLDER_PATH_ENV
  • CONFIG_FOLDER_NAME
  • PKG_FOLDER_NAME
  • COMMANDLIBRARY_ENV
  • ZOO_DESCRIPTOR_PATH
  • FILE_FILTER_EXCLUDE
  • CONFIG_FOLDER_TOKEN
  • PKG_FOLDER_TOKEN
  • PACKAGE_NAME
  • CLI_ROOT_NAME
  • ZOO_ADMIN
  • DEFAULT_PREFS_PATH
• Descriptors
  • Descriptor
    • DescriptorRegistry
      • DescriptorRegistry.generateCache()
      • DescriptorRegistry.descriptorForPackages()
      • DescriptorRegistry.descriptorFromDict()
      • DescriptorRegistry.descriptorFromPath()
    • Descriptor
      • Descriptor.LOCAL_PATH
      • Descriptor.ZOOTOOLS
      • Descriptor.requiredkeys
      • Descriptor.isDescriptorOfType()
      • Descriptor.package
      • Descriptor.serialize()
      • Descriptor.installed()
      • Descriptor.resolve()
      • Descriptor.install()
      • Descriptor.uninstall()
    • GitDescriptor
      • GitDescriptor.id
      • GitDescriptor.requiredkeys
      • GitDescriptor.resolve()
      • GitDescriptor.install()
    • ZooDescriptor
      • ZooDescriptor.id
      • ZooDescriptor.requiredKeys
      • ZooDescriptor.resolve()
      • ZooDescriptor.install()
    • PathDescriptor
      • PathDescriptor.id
      • PathDescriptor.requiredkeys
      • PathDescriptor.path
      • PathDescriptor.resolve()
      • PathDescriptor.install()
• Resolver
  • Environment
    • Environment.environmentPath()
    • Environment.loadEnvironmentFile()
    • Environment.updateEnvironmentDescriptorFromDict()
    • Environment.removeDescriptorFromEnvironment()
    • Environment.createEnvironmentFile()
    • Environment.resolveFromPath()
    • Environment.resolve()
    • Environment.shutdown()
    • Environment.packageFromPath()
    • Environment.packageForDescriptor()
    • Environment.existingPackage()
    • Environment.packageByName()
    • Environment.testPackagesInCurrentEnv()
• Package
  • isPackageDirectory()
  • Package
    • Package.fromData()
    • Package.setVersion()
    • Package.processFile()
    • Package.setPath()
    • Package.exists()
    • Package.processData()
    • Package.dirname()
    • Package.setName()
    • Package.delete()
    • Package.searchStr()
    • Package.nameForPackageNameAndVersion()
    • Package.resolve()
    • Package.resolveEnvPath()
    • Package.save()
    • Package.updateAndWriteVersion()
    • Package.createZip()
    • Package.copyTo()
    • Package.runInstall()
    • Package.runUninstall()
    • Package.runStartup()
    • Package.shutdown()
• Plugin Manager
  • PluginManager
    • PluginManager.registerByEnv()
    • PluginManager.registerPaths()
    • PluginManager.registerPath()
    • PluginManager.registerByModule()
    • PluginManager.registerByPackage()
    • PluginManager.registerPlugin()
    • PluginManager.loadPlugin()
    • PluginManager.loadAllPlugins()
    • PluginManager.getPlugin()
    • PluginManager.unload()
    • PluginManager.unloadAllPlugins()
• Plugin
  • Plugin
    • Plugin.id
    • Plugin.creator
  • PluginStats
    • PluginStats.start()
    • PluginStats.finish()
• Environment registry
  • EnvRegistry
    • EnvRegistry.registryEnv
    • EnvRegistry.interface
    • EnvRegistry.variableName
    • EnvRegistry.discover()
    • EnvRegistry.initPlugins()
• API Reference
  • Preference Manager
    • PreferenceManager
      • PreferenceManager.DEFAULT_USER_PREFERENCE_NAME
      • PreferenceManager.hasInterface()
      • PreferenceManager.interface()
      • PreferenceManager.interfaces()
      • PreferenceManager.iterPackagePreferenceRoots()
      • PreferenceManager.iterPackagePrefPath()
      • PreferenceManager.packagePreferenceRootLocation()
      • PreferenceManager.packagePreferenceLocation()
      • PreferenceManager.copyOriginalToRoot()
      • PreferenceManager.moveRootLocation()
      • PreferenceManager.setRootLocation()
      • PreferenceManager.assetPath()
      • PreferenceManager.shouldCopyDefaultAssets
      • PreferenceManager.prefsPath()
      • PreferenceManager.defaultPreferencePath()
      • PreferenceManager.defaultPreferenceSettings()
      • PreferenceManager.findSetting()
  • Interface
    • PreferenceInterface
      • PreferenceInterface.id
      • PreferenceInterface.settings()
      • PreferenceInterface.refreshSettings()
      • PreferenceInterface.saveSettings()
      • PreferenceInterface.settingsValid()
      • PreferenceInterface.refresh()
      • PreferenceInterface.revertSettings()
  • Custom Interfaces
    • GeneralPreferences
      • GeneralPreferences.id
      • GeneralPreferences.primaryRenderer()
      • GeneralPreferences.setPrimaryRenderer()
      • GeneralPreferences.autoLoadPlugin()
      • GeneralPreferences.setAutoLoad()
    • pluginPath()
    • ToolsetPreference
      • ToolsetPreference.id
    • HiveInterface
      • HiveInterface.id
      • HiveInterface.upgradePreferences()
      • HiveInterface.upgradeAssets()
      • HiveInterface.defaultUserTemplatePath()
      • HiveInterface.repostoryAssetPath()
      • HiveInterface.defaultExportPluginPath()
      • HiveInterface.defaultBuildScriptPath()
      • HiveInterface.defaultUniversalMeshPivotPath()
      • HiveInterface.defaultNamingConfigPath()
      • HiveInterface.userComponentPaths()
      • HiveInterface.userBuildScriptPaths()
      • HiveInterface.userBuildScripts()
      • HiveInterface.userTemplatePaths()
      • HiveInterface.userTemplateSavePath()
      • HiveInterface.exporterPluginPaths()
      • HiveInterface.exporterPluginOverrides()
      • HiveInterface.namingPresetPaths()
      • HiveInterface.namingPresetHierarchy()
      • HiveInterface.namingPresetSavePath()
      • HiveInterface.setNamingPresetHierarchy()
      • HiveInterface.setNamingPresetPaths()
      • HiveInterface.setNamingPresetSavePath()
      • HiveInterface.setUserBuildScripts()
      • HiveInterface.setUserComponentPaths()
      • HiveInterface.setUserBuildScriptPaths()
      • HiveInterface.setUserTemplatePaths()
      • HiveInterface.setUserTemplateSavePath()
• Tooldata
  • RootAlreadyExistsError
  • RootDoesntExistError
  • InvalidSettingsPath
  • InvalidRootError
  • ToolSet
    • ToolSet.rootNameForPath()
    • ToolSet.root()
    • ToolSet.addRoot()
    • ToolSet.deleteRoot()
    • ToolSet.findSetting()
    • ToolSet.settingFromRootPath()
    • ToolSet.createSetting()
    • ToolSet.open()
  • SettingObject
    • SettingObject.rootPath()
    • SettingObject.path()
    • SettingObject.isValid()
    • SettingObject.save()
  • DirectoryPath
    • DirectoryPath.serialize()
• Git Wrapper
  • DirtyGitRepoException
  • IncorrectCurrentBranchException
  • GitCommandError
  • InvalidGitRepositoryError
  • GitRepo
    • GitRepo.clone()
    • GitRepo.checkout()
    • GitRepo.assertRepo()
    • GitRepo.archive()
    • GitRepo.tags()
    • GitRepo.latestTag()
    • GitRepo.commit()
    • GitRepo.createTag()
    • GitRepo.pushChanges()
    • GitRepo.pullTags()
    • GitRepo.pushTag()
    • GitRepo.hasChangesSinceLastTag()
    • GitRepo.commitMessagesSinceTag()
    • GitRepo.latestCommitMsg()
  • Commit
    • Commit.date
    • Commit.author
    • Commit.message
  • tagToChangeLog()
• Change Log
  • Changelog
    • Changelog.children()
    • Changelog.sortedVersions()
    • Changelog.printTree()
    • Changelog.asRstLines()
  • ChangelogVersion
    • ChangelogVersion.parseString()
    • ChangelogVersion.label
    • ChangelogVersion.children()
    • ChangelogVersion.asRstLines()
  • ChangelogCategory
    • ChangelogCategory.children()
    • ChangelogCategory.sortMessages()
    • ChangelogCategory.asRstLines()
  • ChangeMessage
    • ChangeMessage.parseString()
    • ChangeMessage.asRst()
  • parseChangelog()
  • parseChangeLogFile()
  • createRstTitle()
  • parseCategory()
  • iterChangelog()
• Utilties
  • Environment handling
    • addToEnv()
    • removeFromEnv()
    • isInMaya()
    • isMayapy()
    • isMayaBatch()
    • isMaya()
    • isIn3dsmax()
    • isInMotionBuilder()
    • isInHoudini()
    • isInBlender()
    • application()
    • machineInfo()
    • user()
    • isMac()
    • isWindows()
    • isLinux()
    • isUnixBased()
    • currentOS()
    • isPy3()
    • addToSysPath()
  • Filesystem
    • ensureFolderExists()
    • loadJson()
    • saveJson()
    • zipdir()
  • Processes
    • SubprocessError
    • subprocessCheckOutput()
    • checkOutput()
    • Singleton
    • ObjectDict
    • importModule()
    • validModulePath()
    • iterModules()
    • iterMembers()
    • isDottedPath()
    • iterSubclassesFromModule()
    • asDottedPath()
    • runScriptFunction()
    • CentralLogManager
      • CentralLogManager.addLog()
      • CentralLogManager.removeLog()
      • CentralLogManager.changeLevel()
      • CentralLogManager.addRotateHandler()
      • CentralLogManager.addShellHandler()
      • CentralLogManager.addNullHandler()
      • CentralLogManager.addHandler()
      • CentralLogManager.removeHandlers()
    • logLevels()
    • levelsDict()
    • getLogger()
    • globalLogLevelOverride()
    • reloadLoggerHierarchy()
    • iterLoggers()
    • rootLogger()
    • setGlobalDebug()
    • isGlobalDebug()
    • flushUnder()
    • reloadZoo()
    • camelToNice()
    • titleCase()
    • newLines()
    • isStr()
    • fileSafeName()
    • wordWrapPath()
    • shortenPath()
    • trailingNumber()
    • incrementName()
    • findNonAscii()
    • isAscii()
  • Profiling
    • profileit()
    • profileItEnv()
    • fnTimer()
• Exception Types
  • PackageAlreadyExists
  • MissingPackageVersion
  • MissingPackage
  • DescriptorMissingKeys
  • UnsupportedDescriptorType
  • MissingGitPython
  • InvalidPackagePath
  • MissingEnvironmentPath
  • GitTagAlreadyExists
  • MissingCliArgument