Folders creation¶
Project¶
- odin.source.core.project.create_project(root: str, project: str) bool¶
- Parameters
root (str) – root path of the project without the slash at the end
project (str) – project name
- Returns
True if the project was created, False if it was not
- Return type
bool
- odin.source.core.project.find_project(root: str) List[str]¶
Get the projects available in the root path
- Parameters
root (str) – root path
- Returns
return all projects found
- Return type
list (str)
Assets¶
- odin.source.core.assets.create_asset(root: str, project: str, asset_name: str, asset_type: str) bool¶
- Parameters
root (str) – root path of the project without the slash at the end
project (str) – project
asset_name (str) – asset name
asset_type (str) – CHARA or PROPS
- Returns
True if the project was created, False if it was not
- Return type
bool
- odin.source.core.assets.find_assets(root: str, project: str, type_: str) List[str]¶
- Parameters
root (str) –
project (str) –
type (str) – CHARACTER, PROPS folder
- Returns
assets found in the folder
- Return type
list (str)
Sets¶
- odin.source.core.sets.create_set(root: str, project: str, set_name: str, asset_type: Optional[str] = 'SET') bool¶
- Parameters
root (str) – root path of the project without the slash at the end
project (str) – project
set_name (str) – asset name
asset_type (str) – SET by default
- Returns
True if the project was created, False if it was not
- Return type
bool
- odin.source.core.sets.find_sets(root: str, project: str, type_: Optional[str] = 'SET') List[str]¶
- Parameters
root (str) –
project (str) –
type (str) – SET folder by default
- Returns
assets found in the folder
- Return type
list(str)
FX¶
- odin.source.core.fx.create_fx(root: str, project: str, fx_name: str, asset_type: Optional[str] = 'FX') bool¶
- Parameters
root (str) – root path of the project without the slash at the end
project (str) – project
set_name (str) – asset name
asset_type (str) – FX by default
- Returns
True if the project was created, False if it was not
- Return type
bool
- odin.source.core.fx.find_fx(root: str, project: str, type_: Optional[str] = 'FX') List[str]¶
- Parameters
root (str) –
project (str) –
type (str) – FX folder by default
- Returns
assets found in the folder
- Return type
list(str)
Sequences¶
- odin.source.core.sequence.create_sequences(root: str, project: str, sequence: str) bool¶
- Parameters
root (str) – root path of the project without the slash at the end
project (str) – project
sequence (str) – sequence name
- Returns
True if the project was created, False if it was not
- Return type
bool
- odin.source.core.sequence.find_sequences(root: str, project: str) List[str]¶
- Parameters
root (str) –
project (str) –
- Returns
sequences found in the folder
- Return type
list (str)
Shots¶
- odin.source.core.shot.create_shot(root: str, project: str, seq: str, shot: str) bool¶
- Parameters
root (str) – root path of the project without the slash at the end
project (str) – project
sequence (str) – sequence name
shot (str) – shot name
- Returns
True if the project was created, False if it was not
- Return type
bool
- odin.source.core.shot.find_shots(root: str, project: str, seq: str) List[str]¶
- Parameters
root (str) –
project (str) –
seq (str) –
- Returns
shots found in the folder
- Return type
list (str)