ProjectManager
Attributes
ProjectManager.projects -> List[str]
property
Returns a list with project names in current project manager folder
Returns:
Type | Description |
---|---|
List[str]
|
List[str]: list of project names |
ProjectManager.folders -> List[str]
property
Returns a list with project manager folder names
Returns:
Type | Description |
---|---|
List[str]
|
List[str]: list of folder names |
ProjectManager.folder -> str
property
Returns current folder name
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
folder name |
ProjectManager.db -> Dict[str, str]
writable
property
Gets or sets current database.
For setting a Disk DB
ProjectManager.db = {
'DbType': 'Disk',
'DbName': 'Local Database'
}
For setting a PostgresSQL db
ProjectManager.db = {
'DbType': 'PostgreSQL',
'DbName': 'PostgresDB',
'IpAddress': '127.0.0.1'
}
Parameters:
Name | Type | Description | Default |
---|---|---|---|
db_info |
dict
|
valid |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
Dict[str, str]
|
|
ProjectManager.db_list -> List[Dict[str, str]]
property
Returns list of all databases
Returns:
Type | Description |
---|---|
List[Dict[str, str]]
|
list of databases |
Functions
ProjectManager.create_project(project_name: str) -> Project
Creates a project with project_name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_name |
str
|
project name |
required |
Returns:
Name | Type | Description |
---|---|---|
Project |
Project
|
Project |
ProjectManager.delete_project(project_name: str) -> bool
Deletes project project_name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_name |
str
|
project name |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.load_project(project_name: str) -> Project
Loads project project_name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_name |
str
|
project name |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
Project
|
|
ProjectManager.close_project(project_name: Project) -> bool
Closes project project_name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_name |
str
|
project name |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.create_folder(folder_name: str) -> bool
Creates project manager folder folder_name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
folder_name |
str
|
folder name |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.delete_folder(folder_name: str) -> bool
Deletes project manager folder folder_name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
folder_name |
str
|
folder name |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.goto_root_folder() -> bool
Goes to root project manager folder
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.goto_parent_folder() -> bool
Goes to parent of current project manager folder
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.open_folder(folder_name: str) -> bool
Open folder named folder_name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
folder_name |
str
|
folder name |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.import_project(path: str) -> bool
Imports .drp
project located at path
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
path to |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.export_project(project_name: str, path: str, stills_and_luts: bool = False) -> bool
Exports project
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_name |
str
|
project to be exported |
required |
path |
str
|
path to export to |
required |
stills_and_luts |
bool
|
whether to export with Stills and LUTs. Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|
ProjectManager.restore_project(path: str) -> bool
Restore project from path
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
project path |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
|