juturna.hub package#

Module contents#

juturna.hub.download_node(node_name: str, destination_folder: str = None, authenticate: bool = False, repository_url: str = None, force: bool = True)#

Download a node from the Juturna hub

Given a target node, download it locally.

Parameters:

  • node_name (str) – The name of the remote node to download (starts with the _ character).

  • destination_folder (str) – The folder the node will be downloaded to. Defaults to JUTURNA_CACHE_DIR when not provided.

  • authenticate (bool) – When true, the request to download the node will be authenticated using the access token defined in JUTURNA_HUB_TOKEN. Defaults to False.

  • repository_url (str) – The repository from which download a node. By default this is None, so the node will be downloaded from JUTURNA_HUB_URL.

  • force (bool) – Will not download the node if one with the same name already exists in the destination folder. Defaults to True.

juturna.hub.download_pipeline(pipe_name: str, destination_folder: str = None, authenticate: bool = False, repository_url: str = False, force: bool = False)#

Download a pipeline from the Juturna hub Given a target pipeline, download it locally. This implies downloading all the nodes and files that are part of the pipeline.

Parameters:

  • pipe_name (str) – The name of the remote pipeline to download.

  • destination_folder (str) – The folder the pipeline will be downloaded to. Defaults to JUTURNA_CACHE_DIR when not provided.

  • authenticate (bool) – When true, the request to download the pipeline will be authenticated using the access token defined in JUTURNA_HUB_TOKEN. Defaults to False.

  • repository_url (str) – The repository from which download a pipeline. By default this is None, so the pipeline will be downloaded from JUTURNA_HUB_URL.

  • force (bool) – Will not download the pipeline if one with the same name already exists in the destination folder. Defaults to True.

juturna.hub.list_plugins(repository_url: str = None, authenticate: bool = False) → dict#

Get a list of remote plugins available for download. This method will look into the JUTURNA_HUB_URL repository, and return a dictionary with both nodes and pipelines. Nodes are returned as a collection of objects where each key is a type of node, and each value is a node name, whilst pipelines are returned as names within a list.

Parameters:

  • repository_url (str) – The repository url to look into. By default this value is None, so the search will be performed on the env variable JUTURNA_HUB_URL.

  • authenticate (bool) – When true, the request to download the node will be authenticated using the access token defined in JUTURNA_HUB_TOKEN. Defaults to False.