hafnia 0.3.0__tar.gz → 0.4.0__tar.gz

{hafnia-0.3.0 → hafnia-0.4.0}/.github/workflows/publish_docker.yaml

@@ -47,7 +47,7 @@ jobs:
             echo "aws_region=${{ secrets.STAGE_AWS_REGION }}" >> $GITHUB_OUTPUT
           fi
       - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v5.0.0
+        uses: aws-actions/configure-aws-credentials@v5.1.0
         with:
           role-to-assume: arn:aws:iam::${{ steps.env-vars.outputs.aws_account_id }}:role/${{ secrets.AWS_ROLE_NAME }}
           aws-region: ${{ steps.env-vars.outputs.aws_region }} 

{hafnia-0.3.0 → hafnia-0.4.0}/.github/workflows/tests.yaml

@@ -11,6 +11,7 @@ jobs:
   test:
     runs-on: ${{ matrix.os }}
     strategy:
+      max-parallel: 1
       matrix:
         os: [ubuntu-latest, windows-latest]
     steps:

hafnia-0.4.0/.trivyignore

@@ -0,0 +1,3 @@
+# Ignore 'CVE-2024-37059' issue https://avd.aquasec.com/nvd/2024/cve-2024-37059/
+# The vulnerability does not apply to our platform as models are not loaded on our platform.
+CVE-2024-37059

