wapi.repository#
Use this module to interact with the wizard repository database.
- wapi.repository.users()#
Return a list of user names. This function takes no parameters
- Returns:
The users names list.
- Return type:
list[str]
- wapi.repository.create_user(user_name, user_password, email, administrator_pass='')#
Create a user with the given parameters. Enter the administrator password to apply administrator privileges to the new user.
- Parameters:
user_name (str) – The user name
user_password (str) – The user password
email (str) – The user email
administrator_pass (str) – The administrator password ( optionnal )
- Returns:
The success
- Return type:
bool
- wapi.repository.projects()#
Return a list of projects names. This function takes no parameters
- Returns:
The projects names list.
- Return type:
list[str]
- wapi.repository.create_project(project_name, project_path, project_password, frame_rate=24, image_format=[1920, 1080])#
Create a project with the given parameters.
- Parameters:
project_name (str) – The project name
project_path (str) – The project path
project_password (str) – The project password
frame_rate (int) – The frame rate of the project
image_format ([int, inte]) – The format of the project
- Returns:
The success
- Return type:
bool
- wapi.repository.upgrade_user_privilege(user_name, administrator_pass)#
Upgrade the privileges of the given user, needs the administrator password.
- Parameters:
user_name (str) – The user name
administrator_pass (str) – The administrator password
- Returns:
The success
- Return type:
bool
- wapi.repository.downgrade_user_privilege(user_name, administrator_pass)#
Downgrade the privileges of the given user, needs the administrator password.
- Parameters:
user_name (str) – The user name
administrator_pass (str) – The administrator password
- Returns:
The success
- Return type:
bool
- wapi.repository.flush_ips()#
Flush the users ‘cookies’ in the repository database.
- Returns:
The success.
- Return type:
bool