Skip to main content

helper

Helper functions related to hub and AM interactions.

Module​

Functions​

get_pod_schema​

def get_pod_schema(    pod_identifier: str,    save_file_path: Optional[Union[str, Path]] = None,    hub: Optional[BitfountHub] = None,    username: Optional[str] = None,    project_id: Optional[str] = None,    secrets: Optional[Union[APIKeys, JWT]] = None,) ‑> BitfountSchema:

Get a pod's schema from the hub.

Arguments

  • pod_identifier: The identifier of the pod. If supplied with only pod name assumes the namespace is the current user.
  • save_file_path: Optional. Path to save the downloaded schema to. Won't save if not provided.
  • hub: Optional. The BitfountHub to connect to. The default hub will be used if not provided.
  • username: The username to use when connecting to the hub if a hub instance is not provided.
  • project_id: The project ID to use when connecting to the hub.
  • secrets: Optional. Either APIKeys or JWT to use for authentication.

Returns The loaded BitfountSchema object.