{hafnia-0.3.0 → hafnia-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hafnia
-Version: 0.3.0
+Version: 0.4.0
 Summary: Python SDK for communication with Hafnia platform.
 Author-email: Milestone Systems <hafniaplatform@milestone.dk>
 License-File: LICENSE
@@ -9,7 +9,9 @@ Requires-Dist: boto3>=1.35.91
 Requires-Dist: click>=8.1.8
 Requires-Dist: emoji>=2.14.1
 Requires-Dist: flatten-dict>=0.4.2
-Requires-Dist: mlflow>=3.2.0
+Requires-Dist: keyring>=25.6.0
+Requires-Dist: mcp==1.16.0
+Requires-Dist: mlflow>=3.4.0
 Requires-Dist: more-itertools>=10.7.0
 Requires-Dist: opencv-python-headless>=4.11.0.86
 Requires-Dist: pathspec>=0.12.1
@@ -22,7 +24,6 @@ Requires-Dist: rich>=13.9.4
 Requires-Dist: s5cmd>=0.2.0
 Requires-Dist: sagemaker-mlflow>=0.1.0
 Requires-Dist: seedir>=0.5.0
-Requires-Dist: tqdm>=4.67.1
 Requires-Dist: xxhash>=3.5.0
 Description-Content-Type: text/markdown
 
@@ -80,6 +81,7 @@ Copy the key and save it for later use.
     Hafnia API Key:  # Pass your HAFNIA API key
     Hafnia Platform URL [https://api.mdi.milestonesys.com]:  # Press [Enter]
     ```
+
 1. Download `mnist` from terminal to verify that your configuration is working.  
 
     ```bash
@@ -91,7 +93,7 @@ With Hafnia configured on your local machine, it is now possible to download
 and explore the dataset sample with a python script:
 
 ```python
-from hafnia.data import load_dataset, get_dataset_path
+from hafnia.data import get_dataset_path
 from hafnia.dataset.hafnia_dataset import HafniaDataset
 
 # To download the sample dataset use:
@@ -360,7 +362,7 @@ logger.log_scalar("validation/loss", value=0.1, step=100)
 logger.log_metric("validation/accuracy", value=0.95, step=100)
 ```
 
-Similar to `load_dataset`, the tracker behaves differently when running locally or in the cloud. 
+The tracker behaves differently when running locally or in the cloud. 
 Locally, experiment data is stored in a local folder `.data/experiments/{DATE_TIME}`. 
 
 In the cloud, the experiment data will be available in the Hafnia platform under 
@@ -384,7 +386,7 @@ and datasets available in the data library.
 
 ```python
 # Load Hugging Face dataset
-dataset_splits = load_dataset("midwest-vehicle-detection")
+dataset_splits = HafniaDataset.from_name("midwest-vehicle-detection")
 
 # Define transforms
 train_transforms = v2.Compose(

{hafnia-0.3.0 → hafnia-0.4.0}/README.md

@@ -52,6 +52,7 @@ Copy the key and save it for later use.
     Hafnia API Key:  # Pass your HAFNIA API key
     Hafnia Platform URL [https://api.mdi.milestonesys.com]:  # Press [Enter]
     ```
+
 1. Download `mnist` from terminal to verify that your configuration is working.  
 
     ```bash
@@ -63,7 +64,7 @@ With Hafnia configured on your local machine, it is now possible to download
 and explore the dataset sample with a python script:
 
 ```python
-from hafnia.data import load_dataset, get_dataset_path
+from hafnia.data import get_dataset_path
 from hafnia.dataset.hafnia_dataset import HafniaDataset
 
 # To download the sample dataset use:
@@ -332,7 +333,7 @@ logger.log_scalar("validation/loss", value=0.1, step=100)
 logger.log_metric("validation/accuracy", value=0.95, step=100)
 ```
 
-Similar to `load_dataset`, the tracker behaves differently when running locally or in the cloud. 
+The tracker behaves differently when running locally or in the cloud. 
 Locally, experiment data is stored in a local folder `.data/experiments/{DATE_TIME}`. 
 
 In the cloud, the experiment data will be available in the Hafnia platform under 
@@ -356,7 +357,7 @@ and datasets available in the data library.
 
 ```python
 # Load Hugging Face dataset
-dataset_splits = load_dataset("midwest-vehicle-detection")
+dataset_splits = HafniaDataset.from_name("midwest-vehicle-detection")
 
 # Define transforms
 train_transforms = v2.Compose(

{hafnia-0.3.0 → hafnia-0.4.0}/examples/example_dataset_recipe.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from rich import print as rprint
 
 from hafnia import utils
-from hafnia.data.factory import load_dataset
+from hafnia.dataset.dataset_names import OPS_REMOVE_CLASS
 from hafnia.dataset.dataset_recipe.dataset_recipe import DatasetRecipe
 from hafnia.dataset.dataset_recipe.recipe_transforms import (
     SelectSamples,
@@ -50,7 +50,7 @@ dataset_recipe.as_python_code()
 # executed in the TaaS platform. This is demonstrated below:
 if utils.is_hafnia_configured():  # First ensure you are connected to the hafnia platform
     # Upload the dataset recipe - this will make it available for TaaS and for users of your organization
-    dataset_recipe.as_platform_recipe(recipe_name="example-mnist-recipe")
+    dataset_recipe.as_platform_recipe(recipe_name="example-mnist-recipe", overwrite=True)
 
     # The recipe is now available in TaaS, for different environments and other users in your organization
     dataset_recipe_again = DatasetRecipe.from_recipe_name(name="example-mnist-recipe")
@@ -95,53 +95,126 @@ rprint(dataset_recipe)  # as a python object
 print(dataset_recipe.as_json_str())  # as a JSON string
 
 
-# Example: Using the 'load_dataset' function
-merged_dataset: HafniaDataset = load_dataset(dataset_recipe)
-# You get a few extra things when using `load_dataset`.
-# 1) You get the dataset directly - you don't have to call `build()` on the recipe.
-# 2) The dataset is cached if it already exists, so you don't have to
-#    download or rebuild the dataset on the second run.
-# 3) You can use an implicit form of the recipe. One example of this is that you just specify
-#    the dataset name `load_dataset("mnist")` or path `load_dataset(Path(".data/datasets/mnist"))`
-
-
+### Real-world Example: Merge datasets to create a Person+Vehicle dataset ###
+# 1) The first step is to use the regular 'HafniaDataset' interface to investigate and understand the datasets
+
+# 1a) Explore 'coco-2017'
+coco = HafniaDataset.from_name("coco-2017")
+coco.print_stats()  # Print dataset statistics
+coco_class_names = coco.info.get_task_by_primitive("Bbox").class_names  # Get the class names for the bbox task
+# You will notice coco has 80 classes including 'person' and various vehicle classes such as 'car', 'bus', 'truck', etc.
+# but also many unrelated classes such as 'toaster', 'hair drier', etc.
+
+# 1b) Explore 'midwest-vehicle-detection'
+midwest = HafniaDataset.from_name("midwest-vehicle-detection")
+midwest.print_stats()  # Print dataset statistics
+midwest_class_names = midwest.info.get_task_by_primitive("Bbox").class_names
+# You will also notice midwest has similar classes, but they are named differently, e.g. 'Persons',
+# 'Vehicle.Car', 'Vehicle.Bicycle', etc.
+
+# 2) We will now use the 'HafniaDataset' interface to verify operations (class remapping, merging, filtering)
+
+# 2a) Remap class names to have the same class names across datasets
+mappings_coco = {
+    "person": "Person",
+    "bicycle": "Vehicle",
+    "car": "Vehicle",
+    "motorcycle": "Vehicle",
+    "bus": "Vehicle",
+    "train": "Vehicle",
+    "truck": "Vehicle",
+}
+mapping_midwest = {
+    "Person": "Person",
+    "Vehicle*": "Vehicle",  # Wildcard mapping. Selects class names starting with 'Vehicle.' e.g. 'Vehicle.Bicycle', "Vehicle.Car', etc.
+    "Vehicle.Trailer": OPS_REMOVE_CLASS,  # Use this to remove a class
+}
+coco_remapped = coco.class_mapper(class_mapping=mappings_coco, method="remove_undefined", task_name="bboxes")
+midwest_remapped = midwest.class_mapper(class_mapping=mapping_midwest, task_name="bboxes")
+
+# 2b) Merge datasets
+merged_dataset_all_images = HafniaDataset.from_merge(dataset0=coco_remapped, dataset1=midwest_remapped)
+
+# 2c) Remove images without 'Person' or 'Vehicle' annotations
+merged_dataset = merged_dataset_all_images.select_samples_by_class_name(name=["Person", "Vehicle"], task_name="bboxes")
+merged_dataset.print_stats()
+
+# 3) Once you have verified operations using the 'HafniaDataset' interface, you can convert
+# the operations to a single 'DatasetRecipe'
+merged_recipe = DatasetRecipe.from_merge(
+    recipe0=DatasetRecipe.from_name("coco-2017").class_mapper(
+        class_mapping=mappings_coco, method="remove_undefined", task_name="bboxes"
+    ),
+    recipe1=DatasetRecipe.from_name("midwest-vehicle-detection").class_mapper(
+        class_mapping=mapping_midwest, task_name="bboxes"
+    ),
+).select_samples_by_class_name(name=["Person", "Vehicle"], task_name="bboxes")
+
+# 3a) Verify again on the sample datasets, that the recipe works and can build as a dataset
+merged_dataset = merged_recipe.build()
+merged_dataset.print_stats()
+
+# 3b) Optionally: Save the recipe to file
+path_recipe = Path(".data/dataset_recipes/example-merged-person-vehicle-recipe.json")
+merged_recipe.as_json_file(path_recipe)
+if utils.is_hafnia_configured():
+    # 3c) Upload dataset recipe to Training-aaS platform
+    recipe_response = merged_recipe.as_platform_recipe(recipe_name="person-vehicle-detection", overwrite=True)
+    print(f"Recipe Name: '{recipe_response['name']}', Recipe id: '{recipe_response['id']}'")
+
+    # 4) The recipe is now available in TaaS for you and other users in your organization
+    # 4a) View recipes from your terminal with 'hafnia dataset-recipe ls'
+    # 4b) (Coming soon) Or go to 'Dataset Recipes' in the TaaS web platform:  https://hafnia.milestonesys.com/training-aas/dataset-recipes
+
+    # 5) Launch an experiment with the dataset:
+    # 5a) Using the CLI:
+    #   'hafnia experiment create --dataset-recipe person-vehicle-detection --trainer-path ../trainer-classification'
+    # 5b) (Coming soon) Or through the TaaS web platform:  https://hafnia.milestonesys.com/training-aas/experiments
+
+# 6) Monitor and manage your experiments
+# 6a) View experiments using the web platform https://staging02.mdi.milestonesys.com/training-aas/experiments
+# 6b) Or use the CLI: 'hafnia experiment ls'
 ### DatasetRecipe Implicit Form ###
 # Below we demonstrate the difference between implicit and explicit forms of dataset recipes.
 # Example: Get dataset by name with implicit and explicit forms
-dataset = load_dataset("mnist")  # Implicit form
-dataset = load_dataset(DatasetRecipe.from_name(name="mnist"))  # Explicit form
+recipe_implicit_form = "mnist"
+recipe_explicit_form = DatasetRecipe.from_name(name="mnist")
+
+# The implicit form can now be loaded and built as a dataset
+dataset_implicit = DatasetRecipe.from_implicit_form(recipe_implicit_form).build()
+# Or directly as a dataset
+dataset_implicit = HafniaDataset.from_recipe(recipe_implicit_form)
+
 
 # Example: Get dataset from path with implicit and explicit forms:
-dataset = load_dataset(Path(".data/datasets/mnist"))  # Implicit form
-dataset = load_dataset(DatasetRecipe.from_path(path_folder=Path(".data/datasets/mnist")))  # Explicit form
+recipe_implicit_form = Path(".data/datasets/mnist")
+recipe_explicit_form = DatasetRecipe.from_path(path_folder=Path(".data/datasets/mnist"))
 
 # Example: Merge datasets with implicit and explicit forms
-dataset = load_dataset(("mnist", "mnist"))  # Implicit form
-dataset = load_dataset(  # Explicit form
-    DatasetRecipe.from_merger(
-        recipes=[
-            DatasetRecipe.from_name(name="mnist"),
-            DatasetRecipe.from_name(name="mnist"),
-        ]
-    )
+recipe_implicit_form = ("mnist", "mnist")
+recipe_explicit_form = DatasetRecipe.from_merger(
+    recipes=[
+        DatasetRecipe.from_name(name="mnist"),
+        DatasetRecipe.from_name(name="mnist"),
+    ]
 )
 
 # Example: Define a dataset with transformations using implicit and explicit forms
-dataset = load_dataset(["mnist", SelectSamples(n_samples=20), Shuffle()])  # Implicit form
-dataset = load_dataset(DatasetRecipe.from_name(name="mnist").select_samples(n_samples=20).shuffle())  # Explicit form
+recipe_implicit_form = ["mnist", SelectSamples(n_samples=20), Shuffle()]
+recipe_explicit_form = DatasetRecipe.from_name(name="mnist").select_samples(n_samples=20).shuffle()
 
 
 # Example: Complex nested example with implicit vs explicit forms
 # Implicit form of a complex dataset recipe
 split_ratio = {"train": 0.8, "val": 0.1, "test": 0.1}
-implicit_recipe = (
+recipe_implicit_complex = (
     ("mnist", "mnist"),
     [Path(".data/datasets/mnist"), SelectSamples(n_samples=30), SplitsByRatios(split_ratios=split_ratio)],
     ["mnist", SelectSamples(n_samples=20), Shuffle()],
 )
 
 # Explicit form of the same complex dataset recipe
-explicit_recipe = DatasetRecipe.from_merger(
+recipe_explicit_complex = DatasetRecipe.from_merger(
     recipes=[
         DatasetRecipe.from_merger(
             recipes=[
@@ -165,10 +238,10 @@ explicit_recipe = DatasetRecipe.from_merger(
 
 
 # To convert from implicit to explicit recipe form, you can use the `from_implicit_form` method.
-explicit_recipe_from_implicit = DatasetRecipe.from_implicit_form(implicit_recipe)
+explicit_recipe_from_implicit = DatasetRecipe.from_implicit_form(recipe_implicit_complex)
 rprint("Converted explicit recipe:")
 rprint(explicit_recipe_from_implicit)
 
 # Verify that the conversion produces the same result
-assert explicit_recipe_from_implicit == explicit_recipe
+assert explicit_recipe_from_implicit == recipe_explicit_complex
 rprint("Conversion successful - recipes are equivalent!")

{hafnia-0.3.0 → hafnia-0.4.0}/examples/example_hafnia_dataset.py

@@ -5,7 +5,6 @@ import numpy as np
 from PIL import Image
 from rich import print as rprint
 
-from hafnia.data import load_dataset
 from hafnia.dataset.dataset_names import SplitName
 from hafnia.dataset.hafnia_dataset import DatasetInfo, HafniaDataset, Sample, TaskInfo
 from hafnia.dataset.primitives.bbox import Bbox
@@ -19,7 +18,7 @@ from hafnia.dataset.primitives.polygon import Polygon
 # And configure it with your Hafnia account:
 #   hafnia configure
 
-# Load dataset
+# Load sample dataset
 dataset = HafniaDataset.from_name("mnist")
 
 # Dataset information is stored in 'dataset.info'
@@ -53,6 +52,12 @@ new_dataset_splits = dataset.splits_by_ratios(split_ratios)
 # Get only samples with specific class names
 dataset_ones = dataset.select_samples_by_class_name(name="1 - one", primitive=Classification)
 
+# Get access to a few full and public dataset through Hafnia (no login required)
+# Available datasets: "mnist", "caltech-101", "caltech-256", "cifar10", "cifar100"
+public_dataset = HafniaDataset.from_name_public_dataset("mnist", n_samples=100)
+public_dataset.print_stats()
+
+
 # Rename class names with mapping
 class_mapping_strict = {
     "0 - zero": "even",  # "0 - zero" will be renamed to "even". "even" appear first and get class index 0
@@ -70,7 +75,7 @@ dataset_mapped = dataset.class_mapper(class_mapping=class_mapping_strict)
 dataset_mapped.print_class_distribution()
 
 # Support Chaining Operations (load, shuffle, select samples)
-dataset = load_dataset("midwest-vehicle-detection").shuffle(seed=42).select_samples(n_samples=10)
+dataset = HafniaDataset.from_name("midwest-vehicle-detection").shuffle(seed=42).select_samples(n_samples=10)
 
 
 # Write dataset to disk
@@ -124,7 +129,7 @@ for i_fake_sample in range(5):
     bboxes = [Bbox(top_left_x=0.1, top_left_y=0.20, width=0.1, height=0.2, class_name="car")]
     classifications = [Classification(class_name="vehicle", class_idx=0)]
     sample = Sample(
-        file_name=f"path/to/image_{i_fake_sample:05}.jpg",
+        file_path=f"path/to/image_{i_fake_sample:05}.jpg",
         height=480,
         width=640,
         split="train",

{hafnia-0.3.0 → hafnia-0.4.0}/examples/example_torchvision_dataloader.py

@@ -7,12 +7,12 @@ from torch.utils.data import DataLoader
 from torchvision.transforms import v2
 
 from hafnia import torch_helpers
-from hafnia.data import load_dataset
+from hafnia.dataset.hafnia_dataset import HafniaDataset
 
 if __name__ == "__main__":
     torch.manual_seed(1)
     # Load Hugging Face dataset
-    dataset = load_dataset("midwest-vehicle-detection")
+    dataset = HafniaDataset.from_name("midwest-vehicle-detection")
 
     # Define transforms
     train_transforms = v2.Compose(

{hafnia-0.3.0 → hafnia-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hafnia"
-version = "0.3.0"
+version = "0.4.0"
 description = "Python SDK for communication with Hafnia platform."
 readme = "README.md"
 authors = [
@@ -13,7 +13,7 @@ dependencies = [
     "click>=8.1.8",
     "emoji>=2.14.1",
     "flatten-dict>=0.4.2",
-    "mlflow>=3.2.0",
+    "keyring>=25.6.0",
     "more-itertools>=10.7.0",
     "opencv-python-headless>=4.11.0.86",
     "pathspec>=0.12.1",
@@ -24,10 +24,11 @@ dependencies = [
     "pydantic>=2.10.4",
     "rich>=13.9.4",
     "s5cmd>=0.2.0",
-    "sagemaker-mlflow>=0.1.0",
     "seedir>=0.5.0",
-    "tqdm>=4.67.1",
     "xxhash>=3.5.0",
+    "mlflow>=3.4.0",
+    "sagemaker-mlflow>=0.1.0",
+    "mcp==1.16.0",
 ]
 
 [dependency-groups]
@@ -37,7 +38,7 @@ dev = [
     "torch>=2.6.0",
     "torchvision>=0.21.0",
     "flatten-dict>=0.4.2",
-    "pytest-cov>=7.0.0",    
+    "pytest-cov>=7.0.0",
 ]
 
 test = ["pytest>=8.3.4", "pre-commit>=4.2.0", "ruff>=0.9.1"]
@@ -71,5 +72,9 @@ disallow_incomplete_defs = false
 disallow_untyped_calls = false
 warn_unused_ignores = false
 
+[[tool.mypy.overrides]]
+module = "yaml"
+ignore_missing_imports = true
+
 [tool.pytest.ini_options]
 markers = ["slow: marks tests as slow (deselect with '-m \"not slow\"')"]

{hafnia-0.3.0 → hafnia-0.4.0}/src/cli/__main__.py

@@ -37,7 +37,9 @@ def configure(cfg: Config) -> None:
 
     platform_url = click.prompt("Hafnia Platform URL", type=str, default=consts.DEFAULT_API_URL)
 
-    cfg_profile = ConfigSchema(api_key=api_key, platform_url=platform_url)
+    use_keychain = click.confirm("Store API key in system keychain?", default=False)
+
+    cfg_profile = ConfigSchema(platform_url=platform_url, api_key=api_key, use_keychain=use_keychain)
     cfg.add_profile(profile_name, cfg_profile, set_active=True)
     cfg.save_config()
     profile_cmds.profile_show(cfg)

{hafnia-0.3.0 → hafnia-0.4.0}/src/cli/config.py

@@ -6,6 +6,7 @@ from typing import Dict, List, Optional
 from pydantic import BaseModel, field_validator
 
 import cli.consts as consts
+import cli.keychain as keychain
 from hafnia.log import sys_logger, user_logger
 
 PLATFORM_API_MAPPING = {
@@ -19,9 +20,18 @@ PLATFORM_API_MAPPING = {
 }
 
 
+class SecretStr(str):
+    def __repr__(self):
+        return "********"
+
+    def __str__(self):
+        return "********"
+
+
 class ConfigSchema(BaseModel):
     platform_url: str = ""
     api_key: Optional[str] = None
+    use_keychain: bool = False
 
     @field_validator("api_key")
     def validate_api_key(cls, value: Optional[str]) -> Optional[str]:
@@ -35,7 +45,7 @@ class ConfigSchema(BaseModel):
             sys_logger.warning("API key is missing the 'ApiKey ' prefix. Prefix is being added automatically.")
             value = f"ApiKey {value}"
 
-        return value
+        return SecretStr(value)  # Keeps the API key masked in logs and repr
 
 
 class ConfigFileSchema(BaseModel):
@@ -70,13 +80,32 @@ class Config:
 
     @property
     def api_key(self) -> str:
+        # Check keychain first if enabled
+        if self.config.use_keychain:
+            keychain_key = keychain.get_api_key(self.active_profile)
+            if keychain_key is not None:
+                return keychain_key
+
+        # Fall back to config file
         if self.config.api_key is not None:
             return self.config.api_key
+
         raise ValueError(consts.ERROR_API_KEY_NOT_SET)
 
     @api_key.setter
     def api_key(self, value: str) -> None:
-        self.config.api_key = value
+        # Store in keychain if enabled
+        if self.config.use_keychain:
+            if keychain.store_api_key(self.active_profile, value):
+                # Successfully stored in keychain, don't store in config
+                self.config.api_key = None
+            else:
+                # Keychain storage failed, fall back to config file
+                sys_logger.warning("Failed to store in keychain, falling back to config file")
+                self.config.api_key = value
+        else:
+            # Not using keychain, store in config file
+            self.config.api_key = value
 
     @property
     def platform_url(self) -> str:
@@ -152,8 +181,19 @@ class Config:
             raise ValueError("Failed to parse configuration file")
 
     def save_config(self) -> None:
+        # Create a copy to avoid modifying the original data
+        config_to_save = self.config_data.model_dump()
+
+        # Store API key in keychain if enabled, and don't write to file
+        for profile_name, profile_data in config_to_save["profiles"].items():
+            if profile_data.get("use_keychain", False):
+                api_key = profile_data.get("api_key")
+                if api_key:
+                    keychain.store_api_key(profile_name, api_key)
+                profile_data["api_key"] = None
+
         with open(self.config_path, "w") as f:
-            json.dump(self.config_data.model_dump(), f, indent=4)
+            json.dump(config_to_save, f, indent=4)
 
     def remove_profile(self, profile_name: str) -> None:
         if profile_name not in self.config_data.profiles:

hafnia-0.4.0/src/cli/keychain.py

@@ -0,0 +1,88 @@
+"""Keychain storage for API keys using the system keychain."""
+
+from typing import Optional
+
+from hafnia.log import sys_logger
+
+# Keyring is optional - gracefully degrade if not available
+try:
+    import keyring
+
+    KEYRING_AVAILABLE = True
+except ImportError:
+    KEYRING_AVAILABLE = False
+    sys_logger.debug("keyring library not available, keychain storage disabled")
+
+KEYRING_SERVICE_NAME = "hafnia-cli"
+
+
+def store_api_key(profile_name: str, api_key: str) -> bool:
+    """
+    Store an API key in the system keychain.
+
+    Args:
+        profile_name: The profile name to associate with the key
+        api_key: The API key to store
+
+    Returns:
+        True if successfully stored, False otherwise
+    """
+    if not KEYRING_AVAILABLE:
+        sys_logger.warning("Keyring library not available, cannot store API key in keychain")
+        return False
+
+    try:
+        keyring.set_password(KEYRING_SERVICE_NAME, profile_name, api_key)
+        sys_logger.debug(f"Stored API key for profile '{profile_name}' in keychain")
+        return True
+    except Exception as e:
+        sys_logger.warning(f"Failed to store API key in keychain: {e}")
+        return False
+
+
+def get_api_key(profile_name: str) -> Optional[str]:
+    """
+    Retrieve an API key from the system keychain.
+
+    Args:
+        profile_name: The profile name to retrieve the key for
+
+    Returns:
+        The API key if found, None otherwise
+    """
+    if not KEYRING_AVAILABLE:
+        return None
+
+    try:
+        api_key = keyring.get_password(KEYRING_SERVICE_NAME, profile_name)
+        if api_key:
+            sys_logger.debug(f"Retrieved API key for profile '{profile_name}' from keychain")
+        return api_key
+    except Exception as e:
+        sys_logger.warning(f"Failed to retrieve API key from keychain: {e}")
+        return None
+
+
+def delete_api_key(profile_name: str) -> bool:
+    """
+    Delete an API key from the system keychain.
+
+    Args:
+        profile_name: The profile name to delete the key for
+
+    Returns:
+        True if successfully deleted or didn't exist, False on error
+    """
+    if not KEYRING_AVAILABLE:
+        return False
+
+    try:
+        keyring.delete_password(KEYRING_SERVICE_NAME, profile_name)
+        sys_logger.debug(f"Deleted API key for profile '{profile_name}' from keychain")
+        return True
+    except keyring.errors.PasswordDeleteError:
+        # Key didn't exist, which is fine
+        return True
+    except Exception as e:
+        sys_logger.warning(f"Failed to delete API key from keychain: {e}")
+        return False

{hafnia-0.3.0 → hafnia-0.4.0}/src/cli/profile_cmds.py

@@ -50,10 +50,13 @@ def cmd_profile_use(cfg: Config, profile_name: str) -> None:
 @click.option(
     "--activate/--no-activate", help="Activate the created profile after creation", default=True, show_default=True
 )
+@click.option(
+    "--use-keychain", is_flag=True, help="Store API key in system keychain instead of config file", default=False
+)
 @click.pass_obj
-def cmd_profile_create(cfg: Config, name: str, api_url: str, api_key: str, activate: bool) -> None:
+def cmd_profile_create(cfg: Config, name: str, api_url: str, api_key: str, activate: bool, use_keychain: bool) -> None:
     """Create a new profile."""
-    cfg_profile = ConfigSchema(platform_url=api_url, api_key=api_key)
+    cfg_profile = ConfigSchema(platform_url=api_url, api_key=api_key, use_keychain=use_keychain)
 
     cfg.add_profile(profile_name=name, profile=cfg_profile, set_active=activate)
     profile_show(cfg)

{hafnia-0.3.0 → hafnia-0.4.0}/src/hafnia/__init__.py

@@ -3,4 +3,4 @@ from importlib.metadata import version
 __package_name__ = "hafnia"
 __version__ = version(__package_name__)
 
-__dataset_format_version__ = "0.0.2"  # Hafnia dataset format version
+__dataset_format_version__ = "0.1.0"  # Hafnia dataset format version

{hafnia-0.3.0 → hafnia-0.4.0}/src/hafnia/dataset/dataset_helpers.py

@@ -38,12 +38,19 @@ def hash_from_bytes(data: bytes) -> str:
 
 def save_image_with_hash_name(image: np.ndarray, path_folder: Path) -> Path:
     pil_image = Image.fromarray(image)
+    path_image = save_pil_image_with_hash_name(pil_image, path_folder)
+    return path_image
+
+
+def save_pil_image_with_hash_name(image: Image.Image, path_folder: Path, allow_skip: bool = True) -> Path:
     buffer = io.BytesIO()
-    pil_image.save(buffer, format="PNG")
+    image.save(buffer, format="PNG")
     hash_value = hash_from_bytes(buffer.getvalue())
     path_image = Path(path_folder) / relative_path_from_hash(hash=hash_value, suffix=".png")
+    if allow_skip and path_image.exists():
+        return path_image
     path_image.parent.mkdir(parents=True, exist_ok=True)
-    pil_image.save(path_image)
+    image.save(path_image)
     return path_image