===============
wapi.repository
===============

Use this module to interact with the wizard repository database.

.. py:function:: wapi.repository.users()

   Return a list of user names.
   This function takes no parameters

   :return: The users names list.
   :rtype: list[str]

.. py:function:: 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.

   :param user_name: The user name
   :type user_name: str
   :param user_password: The user password
   :type user_password: str
   :param email: The user email
   :type email: str
   :param administrator_pass: The administrator password ( optionnal )
   :type administrator_pass: str

   :return: The success
   :rtype: bool

.. py:function:: wapi.repository.projects()

   Return a list of projects names.
   This function takes no parameters

   :return: The projects names list.
   :rtype: list[str]

.. py:function:: wapi.repository.create_project(project_name, project_path, project_password, frame_rate=24, image_format=[1920, 1080])

   Create a project with the given parameters.

   :param project_name: The project name
   :type project_name: str
   :param project_path: The project path
   :type project_path: str
   :param project_password: The project password
   :type project_password: str
   :param frame_rate: The frame rate of the project
   :type frame_rate: int
   :param image_format: The format of the project
   :type image_format: [int, inte]

   :return: The success
   :rtype: bool

.. py:function:: wapi.repository.upgrade_user_privilege(user_name, administrator_pass)

   Upgrade the privileges of the given user, needs the administrator password.

   :param user_name: The user name
   :type user_name: str
   :param administrator_pass: The administrator password
   :type administrator_pass: str
   :return: The success
   :rtype: bool

.. py:function:: wapi.repository.downgrade_user_privilege(user_name, administrator_pass)

   Downgrade the privileges of the given user, needs the administrator password.

   :param user_name: The user name
   :type user_name: str
   :param administrator_pass: The administrator password
   :type administrator_pass: str
   :return: The success
   :rtype: bool

.. py:function:: wapi.repository.flush_ips()

   Flush the users 'cookies' in the repository database.

   :return: The success.
   :rtype: bool