kleinkram 0.38.1.dev20250113080249__tar.gz → 0.38.1.dev20250218095010__tar.gz

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kleinkram
-Version: 0.38.1.dev20250113080249
+Version: 0.38.1.dev20250218095010
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Classifier: Programming Language :: Python :: 3
@@ -74,7 +74,7 @@ Instead of downloading files from a specified mission you can download arbitrary
 klein download --dest out *id1* *id2* *id3*
 ```
 
-For more information consult the [documentation](https://docs.datasets.leggedrobotics.com/usage/cli/cli-getting-started.html).
+For more information consult the [documentation](https://docs.datasets.leggedrobotics.com/usage/python/getting-started.html).
 
 ## Development
 
@@ -106,10 +106,15 @@ klein --help
 ```
 
 ### Run Tests
+to run unit tests:
 ```bash
-pytest .
+pytest -m "not slow"
 ```
-or if you want to skip slow tests...
+to run all tests (including e2e and integration tests):
 ```bash
-pytest -m "not slow" .
+pytest
 ```
+For the latter you need to have an instance of the backend running locally.
+See instructions in the root of the repository for this.
+On top of that these tests require particular files to be present in the `cli/data/testing` directory.
+To see the exact files that are required, see `cli/testing/backend_fixtures.py`.

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/README.md

@@ -50,7 +50,7 @@ Instead of downloading files from a specified mission you can download arbitrary
 klein download --dest out *id1* *id2* *id3*
 ```
 
-For more information consult the [documentation](https://docs.datasets.leggedrobotics.com/usage/cli/cli-getting-started.html).
+For more information consult the [documentation](https://docs.datasets.leggedrobotics.com/usage/python/getting-started.html).
 
 ## Development
 
@@ -82,10 +82,15 @@ klein --help
 ```
 
 ### Run Tests
+to run unit tests:
 ```bash
-pytest .
+pytest -m "not slow"
 ```
-or if you want to skip slow tests...
+to run all tests (including e2e and integration tests):
 ```bash
-pytest -m "not slow" .
+pytest
 ```
+For the latter you need to have an instance of the backend running locally.
+See instructions in the root of the repository for this.
+On top of that these tests require particular files to be present in the `cli/data/testing` directory.
+To see the exact files that are required, see `cli/testing/backend_fixtures.py`.

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/api/client.py

@@ -1,10 +1,17 @@
 from __future__ import annotations
 
 import logging
+from collections import abc
 from threading import Lock
 from typing import Any
+from typing import List
+from typing import Mapping
+from typing import Sequence
+from typing import Tuple
+from typing import Union
 
 import httpx
+from httpx._types import PrimitiveData
 
 from kleinkram.config import Config
 from kleinkram.config import Credentials
@@ -17,10 +24,41 @@ logger = logging.getLogger(__name__)
 
 COOKIE_AUTH_TOKEN = "authtoken"
 COOKIE_REFRESH_TOKEN = "refreshtoken"
-COOKIE_CLI_KEY = "clikey"
+COOKIE_API_KEY = "clikey"
 
 
-class NotLoggedInException(Exception): ...
+Data = Union[PrimitiveData, Any]
+NestedData = Mapping[str, Data]
+ListData = Sequence[Data]
+QueryParams = Mapping[str, Union[Data, NestedData, ListData]]
+
+
+def _convert_nested_data_query_params_values(
+    key: str, values: NestedData
+) -> List[Tuple[str, Data]]:
+    return [(f"{key}[{k}]", v) for k, v in values.items()]
+
+
+def _convert_list_data_query_params_values(
+    key: str, values: ListData
+) -> List[Tuple[str, Data]]:
+    return [(key, value) for value in values]
+
+
+def _convert_query_params_to_httpx_format(
+    params: QueryParams,
+) -> List[Tuple[str, Data]]:
+    ret: List[Tuple[str, Data]] = []
+    for key, value in params.items():
+        if isinstance(value, (str, int, float, bool)) or value is None:
+            ret.append((key, value))
+        elif isinstance(value, abc.Mapping):
+            ret.extend(_convert_nested_data_query_params_values(key, value))
+        elif isinstance(value, abc.Sequence):
+            ret.extend(_convert_list_data_query_params_values(key, value))
+        else:  # TODO: handle this better
+            ret.append((key, str(value)))
+    return ret
 
 
 class AuthenticatedClient(httpx.Client):
