kleinkram 0.38.1.dev20241212075157__py3-none-any.whl → 0.38.1.dev20250207122632__py3-none-any.whl

kleinkram/{commands/list.py → cli/_list.py}

@@ -4,20 +4,19 @@ from typing import List
 from typing import Optional
 
 import typer
+
 from kleinkram.api.client import AuthenticatedClient
+from kleinkram.api.query import FileQuery
+from kleinkram.api.query import MissionQuery
+from kleinkram.api.query import ProjectQuery
+from kleinkram.api.routes import get_files
+from kleinkram.api.routes import get_missions
+from kleinkram.api.routes import get_projects
 from kleinkram.config import get_shared_state
-from kleinkram.models import files_to_table
-from kleinkram.models import missions_to_table
-from kleinkram.models import projects_to_table
-from kleinkram.resources import FileSpec
-from kleinkram.resources import get_files_by_spec
-from kleinkram.resources import get_missions_by_spec
-from kleinkram.resources import get_projects_by_spec
-from kleinkram.resources import MissionSpec
-from kleinkram.resources import ProjectSpec
+from kleinkram.printing import print_files
+from kleinkram.printing import print_missions
+from kleinkram.printing import print_projects
 from kleinkram.utils import split_args
-from rich.console import Console
-
 
 HELP = """\
 List projects, missions, or files.
@@ -46,24 +45,19 @@ def files(
     mission_ids, mission_patterns = split_args(missions or [])
     project_ids, project_patterns = split_args(projects or [])
 
-    project_spec = ProjectSpec(patterns=project_patterns, ids=project_ids)
-    mission_spec = MissionSpec(
-        project_spec=project_spec,
+    project_query = ProjectQuery(patterns=project_patterns, ids=project_ids)
+    mission_query = MissionQuery(
+        project_query=project_query,
         ids=mission_ids,
         patterns=mission_patterns,
     )
-    file_spec = FileSpec(
-        mission_spec=mission_spec, patterns=file_patterns, ids=file_ids
+    file_query = FileQuery(
+        mission_query=mission_query, patterns=file_patterns, ids=file_ids
     )
 
     client = AuthenticatedClient()
-    parsed_files = get_files_by_spec(client, file_spec)
-
-    if get_shared_state().verbose:
-        Console().print(files_to_table(parsed_files))
-    else:
-        for file in parsed_files:
-            print(file.id)
+    parsed_files = list(get_files(client, file_query=file_query))
+    print_files(parsed_files, pprint=get_shared_state().verbose)
 
 
 @list_typer.command()
@@ -76,18 +70,16 @@ def missions(
     mission_ids, mission_patterns = split_args(missions or [])
     project_ids, project_patterns = split_args(projects or [])
 
-    project_spec = ProjectSpec(ids=project_ids, patterns=project_patterns)
-    mission_spec = MissionSpec(
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+    mission_query = MissionQuery(
         ids=mission_ids,
         patterns=mission_patterns,
-        project_spec=project_spec,
+        project_query=project_query,
     )
 
     client = AuthenticatedClient()
-    parsed_missions = get_missions_by_spec(client, mission_spec)
-
-    if get_shared_state().verbose:
-        Console().print(missions_to_table(parsed_missions))
+    parsed_missions = list(get_missions(client, mission_query=mission_query))
+    print_missions(parsed_missions, pprint=get_shared_state().verbose)
 
 
 @list_typer.command()
@@ -95,13 +87,8 @@ def projects(
     projects: Optional[List[str]] = typer.Argument(None, help="project names"),
 ) -> None:
     project_ids, project_patterns = split_args(projects or [])
-    project_spec = ProjectSpec(patterns=project_patterns, ids=project_ids)
+    project_query = ProjectQuery(patterns=project_patterns, ids=project_ids)
 
     client = AuthenticatedClient()
-    parsed_projects = get_projects_by_spec(client, project_spec)
-
-    if get_shared_state().verbose:
-        Console().print(projects_to_table(parsed_projects))
-    else:
-        for project in parsed_projects:
-            print(project.id)
+    parsed_projects = list(get_projects(client, project_query=project_query))
+    print_projects(parsed_projects, pprint=get_shared_state().verbose)

kleinkram/cli/_mission.py

@@ -0,0 +1,153 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Optional
+
+import typer
+
+import kleinkram.api.routes
+import kleinkram.core
+from kleinkram.api.client import AuthenticatedClient
+from kleinkram.api.query import MissionQuery
+from kleinkram.api.query import ProjectQuery
+from kleinkram.api.routes import get_mission
+from kleinkram.api.routes import get_project
+from kleinkram.config import get_shared_state
+from kleinkram.printing import print_mission_info
+from kleinkram.utils import load_metadata
+from kleinkram.utils import split_args
+
+CREATE_HELP = "create a mission"
+UPDATE_HELP = "update a mission"
+DELETE_HELP = "delete a mission"
+INFO_HELP = "get information about a mission"
+NOT_IMPLEMENTED_YET = """\
+Not implemented yet, open an issue if you want specific functionality
+"""
+
+mission_typer = typer.Typer(
+    no_args_is_help=True, context_settings={"help_option_names": ["-h", "--help"]}
+)
+
+
+@mission_typer.command(help=CREATE_HELP)
+def create(
+    project: str = typer.Option(..., "--project", "-p", help="project id or name"),
+    mission_name: str = typer.Option(..., "--mission", "-m", help="mission name"),
+    metadata: Optional[str] = typer.Option(
+        None, help="path to metadata file (json or yaml)"
+    ),
+    ignore_missing_tags: bool = typer.Option(False, help="ignore mission tags"),
+) -> None:
+    project_ids, project_patterns = split_args([project] if project else [])
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+
+    metadata_dct = load_metadata(Path(metadata)) if metadata else {}  # noqa
+
+    client = AuthenticatedClient()
+    project_id = get_project(client, project_query).id
+    mission_id = kleinkram.api.routes._create_mission(
+        client,
+        project_id,
+        mission_name,
+        metadata=metadata_dct,
+        ignore_missing_tags=ignore_missing_tags,
+    )
+
+    mission_parsed = get_mission(client, MissionQuery(ids=[mission_id]))
+    print_mission_info(mission_parsed, pprint=get_shared_state().verbose)
+
+
+@mission_typer.command(help=INFO_HELP)
+def info(
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: str = typer.Option(..., "--mission", "-m", help="mission id or name"),
+) -> None:
+    mission_ids, mission_patterns = split_args([mission])
+    project_ids, project_patterns = split_args([project] if project else [])
+
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+    mission_query = MissionQuery(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_query=project_query,
+    )
+
+    client = AuthenticatedClient()
+    mission_parsed = get_mission(client, mission_query)
+    print_mission_info(mission_parsed, pprint=get_shared_state().verbose)
+
+
+@mission_typer.command(help=UPDATE_HELP)
+def update(
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: str = typer.Option(..., "--mission", "-m", help="mission id or name"),
+    metadata: str = typer.Option(help="path to metadata file (json or yaml)"),
+) -> None:
+    mission_ids, mission_patterns = split_args([mission])
+    project_ids, project_patterns = split_args([project] if project else [])
+
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+    mission_query = MissionQuery(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_query=project_query,
+    )
+
+    metadata_dct = load_metadata(Path(metadata))
+
+    client = AuthenticatedClient()
+    mission_id = get_mission(client, mission_query).id
+    kleinkram.core.update_mission(
+        client=client, mission_id=mission_id, metadata=metadata_dct
+    )
+
+    mission_parsed = get_mission(client, mission_query)
+    print_mission_info(mission_parsed, pprint=get_shared_state().verbose)
+
+
+@mission_typer.command(help=DELETE_HELP)
+def delete(
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: str = typer.Option(..., "--mission", "-m", help="mission id or name"),
+    confirm: bool = typer.Option(
+        False, "--confirm", "-y", "--yes", help="confirm deletion"
+    ),
+) -> None:
+    if not confirm:
+        typer.confirm(f"delete {project} {mission}", abort=True)
+
+    project_ids, project_patterns = split_args([project] if project else [])
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+
+    mission_ids, mission_patterns = split_args([mission])
+    mission_query = MissionQuery(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_query=project_query,
+    )
+
+    client = AuthenticatedClient()
+    mission_parsed = get_mission(client, mission_query)
+    kleinkram.core.delete_mission(client=client, mission_id=mission_parsed.id)
+
+
+@mission_typer.command(help=NOT_IMPLEMENTED_YET)
+def prune(
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: str = typer.Option(..., "--mission", "-m", help="mission id or name"),
+) -> None:
+    """\
+    delete files with bad file states, e.g. missing not uploaded corrupted etc.
+    TODO: open for suggestions what this should do
+    """
+
+    raise NotImplementedError("Not implemented yet")

kleinkram/cli/_project.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+
+from typing import Optional
+
+import typer
+
+import kleinkram.api.routes
+import kleinkram.core
+from kleinkram.api.client import AuthenticatedClient
+from kleinkram.api.query import ProjectQuery
+from kleinkram.api.routes import get_project
+from kleinkram.config import get_shared_state
+from kleinkram.printing import print_project_info
+from kleinkram.utils import split_args
+
+project_typer = typer.Typer(
+    no_args_is_help=True, context_settings={"help_option_names": ["-h", "--help"]}
+)
+
+
+NOT_IMPLEMENTED_YET = """\
+Not implemented yet, open an issue if you want specific functionality
+"""
+
+CREATE_HELP = "create a project"
+INFO_HELP = "get information about a project"
+UPDATE_HELP = "update a project"
+DELETE_HELP = "delete a project"
+
+
+@project_typer.command(help=CREATE_HELP)
+def create(
+    project: str = typer.Option(..., "--project", "-p", help="project name"),
+    description: str = typer.Option(
+        ..., "--description", "-d", help="project description"
+    ),
+) -> None:
+    client = AuthenticatedClient()
+    project_id = kleinkram.api.routes._create_project(client, project, description)
+
+    project_parsed = get_project(client, ProjectQuery(ids=[project_id]))
+    print_project_info(project_parsed, pprint=get_shared_state().verbose)
+
+
+@project_typer.command(help=INFO_HELP)
+def info(
+    project: str = typer.Option(..., "--project", "-p", help="project id or name")
+) -> None:
+    project_ids, project_patterns = split_args([project])
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+
+    client = AuthenticatedClient()
+    project_parsed = get_project(client=client, query=project_query)
+    print_project_info(project_parsed, pprint=get_shared_state().verbose)
+
+
+@project_typer.command(help=UPDATE_HELP)
+def update(
+    project: str = typer.Option(..., "--project", "-p", help="project id or name"),
+    description: Optional[str] = typer.Option(
+        None, "--description", "-d", help="project description"
+    ),
+    new_name: Optional[str] = typer.Option(
+        None, "--new-name", "-n", "--name", help="new project name"
+    ),
+) -> None:
+    if description is None and new_name is None:
+        raise typer.BadParameter(
+            "nothing to update, provide --description or --new-name"
+        )
+
+    project_ids, project_patterns = split_args([project])
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+
+    client = AuthenticatedClient()
+    project_id = get_project(client=client, query=project_query).id
+    kleinkram.core.update_project(
+        client=client, project_id=project_id, description=description, new_name=new_name
+    )
+
+    project_parsed = get_project(client, ProjectQuery(ids=[project_id]))
+    print_project_info(project_parsed, pprint=get_shared_state().verbose)
+
+
+@project_typer.command(help=DELETE_HELP)
+def delete(
+    project: str = typer.Option(..., "--project", "-p", help="project id or name")
+) -> None:
+    project_ids, project_patterns = split_args([project])
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+
+    client = AuthenticatedClient()
+    project_id = get_project(client=client, query=project_query).id
+    kleinkram.core.delete_project(client=client, project_id=project_id)
+
+
+@project_typer.command(help=NOT_IMPLEMENTED_YET)
+def prune() -> None:
+    raise NotImplementedError(NOT_IMPLEMENTED_YET)

kleinkram/cli/_upload.py

@@ -0,0 +1,84 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import List
+from typing import Optional
+
+import typer
+
+import kleinkram.core
+import kleinkram.utils
+from kleinkram.api.client import AuthenticatedClient
+from kleinkram.api.query import MissionQuery
+from kleinkram.api.query import ProjectQuery
+from kleinkram.config import get_shared_state
+from kleinkram.errors import FileNameNotSupported
+from kleinkram.errors import MissionNotFound
+from kleinkram.utils import load_metadata
+from kleinkram.utils import split_args
+
+HELP = """\
+Upload files to kleinkram.
+"""
+
+upload_typer = typer.Typer(
+    name="upload",
+    no_args_is_help=True,
+    invoke_without_command=True,
+    help=HELP,
+)
+
+
+@upload_typer.callback()
+def upload(
+    files: List[str] = typer.Argument(help="files to upload"),
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: str = typer.Option(..., "--mission", "-m", help="mission id or name"),
+    create: bool = typer.Option(False, help="create mission if it does not exist"),
+    metadata: Optional[str] = typer.Option(
+        None, help="path to metadata file (json or yaml)"
+    ),
+    fix_filenames: bool = typer.Option(
+        False,
+        help="fix filenames before upload, this does not change the filenames locally",
+    ),
+    ignore_missing_tags: bool = typer.Option(False, help="ignore mission tags"),
+) -> None:
+    # get filepaths
+    file_paths = [Path(file) for file in files]
+
+    mission_ids, mission_patterns = split_args([mission])
+    project_ids, project_patterns = split_args([project] if project else [])
+
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+    mission_query = MissionQuery(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_query=project_query,
+    )
+
+    if not fix_filenames:
+        for file in file_paths:
+            if not kleinkram.utils.check_filename_is_sanatized(file.stem):
+                raise FileNameNotSupported(
+                    f"Only `{''.join(kleinkram.utils.INTERNAL_ALLOWED_CHARS)}` are "
+                    f"allowed in filenames and at most 50 chars: {file}. "
+                    f"Consider using `--fix-filenames`"
+                )
+
+    try:
+        kleinkram.core.upload(
+            client=AuthenticatedClient(),
+            query=mission_query,
+            file_paths=file_paths,
+            create=create,
+            metadata=load_metadata(Path(metadata)) if metadata else None,
+            ignore_missing_metadata=ignore_missing_tags,
+            verbose=get_shared_state().verbose,
+        )
+    except MissionNotFound:
+        if create:
+            raise  # dont change the error message
+        raise MissionNotFound("Mission not found. Use `--create` to create it.")

kleinkram/cli/_verify.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+from typing import List
+from typing import Optional
+
+import typer
+
+import kleinkram.core
+from kleinkram.api.client import AuthenticatedClient
+from kleinkram.api.query import MissionQuery
+from kleinkram.api.query import ProjectQuery
+from kleinkram.config import get_shared_state
+from kleinkram.printing import print_file_verification_status
+from kleinkram.utils import split_args
+
+logger = logging.getLogger(__name__)
+
+
+HELP = """\
+Verify if files were uploaded correctly.
+"""
+
+verify_typer = typer.Typer(name="verify", invoke_without_command=True, help=HELP)
+
+
+@verify_typer.callback()
+def verify(
+    files: List[str] = typer.Argument(help="files to upload"),
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: str = typer.Option(..., "--mission", "-m", help="mission id or name"),
+    skip_hash: bool = typer.Option(False, help="skip hash check"),
+) -> None:
+    # get all filepaths
+    file_paths = [Path(file) for file in files]
+
+    # get mission query
+    mission_ids, mission_patterns = split_args([mission])
+    project_ids, project_patterns = split_args([project] if project else [])
+    project_query = ProjectQuery(ids=project_ids, patterns=project_patterns)
+    mission_query = MissionQuery(
+        ids=mission_ids, patterns=mission_patterns, project_query=project_query
+    )
+
+    verbose = get_shared_state().verbose
+    file_status = kleinkram.core.verify(
+        client=AuthenticatedClient(),
+        query=mission_query,
+        file_paths=file_paths,
+        skip_hash=skip_hash,
+        verbose=verbose,
+    )
+    print_file_verification_status(file_status, pprint=verbose)

kleinkram/{app.py → cli/app.py}

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import logging
+import os
 import sys
 import time
 from enum import Enum
@@ -10,28 +11,40 @@ from typing import Optional
 
 import typer
 from click import Context
+from rich.console import Console
+from typer.core import TyperGroup
+
 from kleinkram._version import __version__
 from kleinkram.api.client import AuthenticatedClient
 from kleinkram.api.routes import _claim_admin
 from kleinkram.api.routes import _get_api_version
 from kleinkram.auth import login_flow
-from kleinkram.commands.download import download_typer
-from kleinkram.commands.endpoint import endpoint_typer
-from kleinkram.commands.list import list_typer
-from kleinkram.commands.mission import mission_typer
-from kleinkram.commands.project import project_typer
-from kleinkram.commands.upload import upload_typer
-from kleinkram.commands.verify import verify_typer
+from kleinkram.cli._download import download_typer
+from kleinkram.cli._endpoint import endpoint_typer
+from kleinkram.cli._list import list_typer
+from kleinkram.cli._mission import mission_typer
+from kleinkram.cli._project import project_typer
+from kleinkram.cli._upload import upload_typer
+from kleinkram.cli._verify import verify_typer
+from kleinkram.cli.error_handling import ErrorHandledTyper
+from kleinkram.cli.error_handling import display_error
 from kleinkram.config import Config
+from kleinkram.config import check_config_compatibility
+from kleinkram.config import get_config
 from kleinkram.config import get_shared_state
-from kleinkram.errors import ErrorHandledTyper
+from kleinkram.config import save_config
 from kleinkram.errors import InvalidCLIVersion
 from kleinkram.utils import format_traceback
 from kleinkram.utils import get_supported_api_version
-from rich.console import Console
-from typer.core import TyperGroup
 
-LOG_DIR = Path() / "logs"
+# slightly cursed lambdas so that linters don't complain about unreachable code
+if (lambda: os.name)() == "posix":
+    LOG_DIR = Path().home() / ".local" / "state" / "kleinkram"
+elif (lambda: os.name)() == "nt":
+    LOG_DIR = Path().home() / "AppData" / "Local" / "kleinkram"
+else:
+    raise OSError(f"Unsupported OS {os.name}")
+
 LOG_FILE = LOG_DIR / f"{time.time_ns()}.log"
 LOG_FORMAT = "%(asctime)s | %(name)s | %(levelname)s | %(message)s"
 
@@ -57,6 +70,15 @@ class LogLevel(str, Enum):
     CRITICAL = "CRITICAL"
 
 
+LOG_LEVEL_MAP = {
+    LogLevel.DEBUG: logging.DEBUG,
+    LogLevel.INFO: logging.INFO,
+    LogLevel.WARNING: logging.WARNING,
+    LogLevel.ERROR: logging.ERROR,
+    LogLevel.CRITICAL: logging.CRITICAL,
+}
+
+
 class CommandTypes(str, Enum):
     AUTH = "Authentication Commands"
     CORE = "Core Commands"
@@ -88,9 +110,12 @@ app.add_typer(project_typer, name="project", rich_help_panel=CommandTypes.CRUD)
 # attach error handler to app
 @app.error_handler(Exception)
 def base_handler(exc: Exception) -> int:
-    if not get_shared_state().debug:
-        Console(file=sys.stderr).print(f"{type(exc).__name__}: {exc}", style="red")
-        logger.error(format_traceback(exc))
+    shared_state = get_shared_state()
+
+    display_error(exc=exc, verbose=shared_state.verbose)
+    logger.error(format_traceback(exc))
+
+    if not shared_state.debug:
         return 1
     raise exc
 
@@ -105,8 +130,12 @@ def login(
 
 @app.command(rich_help_panel=CommandTypes.AUTH)
 def logout(all: bool = typer.Option(False, help="logout on all enpoints")) -> None:
-    config = Config()
-    config.clear_credentials(all=all)
+    config = get_config()
+    if all:
+        config.endpoint_credentials.clear()
+    else:
+        config.endpoint_credentials.pop(config.selected_endpoint, None)
+    save_config(config)
 
 
 @app.command(hidden=True)
@@ -147,21 +176,24 @@ def cli(
     ),
     log_level: Optional[LogLevel] = typer.Option(None, help="Set log level."),
 ):
+    if not check_config_compatibility():
+        typer.confirm("found incompatible config file, overwrite?", abort=True)
+        save_config(Config())
+
     _ = version  # suppress unused variable warning
     shared_state = get_shared_state()
     shared_state.verbose = verbose
     shared_state.debug = debug
 
-    if shared_state.debug:
+    if shared_state.debug and log_level is None:
         log_level = LogLevel.DEBUG
+    if log_level is None:
+        log_level = LogLevel.WARNING
 
-    if log_level is not None:
-        LOG_DIR.mkdir(parents=True, exist_ok=True)
-        level = logging.getLevelName(log_level)
-        logging.basicConfig(level=level, filename=LOG_FILE, format=LOG_FORMAT)
-    else:
-        logging.disable(logging.CRITICAL)
-
+    LOG_DIR.mkdir(parents=True, exist_ok=True)
+    logging.basicConfig(
+        level=LOG_LEVEL_MAP[log_level], filename=LOG_FILE, format=LOG_FORMAT
+    )
     logger.info(f"CLI version: {__version__}")
 
     try:
@@ -170,7 +202,7 @@ def cli(
         logger.error(format_traceback(e))
         raise
     except Exception:
-        err = ("failed to check version compatibility",)
+        err = "failed to check version compatibility"
         Console(file=sys.stderr).print(
             err, style="yellow" if shared_state.verbose else None
         )