tk-core
Overview
Initialization and startup
Core
Apps, Engines and Frameworks
Utilities
Descriptors
Authentication
Environment Variables
Alphabetic Index
tk-core
v0.21.8.
This documentation is part of the Flow Production Tracking. For more information, please visit
The Flow Production Tracking developer portal.
. The code associated with this documentation can be found
here
.
Privacy settings
Do not sell my personal information
Privacy/Cookies
tk-core
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
_create_dialog() (sgtk.platform.Engine method)
_create_dialog_with_widget() (sgtk.platform.Engine method)
_create_widget() (sgtk.platform.Engine method)
_define_qt_base() (sgtk.platform.Engine method)
_emit_event() (sgtk.platform.Engine method)
_emit_log_message() (sgtk.platform.Engine method)
_ensure_core_fonts_loaded() (sgtk.platform.Engine method)
_get_dialog_parent() (sgtk.platform.Engine method)
_glob_and_match() (sgtk.platform.SoftwareLauncher method)
_initialize_dark_look_and_feel() (sgtk.platform.Engine method)
_is_supported() (sgtk.platform.SoftwareLauncher method)
_on_dialog_closed() (sgtk.platform.Engine method)
A
abstract_paths_from_template() (sgtk.Sgtk method)
additional_entities (sgtk.Context property)
app_store_proxy (sgtk.util.UserSettings property)
AppDescriptor (class in sgtk.descriptor)
append_path_to_env_var() (in module sgtk.util)
Application (class in sgtk.platform)
apply_fields() (sgtk.Template method)
apps (sgtk.platform.Engine property)
are_credentials_expired() (sgtk.authentication.ShotgunUser method)
args (sgtk.platform.LaunchInformation property)
(sgtk.platform.SoftwareVersion property)
as_descriptor_uri() (sgtk.util.ShotgunPath method)
as_shotgun_dict() (sgtk.util.ShotgunPath method)
as_system_dict() (sgtk.util.ShotgunPath method)
as_template_fields() (sgtk.Context method)
ask_yn_question() (sgtk.CommandInteraction method)
ask_yna_question() (sgtk.CommandInteraction method)
associated_core_descriptor (sgtk.descriptor.ConfigDescriptor property)
associated_core_version_less_than() (sgtk.descriptor.ConfigDescriptor method)
async_execute_in_main_thread() (sgtk.platform.Engine method)
AuthenticationCancelled (class in sgtk.authentication)
AuthenticationError (class in sgtk.authentication)
B
backup_folder() (in module sgtk.util.filesystem)
base_configuration (sgtk.bootstrap.ToolkitManager property)
base_file_handler (sgtk.log.LogManager property)
before_register_publish
module
BeforeRegisterPublish (class in before_register_publish)
bootstrap
module
Bootstrap (class in bootstrap)
bootstrap_engine() (sgtk.bootstrap.ToolkitManager method)
bootstrap_engine_async() (sgtk.bootstrap.ToolkitManager method)
bundle_cache_fallback_paths (sgtk.bootstrap.ToolkitManager property)
(sgtk.Sgtk property)
bundle_init
module
BundleInit (class in bundle_init)
C
cache_location
module
cache_location (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
CacheLocation (class in cache_location)
caching_policy (sgtk.bootstrap.ToolkitManager property)
can_cache_bundle() (bootstrap.Bootstrap method)
category (sgtk.SgtkSystemCommand property)
change_context() (in module sgtk.platform)
(sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
changelog (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
check_version_constraints() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
choices (sgtk.TemplateKey property)
clear_busy() (sgtk.platform.Engine method)
clear_default_user() (sgtk.authentication.ShotgunAuthenticator method)
clone_cache() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
CommandInteraction (class in sgtk)
commands (sgtk.platform.Engine property)
compute_folder_size() (in module sgtk.util.filesystem)
ConfigDescriptor (class in sgtk.descriptor)
configuration_descriptor (sgtk.Sgtk property)
configuration_id (sgtk.Sgtk property)
configuration_mode (sgtk.Sgtk property)
configuration_name (sgtk.Sgtk property)
configuration_schema (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
ConsoleLoginNotSupportedError (class in sgtk.authentication)
Context (class in sgtk)
context (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.platform.SoftwareLauncher property)
context_change
module
context_change_allowed (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
context_empty() (sgtk.Sgtk method)
context_from_entity() (sgtk.Sgtk method)
context_from_entity_dictionary() (sgtk.Sgtk method)
context_from_path() (sgtk.Sgtk method)
ContextChange (class in context_change)
copy() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
copy_file() (in module sgtk.util.filesystem)
copy_folder() (in module sgtk.util.filesystem)
CoreDescriptor (class in sgtk.descriptor)
create_copy_for_user() (sgtk.Context method)
create_descriptor() (in module sgtk.descriptor)
create_engine_launcher() (in module sgtk.platform)
create_event_log_entry() (in module sgtk.util)
create_filesystem_structure() (sgtk.Sgtk method)
create_hook_instance() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
create_script_user() (sgtk.authentication.ShotgunAuthenticator method)
create_session_user() (sgtk.authentication.ShotgunAuthenticator method)
create_sg_connection() (sgtk.authentication.ShotgunUser method)
create_valid_filename() (in module sgtk.util.filesystem)
created_qt_dialogs (sgtk.platform.Engine property)
current_bundle() (in module sgtk.platform)
current_engine() (in module sgtk.platform)
current_os (sgtk.util.ShotgunPath property)
D
default (sgtk.TemplateKey property)
default_login (sgtk.util.UserSettings property)
default_site (sgtk.util.UserSettings property)
default_storage_root
module
DefaultsManager (class in sgtk.authentication)
DefaultStorageRoot (class in default_storage_root)
definition (sgtk.Template property)
deprecation_status (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
description (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.SgtkSystemCommand property)
descriptor_dict_to_uri() (in module sgtk.descriptor)
descriptor_uri_to_dict() (in module sgtk.descriptor)
deserialize() (sgtk.Context class method)
deserialize_user() (in module sgtk.authentication)
destroy() (sgtk.platform.Engine method)
destroy_app() (sgtk.platform.Application method)
destroy_engine() (sgtk.platform.Engine method)
destroy_framework() (sgtk.platform.Framework method)
disk_location (sgtk.Hook property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.platform.SoftwareLauncher property)
display_name (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.platform.SoftwareLauncher property)
(sgtk.platform.SoftwareVersion property)
do_shotgun_config_lookup (sgtk.bootstrap.ToolkitManager property)
documentation_url (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.Sgtk property)
download_and_unpack_attachment() (in module sgtk.util.shotgun)
download_and_unpack_url() (in module sgtk.util.shotgun)
download_local() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
download_url() (in module sgtk.util)
dump() (in module sgtk.util.pickle)
dumps() (in module sgtk.util.pickle)
E
Engine (class in sgtk.platform)
engine (sgtk.platform.Application property)
(sgtk.platform.Framework property)
engine_init
module
engine_name (sgtk.platform.SoftwareLauncher property)
EngineDescriptor (class in sgtk.descriptor)
EngineInit (class in engine_init)
ensure_folder_exists
module
ensure_folder_exists() (in module sgtk.util.filesystem)
(sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
ensure_local() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
ensure_shotgun_fields_exist() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
EnsureFolderExists (class in ensure_folder_exists)
entity (sgtk.Context property)
entity_from_path() (sgtk.Sgtk method)
entity_locations (sgtk.Context property)
environment (sgtk.platform.Engine property)
(sgtk.platform.LaunchInformation property)
EnvironmentVariableFileLookupError (class in sgtk.util)
event_engine() (sgtk.platform.Application method)
event_file_close() (sgtk.platform.Application method)
event_file_open() (sgtk.platform.Application method)
example_template_hook
module
ExampleTemplateHook (class in example_template_hook)
exclusions (sgtk.TemplateKey property)
execute() (before_register_publish.BeforeRegisterPublish method)
(bundle_init.BundleInit method)
(default_storage_root.DefaultStorageRoot method)
(engine_init.EngineInit method)
(ensure_folder_exists.EnsureFolderExists method)
(example_template_hook.ExampleTemplateHook method)
(get_current_login.GetCurrentLogin method)
(pick_environment.PickEnvironment method)
(pipeline_configuration_init.PipelineConfigurationInit method)
(process_folder_creation.ProcessFolderCreation method)
(process_folder_name.ProcessFolderName method)
(sgtk.SgtkSystemCommand method)
(tank_init.TankInit method)
execute_hook() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
execute_hook_by_name() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
execute_hook_expression() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
execute_hook_method() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
execute_in_main_thread() (sgtk.platform.Engine method)
exists_local() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
extract_settings() (sgtk.bootstrap.ToolkitManager method)
F
filesystem_locations (sgtk.Context property)
filter_by (sgtk.StringKey property)
find_app_settings() (in module sgtk.platform)
find_latest_cached_version() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
find_latest_version() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
find_publish() (in module sgtk.util)
format_spec (sgtk.IntegerKey property)
(sgtk.TimestampKey property)
Framework (class in sgtk.platform)
FrameworkDescriptor (class in sgtk.descriptor)
frameworks (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
from_current_os_path() (sgtk.util.ShotgunPath class method)
from_dict() (sgtk.Context class method)
from_shotgun_dict() (sgtk.util.ShotgunPath class method)
from_system_dict() (sgtk.util.ShotgunPath class method)
G
get_associated_core_feature_info() (sgtk.descriptor.ConfigDescriptor method)
get_authenticated_user() (in module sgtk)
get_boolean_setting() (sgtk.util.UserSettings method)
get_bundle_data_cache_path() (cache_location.CacheLocation method)
get_command() (in module sgtk)
(sgtk.Sgtk method)
get_configuration_root() (sgtk.util.LocalFileStorageManager class method)
get_core_python_path() (sgtk.bootstrap.ToolkitManager static method)
get_core_python_path_for_config() (in module sgtk)
get_current_login
module
get_current_user() (in module sgtk.util)
get_debug_tracked_qt_widgets() (sgtk.platform.Engine method)
get_default_host() (sgtk.authentication.ShotgunAuthenticator method)
get_default_http_proxy() (sgtk.authentication.ShotgunAuthenticator method)
get_default_user() (sgtk.authentication.ShotgunAuthenticator method)
get_dict() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
get_engine_path() (in module sgtk.platform)
get_entity_from_environment() (sgtk.bootstrap.ToolkitManager method)
get_entity_type_display_name() (in module sgtk.util)
get_feature_info() (sgtk.descriptor.CoreDescriptor method)
get_fields() (sgtk.Template method)
get_file_name_from_template() (sgtk.util.ShotgunPath static method)
get_framework() (in module sgtk.platform)
get_global_root() (sgtk.util.LocalFileStorageManager class method)
get_hook_baseclass() (in module sgtk)
get_host() (sgtk.authentication.DefaultsManager method)
get_http_proxy() (sgtk.authentication.DefaultsManager method)
get_integer_setting() (sgtk.util.UserSettings method)
get_location() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
get_logger() (in module sgtk.platform)
(sgtk.log.LogManager static method)
get_login() (sgtk.authentication.DefaultsManager method)
get_matching_commands() (sgtk.platform.Engine method)
get_metrics_properties() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
get_path() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
get_path_cache_path() (cache_location.CacheLocation method)
get_pipeline_configurations() (sgtk.bootstrap.ToolkitManager method)
get_project_cache_location() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
get_publish_path() (sgtk.Hook method)
get_published_file_entity_type() (in module sgtk.util)
get_python_interpreter_for_config() (in module sgtk)
get_section_settings() (sgtk.util.UserSettings method)
get_setting() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
(sgtk.platform.SoftwareLauncher method)
(sgtk.util.UserSettings method)
get_sg_entity_name_field() (in module sgtk.util)
get_sgtk_module_path() (in module sgtk)
get_shotgun_storage_key() (sgtk.util.ShotgunPath static method)
get_site_root() (sgtk.util.LocalFileStorageManager class method)
get_standard_plugin_environment() (sgtk.platform.SoftwareLauncher method)
get_template() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
get_template_by_name() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
get_unused_path() (in module sgtk.util.filesystem)
get_uri() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
get_user() (sgtk.authentication.ShotgunAuthenticator method)
get_user_credentials() (sgtk.authentication.DefaultsManager method)
get_user_from_prompt() (sgtk.authentication.ShotgunAuthenticator method)
GetCurrentLogin (class in get_current_login)
global_debug (sgtk.log.LogManager property)
H
has_qt5 (sgtk.platform.Engine property)
has_qt6 (sgtk.platform.Engine property)
has_remote_access() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
has_ui (sgtk.platform.Engine property)
Hook (class in sgtk)
host (sgtk.authentication.ShotgunUser property)
host_info (sgtk.platform.Engine property)
http_proxy (sgtk.authentication.ShotgunUser property)
I
icon (sgtk.platform.SoftwareVersion property)
icon_256 (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
import_framework() (in module sgtk.platform)
import_module() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
IncompleteCredentials (class in sgtk.authentication)
init() (bootstrap.Bootstrap method)
init_app() (sgtk.platform.Application method)
init_framework() (sgtk.platform.Framework method)
initialize_base_file_handler() (sgtk.log.LogManager method)
initialize_base_file_handler_from_path() (sgtk.log.LogManager method)
initialize_custom_handler() (sgtk.log.LogManager method)
instance_name (sgtk.platform.Application property)
(sgtk.platform.Engine property)
IntegerKey (class in sgtk)
is_abstract (sgtk.TemplateKey property)
is_descriptor_version_missing() (in module sgtk.descriptor)
is_dev() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
is_host_fixed() (sgtk.authentication.DefaultsManager method)
is_immutable() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.ConfigDescriptor method)
(sgtk.descriptor.CoreDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
is_linux() (in module sgtk.util)
is_macos() (in module sgtk.util)
is_optional() (sgtk.Template method)
is_shared (sgtk.platform.Framework property)
is_shared_framework() (sgtk.descriptor.FrameworkDescriptor method)
is_version_newer() (in module sgtk.util)
is_version_newer_or_equal() (in module sgtk.util)
is_version_older() (in module sgtk.util)
is_version_older_or_equal() (in module sgtk.util)
is_windows() (in module sgtk.util)
J
join() (sgtk.util.ShotgunPath method)
K
keys (sgtk.Template property)
L
labelled_choices (sgtk.TemplateKey property)
LaunchInformation (class in sgtk.platform)
length (sgtk.TemplateKey property)
linux (sgtk.util.ShotgunPath property)
list_commands() (in module sgtk)
(sgtk.Sgtk method)
load() (in module sgtk.util.json)
(in module sgtk.util.pickle)
load_framework() (sgtk.Hook method)
loads() (in module sgtk.util.json)
(in module sgtk.util.pickle)
LocalFileStorageManager (class in sgtk.util)
log_debug() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
log_error() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
log_exception() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
log_file (sgtk.log.LogManager property)
log_folder (sgtk.log.LogManager property)
log_info() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
log_metrics
module
log_metrics() (log_metrics.LogMetrics method)
log_timing() (sgtk.log.LogManager static method)
log_warning() (sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
logger (sgtk.Hook property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.platform.SoftwareLauncher property)
(sgtk.SgtkSystemCommand property)
login (sgtk.authentication.ShotgunUser property)
LogManager (class in sgtk.log)
LogMetrics (class in log_metrics)
M
macosx (sgtk.util.ShotgunPath property)
metrics_dispatch_allowed (sgtk.platform.Engine property)
minimum_supported_version (sgtk.platform.SoftwareLauncher property)
missing_keys() (sgtk.Template method)
module
before_register_publish
bootstrap
bundle_init
cache_location
context_change
default_storage_root
engine_init
ensure_folder_exists
example_template_hook
get_current_login
log_metrics
pick_environment
pipeline_configuration_init
process_folder_creation
process_folder_name
resolve_publish
sgtk.log
tank_init
move_folder() (in module sgtk.util.filesystem)
N
name (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.SgtkSystemCommand property)
(sgtk.TemplateKey property)
normalize() (sgtk.util.ShotgunPath class method)
O
ordered_keys (sgtk.Template property)
P
panels (sgtk.platform.Engine property)
parameters (sgtk.SgtkSystemCommand property)
parent (sgtk.Hook property)
(sgtk.Template property)
(sgtk.TemplatePath property)
(sgtk.TemplateString property)
path (sgtk.platform.LaunchInformation property)
(sgtk.platform.SoftwareVersion property)
paths_from_entity() (sgtk.Sgtk method)
paths_from_template() (sgtk.Sgtk method)
pick_environment
module
PickEnvironment (class in pick_environment)
pipeline_configuration (sgtk.bootstrap.ToolkitManager property)
pipeline_configuration_init
module
PipelineConfigurationInit (class in pipeline_configuration_init)
plugin_id (sgtk.bootstrap.ToolkitManager property)
populate_bundle_cache_entry() (bootstrap.Bootstrap method)
post_app_init() (sgtk.platform.Engine method)
post_context_change() (context_change.ContextChange method)
(sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
post_engine_init() (sgtk.platform.Application method)
pre_app_init() (sgtk.platform.Engine method)
pre_context_change() (context_change.ContextChange method)
(sgtk.platform.Application method)
(sgtk.platform.Engine method)
(sgtk.platform.Framework method)
pre_engine_start_callback (sgtk.bootstrap.ToolkitManager property)
prepare_engine() (sgtk.bootstrap.ToolkitManager method)
prepare_launch() (sgtk.platform.SoftwareLauncher method)
prepend_path_to_env_var() (in module sgtk.util)
preview_filesystem_structure() (sgtk.Sgtk method)
process_folder_creation
module
process_folder_name
module
ProcessFolderCreation (class in process_folder_creation)
ProcessFolderName (class in process_folder_name)
product (sgtk.platform.SoftwareVersion property)
products (sgtk.platform.SoftwareLauncher property)
progress_callback (sgtk.bootstrap.ToolkitManager property)
project (sgtk.Context property)
project_path (sgtk.Sgtk property)
PublishPathNotDefinedError (class in sgtk.util)
PublishPathNotSupported (class in sgtk.util)
PublishResolveError (class in sgtk.util)
python_interpreter (sgtk.descriptor.ConfigDescriptor property)
R
readme_content (sgtk.descriptor.ConfigDescriptor property)
reasons (sgtk.descriptor.TankCheckVersionConstraintsError property)
refresh_credentials() (sgtk.authentication.ShotgunUser method)
register_command() (sgtk.platform.Engine method)
register_panel() (sgtk.platform.Engine method)
register_publish() (in module sgtk.util)
register_toggle_debug_command (sgtk.platform.Engine property)
reload_templates() (sgtk.Sgtk method)
request_input() (sgtk.CommandInteraction method)
required_context (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
required_frameworks (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
required_storages (sgtk.descriptor.ConfigDescriptor property)
resolve_descriptor() (sgtk.bootstrap.ToolkitManager method)
resolve_entity() (sgtk.authentication.ShotgunUser method)
resolve_path() (resolve_publish.ResolvePublish method)
resolve_publish
module
resolve_publish_path() (in module sgtk.util)
ResolvePublish (class in resolve_publish)
restart() (in module sgtk.platform)
restore_settings() (sgtk.bootstrap.ToolkitManager method)
root_logger (sgtk.log.LogManager property)
root_path (sgtk.TemplatePath property)
roots (sgtk.Sgtk property)
run_post_install() (sgtk.descriptor.AppDescriptor method)
(sgtk.descriptor.EngineDescriptor method)
(sgtk.descriptor.FrameworkDescriptor method)
S
safe_delete_file() (in module sgtk.util.filesystem)
safe_delete_folder() (in module sgtk.util.filesystem)
scan_software() (sgtk.platform.SoftwareLauncher method)
SequenceKey (class in sgtk)
serialize() (sgtk.Context method)
serialize_user() (in module sgtk.authentication)
set_authenticated_user() (in module sgtk)
set_host() (sgtk.authentication.DefaultsManager method)
set_logger() (sgtk.SgtkSystemCommand method)
set_login() (sgtk.authentication.DefaultsManager method)
Sgtk (class in sgtk)
sgtk (sgtk.Context property)
(sgtk.Hook property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.platform.SoftwareLauncher property)
sgtk.log
module
sgtk_from_entity() (in module sgtk)
sgtk_from_path() (in module sgtk)
SgtkSystemCommand (class in sgtk)
shotgun (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.platform.SoftwareLauncher property)
(sgtk.Sgtk property)
shotgun_entity_type (sgtk.TemplateKey property)
shotgun_field_name (sgtk.TemplateKey property)
SHOTGUN_PATH_FIELDS (sgtk.util.ShotgunPath attribute)
shotgun_proxy (sgtk.util.UserSettings property)
shotgun_url (sgtk.Context property)
(sgtk.Sgtk property)
ShotgunAuthenticationError (class in sgtk.authentication)
ShotgunAuthenticator (class in sgtk.authentication)
ShotgunPath (class in sgtk.util)
ShotgunPublishError (class in sgtk.util)
ShotgunUser (class in sgtk.authentication)
show_busy() (sgtk.platform.Engine method)
show_dialog() (sgtk.platform.Engine method)
show_modal() (sgtk.platform.Engine method)
show_panel() (sgtk.platform.Engine method)
site_cache_location (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
SoftwareLauncher (class in sgtk.platform)
SoftwareVersion (class in sgtk.platform)
source_entity (sgtk.Context property)
start_engine() (in module sgtk.platform)
step (sgtk.Context property)
storage_roots (sgtk.descriptor.ConfigDescriptor property)
str_from_value() (sgtk.TemplateKey method)
strict_matching (sgtk.IntegerKey property)
StringKey (class in sgtk)
style_constants (sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
subset (sgtk.StringKey property)
subset_format (sgtk.StringKey property)
support_url (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
supported_engines (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
supported_platforms (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
supports_interaction (sgtk.CommandInteraction property)
synchronize_filesystem_structure() (sgtk.Sgtk method)
system_name (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
T
tank (sgtk.Hook property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
tank_init
module
TankAppStoreConnectionError (class in sgtk.descriptor)
TankAppStoreError (class in sgtk.descriptor)
TankBootstrapError (class in sgtk.bootstrap)
TankCheckVersionConstraintsError (class in sgtk.descriptor)
TankContextChangeNotSupportedError (class in sgtk.platform)
TankDescriptorError (class in sgtk.descriptor)
TankEngineInitError (class in sgtk.platform)
TankError (class in sgtk)
TankErrorProjectIsSetup (class in sgtk)
TankFileDoesNotExistError (class in sgtk)
TankHookMethodDoesNotExistError (class in sgtk)
TankInit (class in tank_init)
TankInvalidAppStoreCredentialsError (class in sgtk.descriptor)
TankInvalidCoreLocationError (class in sgtk)
TankInvalidInterpreterLocationError (class in sgtk.descriptor)
TankMissingEngineError (class in sgtk.platform)
TankMissingManifestError (class in sgtk.descriptor)
TankMissingTankNameError (class in sgtk.bootstrap)
TankNotPipelineConfigurationError (class in sgtk)
TankUnreadableFileError (class in sgtk)
task (sgtk.Context property)
Template (class in sgtk)
template_from_path() (sgtk.Sgtk method)
TemplateKey (class in sgtk)
TemplatePath (class in sgtk)
templates (sgtk.Sgtk property)
templates_from_path() (sgtk.Sgtk method)
TemplateString (class in sgtk)
terminate() (sgtk.SgtkSystemCommand method)
TimestampKey (class in sgtk)
to_dict() (sgtk.Context method)
ToolkitManager (class in sgtk.bootstrap)
touch_file() (in module sgtk.util.filesystem)
U
uninitialize_base_file_handler() (sgtk.log.LogManager method)
UnresolvableHumanUser (class in sgtk.authentication)
UnresolvableScriptUser (class in sgtk.authentication)
user (sgtk.Context property)
UserSettings (class in sgtk.util)
V
validate() (sgtk.IntegerKey method)
(sgtk.SequenceKey method)
(sgtk.StringKey method)
(sgtk.Template method)
(sgtk.TemplateKey method)
(sgtk.TimestampKey method)
validate_and_get_fields() (sgtk.Template method)
value_from_str() (sgtk.StringKey method)
(sgtk.TemplateKey method)
version (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
(sgtk.platform.Application property)
(sgtk.platform.Engine property)
(sgtk.platform.Framework property)
(sgtk.platform.SoftwareVersion property)
(sgtk.Sgtk property)
version_constraints (sgtk.descriptor.AppDescriptor property)
(sgtk.descriptor.ConfigDescriptor property)
(sgtk.descriptor.CoreDescriptor property)
(sgtk.descriptor.EngineDescriptor property)
(sgtk.descriptor.FrameworkDescriptor property)
versions (sgtk.platform.SoftwareLauncher property)
W
windows (sgtk.util.ShotgunPath property)
with_cleared_umask() (in module sgtk.util.filesystem)
with_traceback() (sgtk.bootstrap.TankBootstrapError method)
(sgtk.bootstrap.TankMissingTankNameError method)
(sgtk.descriptor.TankAppStoreConnectionError method)
(sgtk.descriptor.TankAppStoreError method)
(sgtk.descriptor.TankCheckVersionConstraintsError method)
(sgtk.descriptor.TankDescriptorError method)
(sgtk.descriptor.TankInvalidAppStoreCredentialsError method)
(sgtk.descriptor.TankInvalidInterpreterLocationError method)
(sgtk.descriptor.TankMissingManifestError method)
(sgtk.platform.TankContextChangeNotSupportedError method)
(sgtk.platform.TankEngineInitError method)
(sgtk.platform.TankMissingEngineError method)
(sgtk.TankError method)
(sgtk.TankErrorProjectIsSetup method)
(sgtk.TankFileDoesNotExistError method)
(sgtk.TankHookMethodDoesNotExistError method)
(sgtk.TankInvalidCoreLocationError method)
(sgtk.TankNotPipelineConfigurationError method)
(sgtk.TankUnreadableFileError method)
(sgtk.util.EnvironmentVariableFileLookupError method)
(sgtk.util.PublishPathNotDefinedError method)
(sgtk.util.PublishPathNotSupported method)
(sgtk.util.PublishResolveError method)
(sgtk.util.ShotgunPublishError method)