@@ -36,9 +74,9 @@ class AuthenticatedClient(httpx.Client):
         if self._config.credentials is None:
             logger.info("not authenticated...")
             raise NotAuthenticated
-        elif (cli_key := self._config.credentials.cli_key) is not None:
+        elif (api_key := self._config.credentials.api_key) is not None:
             logger.info("using cli key...")
-            self.cookies.set(COOKIE_CLI_KEY, cli_key)
+            self.cookies.set(COOKIE_API_KEY, api_key)
         else:
             logger.info("using refresh token...")
             assert self._config.credentials.auth_token is not None, "unreachable"
@@ -48,7 +86,7 @@ class AuthenticatedClient(httpx.Client):
         if self._config.credentials is None:
             raise NotAuthenticated
 
-        if self._config.credentials.cli_key is not None:
+        if self._config.credentials.api_key is not None:
             raise RuntimeError("cannot refresh token when using cli key auth")
 
         refresh_token = self._config.credentials.refresh_token
@@ -73,7 +111,12 @@ class AuthenticatedClient(httpx.Client):
         self.cookies.set(COOKIE_AUTH_TOKEN, new_access_token)
 
     def request(
-        self, method: str, url: str | httpx.URL, *args: Any, **kwargs: Any
+        self,
+        method: str,
+        url: str | httpx.URL,
+        params: QueryParams | None = None,
+        *args: Any,
+        **kwargs: Any,
     ) -> httpx.Response:
         if isinstance(url, httpx.URL):
             raise NotImplementedError(f"`httpx.URL` is not supported {url!r}")
@@ -83,7 +126,11 @@ class AuthenticatedClient(httpx.Client):
         # try to do a request
         full_url = f"{self._config.endpoint.api}{url}"
         logger.info(f"requesting {method} {full_url}")
-        response = super().request(method, full_url, *args, **kwargs)
+
+        httpx_params = _convert_query_params_to_httpx_format(params or {})
+        response = super().request(
+            method, full_url, params=httpx_params, *args, **kwargs
+        )
 
         logger.info(f"got response {response}")
 

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/api/file_transfer.py

@@ -32,12 +32,12 @@ from kleinkram.utils import styled_string
 
 logger = logging.getLogger(__name__)
 
-UPLOAD_CREDS = "/file/temporaryAccess"
+UPLOAD_CREDS = "/files/temporaryAccess"
 UPLOAD_CONFIRM = "/queue/confirmUpload"
-UPLOAD_CANCEL = "/file/cancelUpload"
+UPLOAD_CANCEL = "/files/cancelUpload"
 
 DOWNLOAD_CHUNK_SIZE = 1024 * 1024 * 16
-DOWNLOAD_URL = "/file/download"
+DOWNLOAD_URL = "/files/download"
 
 S3_MAX_RETRIES = 60  # same as frontend
 S3_READ_TIMEOUT = 60 * 5  # 5 minutes

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/api/routes.py

