divbase-cli 0.1.0.dev2__py3-none-any.whl → 0.1.0.dev3__py3-none-any.whl

divbase_cli/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.0.dev2"
+__version__ = "0.1.0.dev3"

divbase_cli/cli_commands/auth_cli.py

@@ -3,13 +3,11 @@ CLI subcommand for managing user auth with DivBase server.
 """
 
 from datetime import datetime
-from pathlib import Path
 
 import typer
 from pydantic import SecretStr
 from typing_extensions import Annotated
 
-from divbase_cli.cli_commands.user_config_cli import CONFIG_FILE_OPTION
 from divbase_cli.cli_config import cli_settings
 from divbase_cli.cli_exceptions import AuthenticationError
 from divbase_cli.user_auth import (
@@ -30,7 +28,6 @@ def login(
     email: str,
     password: Annotated[str, typer.Option(prompt=True, hide_input=True)],
     divbase_url: str = typer.Option(cli_settings.DIVBASE_API_URL, help="DivBase server URL to connect to."),
-    config_file: Path = CONFIG_FILE_OPTION,
     force: bool = typer.Option(False, "--force", "-f", help="Force login again even if already logged in"),
 ):
     """
@@ -43,7 +40,7 @@ def login(
     secret_password = SecretStr(password)
     del password  # avoid user passwords showing up in error messages etc...
 
-    config = load_user_config(config_file)
+    config = load_user_config()
 
     if not force:
         session_expires_at = check_existing_session(divbase_url=divbase_url, config=config)
@@ -55,7 +52,7 @@ def login(
                 print("Login cancelled.")
                 return
 
-    login_to_divbase(email=email, password=secret_password, divbase_url=divbase_url, config_path=config_file)
+    login_to_divbase(email=email, password=secret_password, divbase_url=divbase_url)
     print(f"Logged in successfully as: {email}")
 
 
@@ -69,13 +66,11 @@ def logout():
 
 
 @auth_app.command("whoami")
-def whoami(
-    config_file: Path = CONFIG_FILE_OPTION,
-):
+def whoami():
     """
     Return information about the currently logged-in user.
     """
-    config = load_user_config(config_file)
+    config = load_user_config()
     logged_in_url = config.logged_in_url
 
     # TODO - move logged in check to the make_authenticated_request function?

divbase_cli/cli_commands/dimensions_cli.py

@@ -1,11 +1,9 @@
 import logging
-from pathlib import Path
 
 import typer
 import yaml
 
-from divbase_cli.cli_commands.user_config_cli import CONFIG_FILE_OPTION
-from divbase_cli.cli_commands.version_cli import PROJECT_NAME_OPTION
+from divbase_cli.cli_commands.shared_args_options import PROJECT_NAME_OPTION
 from divbase_cli.config_resolver import resolve_project
 from divbase_cli.user_auth import make_authenticated_request
 from divbase_lib.api_schemas.vcf_dimensions import DimensionsShowResult
@@ -22,11 +20,10 @@ dimensions_app = typer.Typer(
 @dimensions_app.command("update")
 def update_dimensions_index(
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ) -> None:
     """Calculate and add the dimensions of a VCF file to the dimensions index file in the project."""
 
-    project_config = resolve_project(project_name=project, config_path=config_file)
+    project_config = resolve_project(project_name=project)
 
     response = make_authenticated_request(
         method="PUT",
@@ -53,14 +50,13 @@ def show_dimensions_index(
         )
     ),
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ) -> None:
     """
     Show the dimensions index file for a project.
     When running --unique-scaffolds, the sorting separates between numeric and non-numeric scaffold names.
     """
 
-    project_config = resolve_project(project_name=project, config_path=config_file)
+    project_config = resolve_project(project_name=project)
 
     response = make_authenticated_request(
         method="GET",
@@ -82,7 +78,7 @@ def show_dimensions_index(
         else:
             print(
                 f"No entry found for filename: {filename}. Please check that the filename is correct and that it is a VCF file (extension: .vcf or .vcf.gz)."
-                "\nHint: use 'divbase-cli files list' to view all files in the project."
+                "\nHint: use 'divbase-cli files ls' to view all files in the project."
             )
         return
 

divbase_cli/cli_commands/file_cli.py

@@ -1,51 +1,153 @@
 """
 Command line interface for managing files in a DivBase project's store on DivBase.
 
-TODO - support for specifying versions of files when downloading files?
 TODO - Download all files option.
 TODO - skip checked option (aka skip files that already exist in same local dir with correct checksum).
 """
 
 from pathlib import Path
+from zoneinfo import ZoneInfo
 
 import typer
 from rich import print
+from rich.table import Table
 from typing_extensions import Annotated
 
-from divbase_cli.cli_commands.user_config_cli import CONFIG_FILE_OPTION
-from divbase_cli.cli_commands.version_cli import PROJECT_NAME_OPTION
+from divbase_cli.cli_commands.shared_args_options import FORMAT_AS_TSV_OPTION, PROJECT_NAME_OPTION
+from divbase_cli.cli_exceptions import UnsupportedFileNameError, UnsupportedFileTypeError
 from divbase_cli.config_resolver import ensure_logged_in, resolve_download_dir, resolve_project
-from divbase_cli.services import (
+from divbase_cli.services.s3_files import (
     download_files_command,
+    get_file_info_command,
     list_files_command,
+    restore_objects_command,
     soft_delete_objects_command,
+    stream_file_command,
     upload_files_command,
 )
+from divbase_cli.utils import format_file_size, print_rich_table_as_tsv
+from divbase_lib.divbase_constants import SUPPORTED_DIVBASE_FILE_TYPES, UNSUPPORTED_CHARACTERS_IN_FILENAMES
 
 file_app = typer.Typer(no_args_is_help=True, help="Download/upload/list files to/from the project's store on DivBase.")
 
+NO_FILES_SPECIFIED_MSG = "No files specified for the command, exiting..."
 
-@file_app.command("list")
+
+@file_app.command("ls")
 def list_files(
+    format_output_as_tsv: bool = FORMAT_AS_TSV_OPTION,
+    prefix_filter: str | None = typer.Option(
+        None,
+        "--prefix",
+        "-p",
+        help="Optional prefix to filter the listed files by name (only list files starting with this prefix).",
+    ),
+    include_results_files: bool = typer.Option(
+        False,
+        "--include-results-files",
+        "-r",
+        help="If set, will also show DivBase query results files which are hidden by default.",
+    ),
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ):
     """
-    list all files in the project's DivBase store.
+    list all currently available files in the project's DivBase store.
 
-    To see files at a user specified project version (controlled by the 'divbase-cli version' subcommand),
-    you can instead use the 'divbase-cli version info [VERSION_NAME]' command.
+    You can optionally filter the listed files by providing a prefix.
+    By default, DivBase query results files are hidden from the listing. Use the --include-results-files option to include them.
+    To see information about the versions of each file, use the 'divbase-cli files info [FILE_NAME]' command instead
     """
-    project_config = resolve_project(project_name=project, config_path=config_file)
-    logged_in_url = ensure_logged_in(config_path=config_file, desired_url=project_config.divbase_url)
+    project_config = resolve_project(project_name=project)
+    logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
+
+    files = list_files_command(
+        divbase_base_url=logged_in_url,
+        project_name=project_config.name,
+        prefix_filter=prefix_filter,
+        include_results_files=include_results_files,
+    )
 
-    files = list_files_command(divbase_base_url=logged_in_url, project_name=project_config.name)
     if not files:
         print("No files found in the project's store on DivBase.")
+        return
+
+    table = Table(title=f"Files in [bold]{project_config.name}'s [/bold] DivBase Store:")
+    table.add_column("Name", justify="left", style="cyan")
+    table.add_column("File size", justify="left", style="magenta", no_wrap=True)
+    table.add_column("Upload date (CET)", justify="left", style="green", no_wrap=True)
+    table.add_column("MD5 checksum", justify="left", style="yellow")
+
+    for file_details in files:
+        cet_timestamp = file_details.last_modified.astimezone(ZoneInfo("CET")).strftime("%Y-%m-%d %H:%M:%S %Z")
+        file_size = format_file_size(size_bytes=file_details.size)
+        table.add_row(
+            file_details.name,
+            file_size,
+            cet_timestamp,
+            file_details.etag,
+        )
+
+    if not format_output_as_tsv:
+        print(table)
     else:
-        print(f"Files in the project '{project_config.name}':")
-        for file in files:
-            print(f"- '{file}'")
+        print_rich_table_as_tsv(table=table)
+
+
+@file_app.command("info")
+def file_info(
+    file_name: str = typer.Argument(..., help="Name of the file to get information about."),
+    format_output_as_tsv: bool = FORMAT_AS_TSV_OPTION,
+    project: str | None = PROJECT_NAME_OPTION,
+):
+    """
+    Get detailed information about a specific file in the project's DivBase store.
+
+    This includes all versions of the file and whether the file is currently marked as soft deleted.
+    """
+    project_config = resolve_project(project_name=project)
+    logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
+
+    file_info = get_file_info_command(
+        divbase_base_url=logged_in_url,
+        project_name=project_config.name,
+        object_name=file_name,
+    )
+
+    if not file_info.versions:
+        # API should never return an object with no versions, but just in case
+        print("No available versions for this file.")
+        return
+
+    if file_info.is_currently_deleted:
+        print(
+            "[bold red]Warning: This file is marked as soft deleted.\n[/bold red]"
+            + "[italic]   To restore a deleted file, use the 'divbase-cli files restore' command.\n"
+            + "   Or upload the file again using the 'divbase-cli files upload' command.\n[/italic]",
+        )
+
+    table = Table(
+        title=f"Available Versions for '[bold]{file_info.object_name}[/bold]'",
+        caption="Versions shown are ordered with the latest/current version first/at the top",
+    )
+    table.add_column("File size", justify="left", style="magenta", no_wrap=True)
+    table.add_column("Upload date (CET)", justify="left", style="green", no_wrap=True)
+    table.add_column("MD5 checksum", justify="left", style="yellow")
+    table.add_column("Version ID", justify="left", style="cyan")
+
+    for version in file_info.versions:
+        cet_timestamp = version.last_modified.astimezone(ZoneInfo("CET")).strftime("%Y-%m-%d %H:%M:%S %Z")
+        file_size = format_file_size(size_bytes=version.size)
+        table.add_row(
+            file_size,
+            cet_timestamp,
+            version.etag,
+            version.version_id,
+        )
+
+    if not format_output_as_tsv:
+        print(table)
+    else:
+        print_rich_table_as_tsv(table=table)
 
 
 @file_app.command("download")
@@ -70,42 +172,36 @@ def download_files(
             "It is recommended to leave checksum verification enabled unless you have a specific reason to disable it.",
         ),
     ] = False,
-    project_version: str = typer.Option(
+    project_version: str | None = typer.Option(
         default=None,
         help="User defined version of the project's at which to download the files. If not provided, downloads the latest version of all selected files.",
     ),
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ):
     """
-    Download files from the project's store on DivBase. This can be done by either:
+    Download files from the project's store on DivBase.
+
+    This can be done by either:
         1. providing a list of files paths directly in the command line
-        2. providing a directory to download the files to.
+        2. providing a text file with a list of files to download (new file on each line).
+
+    To download the latest version of a file, just provide its name. "file1" "file2" etc.
+    To download a specific/older version of a file, use the format: "file_name:version_id"
+    You can get a file's version id using the 'divbase-cli file info [FILE_NAME]' command.
+    You can mix and match latest and specific versions in the same command.
+    E.g. to download the latest version of file1 and version "3xcdsdsdiw829x"
+    of file2: 'divbase-cli files download file1 file2:3xcdsdsdiw829x'
     """
-    project_config = resolve_project(project_name=project, config_path=config_file)
-    logged_in_url = ensure_logged_in(config_path=config_file, desired_url=project_config.divbase_url)
-    download_dir_path = resolve_download_dir(download_dir=download_dir, config_path=config_file)
-
-    if bool(files) + bool(file_list) > 1:
-        print("Please specify only one of --files or --file-list.")
-        raise typer.Exit(1)
+    project_config = resolve_project(project_name=project)
+    logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
+    download_dir_path = resolve_download_dir(download_dir=download_dir)
 
-    all_files: set[str] = set()
-    if files:
-        all_files.update(files)
-    if file_list:
-        with open(file_list) as f:
-            for object_name in f:
-                all_files.add(object_name.strip())
-
-    if not all_files:
-        print("No files specified for download.")
-        raise typer.Exit(1)
+    raw_files_input = _resolve_file_inputs(files=files, file_list=file_list)
 
     download_results = download_files_command(
         divbase_base_url=logged_in_url,
         project_name=project_config.name,
-        all_files=list(all_files),
+        raw_files_input=raw_files_input,
         download_dir=download_dir_path,
         verify_checksums=not disable_verify_checksums,
         project_version=project_version,
@@ -123,9 +219,41 @@ def download_files(
         raise typer.Exit(1)
 
 
+@file_app.command("stream")
+def stream_file(
+    file_name: str = typer.Argument(..., help="Name of the file you want to stream."),
+    version_id: str | None = typer.Option(
+        default=None,
+        help="Specify this if you want to look at an older/specific version of the file. "
+        "If not provided, the latest version of the file is used. "
+        "To get a file's version ids, use the 'divbase-cli file info [FILE_NAME]' command.",
+    ),
+    project: str | None = PROJECT_NAME_OPTION,
+):
+    """
+    Stream a file's content to standard output.
+
+    This allows your to pipe the output to other tools like 'less', 'head', 'zcat' and 'bcftools'.
+
+    Examples:
+    - View a file: divbase-cli files stream my_file.tsv | less
+    - View a gzipped file: divbase-cli files stream my_file.vcf.gz | zcat | less
+    - Run a bcftools command: divbase-cli files stream my_file.vcf.gz | bcftools view -h -  # The "-" tells bcftools to read from standard input
+    """
+    project_config = resolve_project(project_name=project)
+    logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
+
+    stream_file_command(
+        divbase_base_url=logged_in_url,
+        project_name=project_config.name,
+        file_name=file_name,
+        version_id=version_id,
+    )
+
+
 @file_app.command("upload")
 def upload_files(
-    files: list[Path] | None = typer.Argument(None, help="Space seperated list of files to upload."),
+    files: list[Path] | None = typer.Argument(None, help="Space separated list of files to upload."),
     upload_dir: Path | None = typer.Option(None, "--upload-dir", help="Directory to upload all files from."),
     file_list: Path | None = typer.Option(None, "--file-list", help="Text file with list of files to upload."),
     disable_safe_mode: Annotated[
@@ -139,22 +267,23 @@ def upload_files(
         ),
     ] = False,
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ):
     """
-    Upload files to your project's store on DivBase by either:
-        1. providing a list of files paths directly in the command line
-        2. providing a directory to upload
-        3. providing a text file with or a file list.
+    Upload files to your project's store on DivBase:
+
+    To provide files to upload you can either:
+        1. provide a list of files paths directly in the command line
+        2. provide a directory to upload
+        3. provide a text file with or a file list.
     """
-    project_config = resolve_project(project_name=project, config_path=config_file)
-    logged_in_url = ensure_logged_in(config_path=config_file, desired_url=project_config.divbase_url)
+    project_config = resolve_project(project_name=project)
+    logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
 
     if bool(files) + bool(upload_dir) + bool(file_list) > 1:
         print("Please specify only one of --files, --upload_dir, or --file-list.")
         raise typer.Exit(1)
 
-    all_files = set()
+    all_files: set[Path] = set()
     if files:
         all_files.update(files)
     if upload_dir:
@@ -167,9 +296,11 @@ def upload_files(
                     all_files.add(path)
 
     if not all_files:
-        print("No files specified for upload.")
+        print(NO_FILES_SPECIFIED_MSG)
         raise typer.Exit(1)
 
+    _check_for_unsupported_files(all_files)
+
     uploaded_results = upload_files_command(
         project_name=project_config.name,
         divbase_base_url=logged_in_url,
@@ -190,40 +321,30 @@ def upload_files(
         raise typer.Exit(1)
 
 
-@file_app.command("remove")
+@file_app.command("rm")
 def remove_files(
     files: list[str] | None = typer.Argument(
         None, help="Space seperated list of files/objects in the project's store on DivBase to delete."
     ),
-    file_list: Path | None = typer.Option(None, "--file-list", help="Text file with list of files to upload."),
+    file_list: Path | None = typer.Option(None, "--file-list", help="Text file with list of files to delete."),
     dry_run: bool = typer.Option(
         False, "--dry-run", help="If set, will not actually delete the files, just print what would be deleted."
     ),
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ):
     """
-    Remove files from the project's store on DivBase by either:
-        1. providing a list of files paths directly in the command line
-        2. providing a text file with or a file list.
+    Soft delete files from the project's store on DivBase
 
-    'dry_run' mode will not actually delete the files, just print what would be deleted.
-    """
-    project_config = resolve_project(project_name=project, config_path=config_file)
-    logged_in_url = ensure_logged_in(config_path=config_file, desired_url=project_config.divbase_url)
+    To provide files to delete you can either:
+        1. provide a list of file names directly in the command line
+        2. provide a text file with a list of files to delete.
 
-    if bool(files) + bool(file_list) > 1:
-        print("Please specify only one of --files or --file-list.")
-        raise typer.Exit(1)
+    Note that deleting a non existent file will be treated as a successful deletion.
+    """
+    project_config = resolve_project(project_name=project)
+    logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
 
-    all_files = set()
-
-    if files:
-        all_files.update(files)
-    if file_list:
-        with open(file_list) as f:
-            for line in f:
-                all_files.add(line.strip())
+    all_files = _resolve_file_inputs(files=files, file_list=file_list)
 
     if dry_run:
         print("Dry run mode enabled. The following files would have been deleted:")
@@ -234,7 +355,7 @@ def remove_files(
     deleted_files = soft_delete_objects_command(
         divbase_base_url=logged_in_url,
         project_name=project_config.name,
-        all_files=list(all_files),
+        all_files=all_files,
     )
 
     if deleted_files:
@@ -243,3 +364,96 @@ def remove_files(
             print(f"- '{file}'")
     else:
         print("No files were deleted.")
+
+
+@file_app.command("restore")
+def restore_soft_deleted_files(
+    files: list[str] | None = typer.Argument(
+        None, help="Space seperated list of files/objects in the project's store on DivBase to restore."
+    ),
+    file_list: Path | None = typer.Option(None, "--file-list", help="Text file with list of files to restore."),
+    project: str | None = PROJECT_NAME_OPTION,
+):
+    """
+    Restore soft deleted files from the project's store on DivBase
+
+    To provide files to restore you can either:
+        1. provide a list of files directly in the command line.
+        2. provide a text file with a list of files to restore (new file on each line).
+
+    NOTE: Attempts to restore a file that is not soft deleted will be considered successful and the file will remain live. This means you can repeatedly run this command on the same file and get the same response.
+    """
+    project_config = resolve_project(project_name=project)
+    logged_in_url = ensure_logged_in(desired_url=project_config.divbase_url)
+
+    all_files = _resolve_file_inputs(files=files, file_list=file_list)
+
+    restored_objects_response = restore_objects_command(
+        divbase_base_url=logged_in_url,
+        project_name=project_config.name,
+        all_files=all_files,
+    )
+
+    if restored_objects_response.restored:
+        print("Restored files:")
+        for file in restored_objects_response.restored:
+            print(f"- '{file}'")
+
+    if restored_objects_response.not_restored:
+        print("[bold red]WARNING: Some files could not be restored:[/bold red]")
+        for file in restored_objects_response.not_restored:
+            print(f"[red]- '{file}'[/red]")
+
+        print(
+            "Possible reasons for failed restores:\n"
+            "1. The object does not exist in the bucket (e.g., a typo in the name).\n"
+            "2. The object was hard-deleted and is unrecoverable.\n"
+            "3. An unexpected server error occurred during the restore attempt."
+        )
+
+
+def _resolve_file_inputs(files: list[str] | None, file_list: Path | None) -> list[str]:
+    """Helper function to resolve file inputs from command line arguments."""
+    if bool(files) + bool(file_list) > 1:
+        print("Please specify only one of --files or --file-list.")
+        raise typer.Exit(1)
+
+    all_files = set()
+    if files:
+        all_files.update(files)
+    if file_list:
+        with open(file_list) as f:
+            for line in f:
+                all_files.add(line.strip())
+
+    if not all_files:
+        print(NO_FILES_SPECIFIED_MSG)
+        raise typer.Exit(1)
+    return list(all_files)
+
+
+def _check_for_unsupported_files(all_files: set[Path]) -> None:
+    """
+    Helper fn to check if any of the files to be uploaded are not supported by DivBase.
+    Raises error if so.
+
+    This can be to prevent users from:
+    1. Accidentally uploading unsupported files.
+    2. Uploading files that have characters that we reserve for actions like filtering/querying on DivBase.
+    (e.g. the syntax "[file_name]:[version_id]" can be used to download specific file versions).
+
+    This is not a security feature, just for UX purposes.
+    """
+    unsupported_file_types, unsupported_chars = [], []
+    for file_path in all_files:
+        if not any(file_path.name.endswith(supported) for supported in SUPPORTED_DIVBASE_FILE_TYPES):
+            unsupported_file_types.append(file_path)
+
+        if any(char in file_path.name for char in UNSUPPORTED_CHARACTERS_IN_FILENAMES):
+            unsupported_chars.append(file_path)
+
+    if unsupported_file_types:
+        raise UnsupportedFileTypeError(unsupported_files=unsupported_file_types)
+
+    if unsupported_chars:
+        raise UnsupportedFileNameError(unsupported_files=unsupported_chars)

divbase_cli/cli_commands/query_cli.py

@@ -17,13 +17,11 @@ TODO:
 """
 
 import logging
-from pathlib import Path
 
 import typer
 from rich import print
 
-from divbase_cli.cli_commands.user_config_cli import CONFIG_FILE_OPTION
-from divbase_cli.cli_commands.version_cli import PROJECT_NAME_OPTION
+from divbase_cli.cli_commands.shared_args_options import PROJECT_NAME_OPTION
 from divbase_cli.cli_config import cli_settings
 from divbase_cli.config_resolver import resolve_project
 from divbase_cli.user_auth import make_authenticated_request
@@ -75,7 +73,6 @@ def sample_metadata_query(
     ),
     metadata_tsv_name: str = METADATA_TSV_ARGUMENT,
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ) -> None:
     """
     Query the tsv sidecar metadata file for the VCF files in the project's data store on DivBase.
@@ -86,7 +83,7 @@ def sample_metadata_query(
     TODO: handle when the name of the sample column is something other than Sample_ID
     """
 
-    project_config = resolve_project(project_name=project, config_path=config_file)
+    project_config = resolve_project(project_name=project)
 
     request_data = SampleMetadataQueryRequest(tsv_filter=filter, metadata_tsv_name=metadata_tsv_name)
 
@@ -116,7 +113,6 @@ def pipe_query(
     command: str = BCFTOOLS_ARGUMENT,
     metadata_tsv_name: str = METADATA_TSV_ARGUMENT,
     project: str | None = PROJECT_NAME_OPTION,
-    config_file: Path = CONFIG_FILE_OPTION,
 ) -> None:
     """
     Submit a query to run on the DivBase API. A single, merged VCF file will be added to the project on success.
@@ -129,7 +125,7 @@ def pipe_query(
     TODO consider handling the bcftools command whitelist checks also on the CLI level since the error messages are nicer looking?
     TODO consider moving downloading of missing files elsewhere, since this is now done before the celery task
     """
-    project_config = resolve_project(project_name=project, config_path=config_file)
+    project_config = resolve_project(project_name=project)
 
     request_data = BcftoolsQueryRequest(tsv_filter=tsv_filter, command=command, metadata_tsv_name=metadata_tsv_name)
 

divbase_cli/cli_commands/shared_args_options.py

@@ -0,0 +1,20 @@
+"""
+To avoid potential problems with circular imports, we can put shared typer args + options (etc...) here
+
+If you have something that is only used in one of the cli subcommands, don't move it here.
+"""
+
+import typer
+
+PROJECT_NAME_OPTION = typer.Option(
+    None,
+    help="Name of the DivBase project, if not provided uses the default in your DivBase config file",
+    show_default=False,
+)
+
+
+FORMAT_AS_TSV_OPTION = typer.Option(
+    False,
+    "--tsv",
+    help="If set, will print the output in .TSV format for easier programmatic parsing.",
+)