Skip to content

Getting Help

Getting help for a function

To get started with authentication, users can use the code-block shown below:- 

import polly
from polly.auth import Polly
AUTH_TOKEN=(os.environ['POLLY_REFRESH_TOKEN'])
Polly.auth(AUTH_TOKEN)

Once done, for a function in Workspace class, user can initiate workspace object and use help() function as shown below: 

from polly.workspaces import Workspaces
workspaces = Workspaces()
help(workspaces.download_from_workspace)


download_from_workspaces(workspace_id: int, workspace_path: str, local_path: str, copy_workspace_path: bool = True) -> None method of polly.workspaces.Workspaces instance
    Function to download files/folders from workspaces.
    A message will be displayed on the status of the operation.

    Args:
          workspace_id (int): Id of the workspace where file needs to uploaded
          workspace_path (str): Downloaded file on workspace. The workspace path should be prefixed with "polly://"
          copy_workspace_path (bool): Flag indicating whether the workspace path needs to copied in the working directory

    Returns:
          None

Similarly, for a function in Workspaces class, users can initiate workspaces object and use help() function as shown below:

from polly.workspaces import Workspaces
workspace = Workspaces()

help(workspaces.upload_to_workspace)