@@ -65,17 +65,16 @@ __all__ = [
 CLAIM_ADMIN = "/user/claimAdmin"
 GET_STATUS = "/user/me"
 
-UPDATE_PROJECT = "/project"
-UPDATE_MISSION = "/mission/tags"  # TODO: just metadata for now
-CREATE_MISSION = "/mission/create"
-CREATE_PROJECT = "/project/create"
+UPDATE_PROJECT = "/projects"
+UPDATE_MISSION = "/missions/tags"  # TODO: just metadata for now
+CREATE_MISSION = "/missions/create"
+CREATE_PROJECT = "/projects"
 
 
-FILE_ENDPOINT = "/file/many"
-MISSION_ENDPOINT = "/mission/many"
-PROJECT_ENDPOINT = "/project/many"
+FILE_ENDPOINT = "/files"
+MISSION_ENDPOINT = "/missions"
+PROJECT_ENDPOINT = "/projects"
 
-MISSION_BY_NAME = "/mission/byName"
 TAG_TYPE_BY_NAME = "/tag/filtered"
 
 
@@ -109,7 +108,6 @@ def _project_query_to_params(
         params[Params.PROJECT_PATTERNS.value] = project_query.patterns
     if project_query.ids:
         params[Params.PROJECT_IDS.value] = list(map(str, project_query.ids))
-    params = _handle_list_params(params)
     return params
 
 
@@ -119,7 +117,6 @@ def _mission_query_to_params(mission_query: MissionQuery) -> Dict[str, List[str]
         params[Params.MISSION_PATTERNS.value] = mission_query.patterns
     if mission_query.ids:
         params[Params.MISSION_IDS.value] = list(map(str, mission_query.ids))
-    params = _handle_list_params(params)
     return params
 
 
@@ -129,7 +126,6 @@ def _file_query_to_params(file_query: FileQuery) -> Dict[str, List[str]]:
         params[Params.FILE_PATTERNS.value] = list(file_query.patterns)
     if file_query.ids:
         params[Params.FILE_IDS.value] = list(map(str, file_query.ids))
-    params = _handle_list_params(params)
     return params
 
 
@@ -374,7 +370,7 @@ def _claim_admin(client: AuthenticatedClient) -> None:
     return
 
 
-FILE_DELETE_MANY = "/file/deleteMultiple"
+FILE_DELETE_MANY = "/files/deleteMultiple"
 
 
 def _delete_files(
@@ -388,7 +384,7 @@ def _delete_files(
     resp.raise_for_status()
 
 
-MISSION_DELETE_ONE = "/mission/{}"
+MISSION_DELETE_ONE = "/missions/{}"
 
 
 def _delete_mission(client: AuthenticatedClient, mission_id: UUID) -> None:
@@ -400,7 +396,7 @@ def _delete_mission(client: AuthenticatedClient, mission_id: UUID) -> None:
     resp.raise_for_status()
 
 
-PROJECT_DELETE_ONE = "/project/{}"
+PROJECT_DELETE_ONE = "/projects/{}"
 
 
 def _delete_project(client: AuthenticatedClient, project_id: UUID) -> None:

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/auth.py

@@ -84,7 +84,7 @@ def login_flow(*, key: Optional[str] = None, headless: bool = False) -> None:
     config = get_config()
     # use cli key login
     if key is not None:
-        config.credentials = Credentials(cli_key=key)
+        config.credentials = Credentials(api_key=key)
         save_config(config)
         return
 

kleinkram-0.38.1.dev20250218095010/kleinkram/cli/_file.py

@@ -0,0 +1,94 @@
+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 FileQuery
+from kleinkram.api.query import MissionQuery
+from kleinkram.api.query import ProjectQuery
+from kleinkram.api.routes import get_file
+from kleinkram.config import get_shared_state
+from kleinkram.printing import print_file_info
+from kleinkram.utils import split_args
+
+INFO_HELP = "get information about a file"
+DELETE_HELP = "delete a file"
+
+
+file_typer = typer.Typer(
+    no_args_is_help=True, context_settings={"help_option_names": ["-h", "--help"]}
+)
+
+
+@file_typer.command(help=INFO_HELP)
+def info(
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: Optional[str] = typer.Option(
+        None, "--mission", "-m", help="mission id or name"
+    ),
+    file: str = typer.Option(..., "--file", "-f", help="file id or name"),
+) -> None:
+    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] if mission else [])
+    mission_query = MissionQuery(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_query=project_query,
+    )
+
+    file_ids, file_patterns = split_args([file])
+    file_query = FileQuery(
+        ids=file_ids,
+        patterns=file_patterns,
+        mission_query=mission_query,
+    )
+
+    client = AuthenticatedClient()
+    file_parsed = get_file(client, file_query)
+    print_file_info(file_parsed, pprint=get_shared_state().verbose)
+
+
+@file_typer.command(help=DELETE_HELP)
+def delete(
+    project: Optional[str] = typer.Option(
+        None, "--project", "-p", help="project id or name"
+    ),
+    mission: Optional[str] = typer.Option(
+        None, "--mission", "-m", help="mission id or name"
+    ),
+    file: str = typer.Option(..., "--file", "-f", help="file 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] if mission else [])
+    mission_query = MissionQuery(
+        ids=mission_ids,
+        patterns=mission_patterns,
+        project_query=project_query,
+    )
+
+    file_ids, file_patterns = split_args([file])
+    file_query = FileQuery(
+        ids=file_ids,
+        patterns=file_patterns,
+        mission_query=mission_query,
+    )
+
+    client = AuthenticatedClient()
+    file_parsed = get_file(client, file_query)
+    kleinkram.core.delete_files(client=client, file_ids=[file_parsed.id])

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/cli/app.py

@@ -21,12 +21,14 @@ from kleinkram.api.routes import _get_api_version
 from kleinkram.auth import login_flow
 from kleinkram.cli._download import download_typer
 from kleinkram.cli._endpoint import endpoint_typer
+from kleinkram.cli._file import file_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
@@ -56,7 +58,7 @@ Kleinkram CLI
 
 The Kleinkram CLI is a command line interface for Kleinkram.
 For a list of available commands, run `klein --help` or visit \
-https://docs.datasets.leggedrobotics.com/usage/cli/cli-getting-started.html \
+https://docs.datasets.leggedrobotics.com/usage/python/getting-started.html \
 for more information.
 """
 
@@ -97,11 +99,14 @@ app = ErrorHandledTyper(
     no_args_is_help=True,
 )
 
+app.add_typer(endpoint_typer, name="endpoint", rich_help_panel=CommandTypes.AUTH)
+
 app.add_typer(download_typer, name="download", rich_help_panel=CommandTypes.CORE)
 app.add_typer(upload_typer, name="upload", rich_help_panel=CommandTypes.CORE)
 app.add_typer(verify_typer, name="verify", rich_help_panel=CommandTypes.CORE)
 app.add_typer(list_typer, name="list", rich_help_panel=CommandTypes.CORE)
-app.add_typer(endpoint_typer, name="endpoint", rich_help_panel=CommandTypes.AUTH)
+
+app.add_typer(file_typer, name="file", rich_help_panel=CommandTypes.CRUD)
 app.add_typer(mission_typer, name="mission", rich_help_panel=CommandTypes.CRUD)
 app.add_typer(project_typer, name="project", rich_help_panel=CommandTypes.CRUD)
 
@@ -109,9 +114,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
 

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/cli/error_handling.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import sys
 from collections import OrderedDict
 from typing import Any
 from typing import Callable
@@ -7,6 +8,10 @@ from typing import Type
 
 import typer
 from click import ClickException
+from rich.console import Console
+from rich.panel import Panel
+
+from kleinkram.utils import upper_camel_case_to_words
 
 ExceptionHandler = Callable[[Exception], int]
 
@@ -42,3 +47,21 @@ class ErrorHandledTyper(typer.Typer):
                     exit_code = handler(e)
                     raise SystemExit(exit_code)
             raise
+
+
+def display_error(*, exc: Exception, verbose: bool) -> None:
+    split_exc_name = upper_camel_case_to_words(type(exc).__name__)
+
+    if verbose:
+        panel = Panel(
+            str(exc),  # get the error message
+            title=" ".join(split_exc_name),
+            style="red",
+            border_style="bold",
+        )
+        Console(file=sys.stderr).print(panel)
+    else:
+        text = f"{type(exc).__name__}"
+        if str(exc):
+            text += f": {exc}"
+        print(text, file=sys.stderr)

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/config.py

@@ -45,7 +45,7 @@ class Endpoint(NamedTuple):
 class Credentials(NamedTuple):
     auth_token: Optional[str] = None
     refresh_token: Optional[str] = None
-    cli_key: Optional[str] = None
+    api_key: Optional[str] = None
 
 
 DEFAULT_LOCAL_API = "http://localhost:3000"
@@ -73,14 +73,58 @@ def get_env() -> Environment:
     return Environment.PROD
 
 
+ACTION_API_KEY = "KLEINKRAM_API_KEY"
+ACTION_API = "KLEINKRAM_API"
+ACTION_S3 = "KLEINKRAM_S3"
+
+
+def _get_endpoint_from_action_env_vars() -> Optional[Endpoint]:
+    api = os.getenv(ACTION_API)
+    s3 = os.getenv(ACTION_S3)
+    if api is None or s3 is None:
+        return None
+    return Endpoint("action", api, s3)
+
+
+def _get_api_key_from_action_env_vars() -> Optional[str]:
+    return os.getenv(ACTION_API_KEY)
+
+
+def _get_default_selected_endpoint() -> Endpoint:
+    env_endpoint = _get_endpoint_from_action_env_vars()
+    if env_endpoint is not None:
+        return env_endpoint
+    return DEFAULT_ENDPOINTS[get_env().value]
+
+
+def _get_default_endpoints() -> Dict[str, Endpoint]:
+    env_endpoint = _get_endpoint_from_action_env_vars()
+
+    default_endpoints = DEFAULT_ENDPOINTS.copy()
+    if env_endpoint is not None:
+        default_endpoints["action"] = env_endpoint
+    return default_endpoints
+
+
+def _get_default_credentials() -> Dict[str, Credentials]:
+    endpoint = _get_default_selected_endpoint()
+
+    api_key = _get_api_key_from_action_env_vars()
+    if api_key is not None:
+        return {endpoint.name: Credentials(api_key=api_key)}
+    return {}
+
+
 @dataclass
 class Config:
     version: str = __version__
-    selected_endpoint: str = field(default_factory=lambda: get_env().value)
-    endpoints: Dict[str, Endpoint] = field(
-        default_factory=lambda: DEFAULT_ENDPOINTS.copy()
+    selected_endpoint: str = field(
+        default_factory=lambda: _get_default_selected_endpoint().name
+    )
+    endpoints: Dict[str, Endpoint] = field(default_factory=_get_default_endpoints)
+    endpoint_credentials: Dict[str, Credentials] = field(
+        default_factory=_get_default_credentials
     )
-    endpoint_credentials: Dict[str, Credentials] = field(default_factory=dict)
 
     @property
     def endpoint(self) -> Endpoint:
@@ -129,11 +173,21 @@ def save_config(config: Config, path: Path = CONFIG_PATH) -> None:
     os.replace(temp_path, path)
 
 
-def _load_config(*, path: Path = CONFIG_PATH) -> Config:
+def _load_config_if_compatible(path: Path) -> Optional[Config]:
     if not path.exists():
-        return Config()
+        return None
     with open(path, "r") as f:
-        return _config_from_dict(json.load(f))
+        try:
+            return _config_from_dict(json.load(f))
+        except Exception:
+            return None
+
+
+def _load_config(*, path: Path = CONFIG_PATH) -> Config:
+    config = _load_config_if_compatible(path)
+    if config is None:
+        return Config()
+    return config
 
 
 LOADED_CONFIGS: Dict[Path, Config] = {}
@@ -166,12 +220,8 @@ def check_config_compatibility(path: Path = CONFIG_PATH) -> bool:
     """
     if not path.exists():
         return True
-    try:
-        _ = _load_config(path=path)
-    except Exception as e:
-        logger.info(f"Error loading config: {e}")
-        return False
-    return True
+    config = _load_config_if_compatible(path)
+    return config is not None
 
 
 def endpoint_table(config: Config) -> Table:

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/printing.py

@@ -191,6 +191,28 @@ def files_to_table(
     return table
 
 
+def file_info_table(file: File) -> Table:
+    table = Table("k", "v", title=f"file info: {file.name}", show_header=False)
+
+    table.add_row("name", file.name)
+    table.add_row("id", Text(str(file.id), style="green"))
+    table.add_row("project", file.project_name)
+    table.add_row("project id", Text(str(file.project_id), style="green"))
+    table.add_row("mission", file.mission_name)
+    table.add_row("mission id", Text(str(file.mission_id), style="green"))
+    table.add_row("created", str(file.created_at))
+    table.add_row("updated", str(file.updated_at))
+    table.add_row("size", format_bytes(file.size))
+    table.add_row("state", file_state_to_text(file.state))
+    table.add_row("categories", ", ".join(file.categories))
+    table.add_row("topics", ", ".join(file.topics))
+    table.add_row("hash", file.hash)
+    table.add_row("type", file.type_)
+    table.add_row("date", str(file.date))
+
+    return table
+
+
 def mission_info_table(
     mission: Mission, print_metadata: bool = False
 ) -> Tuple[Table, ...]:
@@ -297,6 +319,20 @@ def print_projects(projects: Sequence[Project], *, pprint: bool) -> None:
             print(project.id)
 
 
+def print_file_info(file: File, *, pprint: bool) -> None:
+    """\
+    prints the file info to stdout
+    either using pprint or as a list for piping
+    """
+    if pprint:
+        Console().print(file_info_table(file))
+    else:
+        file_dct = asdict(file)
+        for key in file_dct:
+            file_dct[key] = str(file_dct[key])  # TODO: improve this
+        print(json.dumps(file_dct))
+
+
 def print_mission_info(mission: Mission, *, pprint: bool) -> None:
     """\
     prints the mission info to stdout

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram/utils.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
 import base64
-import fnmatch
 import hashlib
+import re
 import string
 import traceback
 from hashlib import md5
@@ -14,7 +14,6 @@ from typing import Optional
 from typing import Sequence
 from typing import Tuple
 from typing import TypeVar
-from typing import Union
 from uuid import UUID
 
 import yaml
@@ -55,6 +54,11 @@ def file_paths_from_files(
         }
 
 
+def upper_camel_case_to_words(s: str) -> List[str]:
+    """split `s` given upper camel case to words"""
+    return re.sub("([a-z])([A-Z])", r"\1 \2", s).split()
+
+
 def split_args(args: Sequence[str]) -> Tuple[List[UUID], List[str]]:
     """\
     split a sequece of strings into a list of UUIDs and a list of names

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kleinkram
-Version: 0.38.1.dev20250113080249
+Version: 0.38.1.dev20250218095010
 Summary: give me your bags
 Author: Cyrill Püntener, Dominique Garmier, Johann Schwabe
 Classifier: Programming Language :: Python :: 3
@@ -74,7 +74,7 @@ Instead of downloading files from a specified mission you can download arbitrary
 klein download --dest out *id1* *id2* *id3*
 ```
 
-For more information consult the [documentation](https://docs.datasets.leggedrobotics.com/usage/cli/cli-getting-started.html).
+For more information consult the [documentation](https://docs.datasets.leggedrobotics.com/usage/python/getting-started.html).
 
 ## Development
 
@@ -106,10 +106,15 @@ klein --help
 ```
 
 ### Run Tests
+to run unit tests:
 ```bash
-pytest .
+pytest -m "not slow"
 ```
-or if you want to skip slow tests...
+to run all tests (including e2e and integration tests):
 ```bash
-pytest -m "not slow" .
+pytest
 ```
+For the latter you need to have an instance of the backend running locally.
+See instructions in the root of the repository for this.
+On top of that these tests require particular files to be present in the `cli/data/testing` directory.
+To see the exact files that are required, see `cli/testing/backend_fixtures.py`.

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/kleinkram.egg-info/SOURCES.txt

@@ -33,6 +33,7 @@ kleinkram/api/routes.py
 kleinkram/cli/__init__.py
 kleinkram/cli/_download.py
 kleinkram/cli/_endpoint.py
+kleinkram/cli/_file.py
 kleinkram/cli/_list.py
 kleinkram/cli/_mission.py
 kleinkram/cli/_project.py
@@ -47,6 +48,7 @@ tests/conftest.py
 tests/test_config.py
 tests/test_core.py
 tests/test_end_to_end.py
+tests/test_error_handling.py
 tests/test_fixtures.py
 tests/test_printing.py
 tests/test_query.py

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = kleinkram
-version = 0.38.1-dev20250113080249
+version = 0.38.1-dev20250218095010
 description = give me your bags
 long_description = file: README.md
 long_description_content_type = text/markdown

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/testing/backend_fixtures.py

@@ -8,9 +8,7 @@ import pytest
 
 from kleinkram import create_mission
 from kleinkram import create_project
-from kleinkram import delete_mission
 from kleinkram import delete_project
-from kleinkram import list_files
 from kleinkram import list_missions
 from kleinkram import list_projects
 from kleinkram import upload
@@ -34,10 +32,7 @@ WAIT_BEOFORE_DELETION = 5
 @pytest.fixture(scope="session")
 def project():
     project_name = token_hex(8)
-
-    print("here")
     create_project(project_name, description="This is a test project")
-
     project = list_projects(project_names=[project_name])[0]
 
     yield project

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/tests/test_config.py

@@ -1,13 +1,19 @@
 from __future__ import annotations
 
+import os
 from pathlib import Path
 from tempfile import TemporaryDirectory
+from unittest import mock
 
 import pytest
 
+from kleinkram.config import ACTION_API
+from kleinkram.config import ACTION_API_KEY
+from kleinkram.config import ACTION_S3
 from kleinkram.config import Config
 from kleinkram.config import Endpoint
 from kleinkram.config import _load_config
+from kleinkram.config import _load_config_if_compatible
 from kleinkram.config import add_endpoint
 from kleinkram.config import check_config_compatibility
 from kleinkram.config import endpoint_table
@@ -17,7 +23,30 @@ from kleinkram.config import get_shared_state
 from kleinkram.config import save_config
 from kleinkram.config import select_endpoint
 
-CONFIG_FILENAME = "kleinkram.json"
+CONFIG_FILENAME = ".kleinkram.json"
+
+
+TEST_API_KEY = "test_key"
+TEST_API = "test_api"
+TEST_S3 = "test_s3"
+
+
+@pytest.fixture()
+def set_api_key_env(monkeypatch):
+    with mock.patch.dict(os.environ, clear=True):
+        envvars = {ACTION_API_KEY: TEST_API_KEY}
+        for k, v in envvars.items():
+            monkeypatch.setenv(k, v)
+        yield  # This is the magical bit which restore the environment after
+
+
+@pytest.fixture()
+def set_endpoint_env(monkeypatch):
+    with mock.patch.dict(os.environ, clear=True):
+        envvars = {ACTION_API: TEST_API, ACTION_S3: TEST_S3}
+        for k, v in envvars.items():
+            monkeypatch.setenv(k, v)
+        yield  # This is the magical bit which restore the environment after
 
 
 @pytest.fixture
@@ -26,15 +55,50 @@ def config_path():
         yield Path(tmpdir) / CONFIG_FILENAME
 
 
+def test_load_config_if_compatible_with_invalid_config(config_path):
+    with open(config_path, "w") as f:
+        f.write("this is not a valid config")
+    assert _load_config_if_compatible(config_path) is None
+
+
 def test_load_config_default(config_path):
     config = _load_config(path=config_path)
 
     assert not config_path.exists()
     assert Config() == config
 
+    assert config.endpoint_credentials == {}
+    assert config.selected_endpoint == get_env().value
+
 
-def test_save_and_load_config(config_path):
+def test_load_default_config_with_env_var_api_key_specified(
+    config_path, set_api_key_env
+):
+    assert set_api_key_env is None
 
+    config = _load_config(path=config_path)
+
+    creds = config.endpoint_credentials[config.selected_endpoint]
+    assert creds.auth_token is None
+    assert creds.refresh_token is None
+    assert creds.api_key == TEST_API_KEY
+
+    assert not config_path.exists()
+
+
+def test_load_default_config_with_env_var_endpoints_specified(
+    config_path, set_endpoint_env
+):
+    assert set_endpoint_env is None
+    config = _load_config(path=config_path)
+
+    assert config.selected_endpoint == "action"
+    assert config.endpoint == Endpoint("action", TEST_API, TEST_S3)
+
+    assert not config_path.exists()
+
+
+def test_save_and_load_config(config_path):
     config = Config(version="foo")
 
     assert not config_path.exists()

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/tests/test_end_to_end.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 import secrets
 import shutil
+import time
 from pathlib import Path
 
 import pytest
@@ -43,6 +44,8 @@ def run_cmd(command, *, verbose=VERBOSE):
 def test_upload_verify_update_download_mission(project, tmp_path, api):
     assert api
 
+    file_names = list(DATA_PATH.glob("*.bag"))
+
     mission_name = secrets.token_hex(8)
     upload = f"{CLI} upload -p {project.name} -m {mission_name} --create {DATA_PATH.absolute()}/*.bag"
     verify = (
@@ -50,12 +53,15 @@ def test_upload_verify_update_download_mission(project, tmp_path, api):
     )
     # update = f"{CLI} mission update -p {project.name} -m {mission_name} --metadata {DATA_PATH.absolute()}/metadata.yaml"
     download = f"{CLI} download -p {project.name} -m {mission_name} --dest {tmp_path.absolute()}"
+    delete_file = f"{CLI} file delete -p {project.name} -m {mission_name} -f {file_names[0].name} -y"
 
     assert run_cmd(upload) == 0
     assert run_cmd(verify) == 0
     # assert run_cmd(update) == 0
     assert run_cmd(download) == 0
 
+    assert run_cmd(delete_file) == 0
+
 
 @pytest.mark.slow
 def test_list_files(project, mission, api):

kleinkram-0.38.1.dev20250218095010/tests/test_error_handling.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+import pytest
+
+from kleinkram.cli.error_handling import display_error
+
+
+class MyException(Exception):
+    pass
+
+
+def test_display_error_not_verbose(capsys):
+    exc = MyException("hello")
+
+    display_error(exc=exc, verbose=False)
+
+    out, err = capsys.readouterr()
+
+    assert out == ""
+    assert err == "MyException: hello\n"
+
+    exc = MyException()
+
+    display_error(exc=exc, verbose=False)
+
+    out, err = capsys.readouterr()
+
+    assert out == ""
+    assert err == "MyException\n"
+
+
+def test_display_error_verbose(capsys):
+    exc = MyException("hello")
+
+    display_error(exc=exc, verbose=True)
+
+    out, err = capsys.readouterr()
+
+    assert out == ""
+    assert err == (
+        "╭──────────────────────────────── My Exception ────────────────────────────────╮\n"
+        "│ hello                                                                        │\n"
+        "╰──────────────────────────────────────────────────────────────────────────────╯\n"
+    )

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/tests/test_fixtures.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import pytest
+
 from kleinkram import list_files
 from kleinkram import list_missions
 from kleinkram import list_projects
@@ -7,11 +9,13 @@ from testing.backend_fixtures import DATA_FILES
 from testing.backend_fixtures import PROJECT_DESCRIPTION
 
 
+@pytest.mark.slow
 def test_project_fixture(project):
     assert list_projects(project_ids=[project.id])[0].id == project.id
     assert project.description == PROJECT_DESCRIPTION
 
 
+@pytest.mark.slow
 def test_mission_fixture(mission, project):
     assert mission.project_id == project.id
     assert list_missions(mission_ids=[mission.id])[0].id == mission.id
@@ -23,6 +27,7 @@ def test_mission_fixture(mission, project):
     )
 
 
+@pytest.mark.slow
 def test_empty_mission_fixture(empty_mission, project):
     assert empty_mission.project_id == project.id
     assert list_missions(mission_ids=[empty_mission.id])[0].id == empty_mission.id

{kleinkram-0.38.1.dev20250113080249 → kleinkram-0.38.1.dev20250218095010}/tests/test_utils.py

@@ -17,6 +17,7 @@ from kleinkram.utils import parse_path_like
 from kleinkram.utils import parse_uuid_like
 from kleinkram.utils import singleton_list
 from kleinkram.utils import split_args
+from kleinkram.utils import upper_camel_case_to_words
 
 
 def test_split_args():
@@ -135,3 +136,14 @@ def test_parse_uuid_like() -> None:
 def test_parse_path_like() -> None:
     assert parse_path_like("test") == Path("test")
     assert parse_path_like(Path("test")) == Path("test")
+
+
+def test_upper_camel_case_to_words() -> None:
+    assert upper_camel_case_to_words("HelloWorld") == ["Hello", "World"]
+    assert upper_camel_case_to_words("HelloWorldAgain") == ["Hello", "World", "Again"]
+    assert upper_camel_case_to_words("Hello") == ["Hello"]
+    assert upper_camel_case_to_words("hello") == ["hello"]
+    assert upper_camel_case_to_words("") == []
+    assert upper_camel_case_to_words("not_camel_case") == ["not_camel_case"]
+    assert upper_camel_case_to_words("*#?-_") == ["*#?-_"]
+    assert upper_camel_case_to_words("helloWorld") == ["hello", "World"]