Merge pull request #12 from Unity-Technologies/release/0.6.0

Release 0.6.0

Author: gauthial

CHANGELOG.md

@@ -5,7 +5,20 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [0.5.0]
+## [0.6.0] - 2025-05-28
+
+### Added
+- Assets containing only one audio file will automatically have their preview set as the same audio file.
+
+### Fixed
+- Fix preview detection for `One file = one asset` strategy.
+- Section for Virtual Private Cloud Support in documentation
+
+### Changed
+- Cleaned up documentation
+- Updated Python SDK dependency for bulk_upload to 0.10.7
+
+## [0.5.0] - 2025-03-21
 
 ### Added
 - Added the capacity to replicate assets' folder structure into collections.
@@ -65,4 +78,4 @@ Initial release
 
 Features:
 - Source code of `bulk_upload_cli`
-- Source code of `bulk_download_script`
+- Source code of `bulk_download_script`

bulk_upload_cli/README.md

@@ -153,7 +153,6 @@ def map_assets(self, config: ProjectUploaderConfig) -> [AssetInfo]:
 
     @staticmethod
     def is_preview_file(file_path) -> bool:
-
         file_suffix = file_path.suffix.lower()
         is_picture_file = file_suffix in [".png", ".jpg", ".jpeg", ".bmp", ".gif"]
 
@@ -253,9 +252,8 @@ def map_assets(self, config: ProjectUploaderConfig) -> [AssetInfo]:
                     continue
 
                 if self.is_preview_file(file):
-                    file_stem = file.stem.lower().replace("_preview", "")
-                    potential_previews[file_stem] = FileInfo(file,
-                                                             PurePosixPath(file.relative_to(config.assets_path)))
+                    file_stem = self.remove_preview_suffix(file)
+                    potential_previews[file_stem] = FileInfo(file, PurePosixPath(file.relative_to(config.assets_path)))
 
         for file in files:
             if self.is_directory_path(file):
@@ -284,17 +282,32 @@ def map_assets(self, config: ProjectUploaderConfig) -> [AssetInfo]:
 
     @staticmethod
     def is_preview_file(file_path) -> bool:
-        file_suffix = file_path.suffix
-        is_picture_file= file_suffix in [".png", ".jpg", ".jpeg", ".bmp", ".gif"]
+        file_suffix = file_path.suffix.lower()
+        is_picture_file = file_suffix in [".png", ".jpg", ".jpeg", ".bmp", ".gif"]
 
         file_stem = file_path.stem.lower()
+        file_name_is_preview = file_stem in ["preview", "previews", "thumbnail", "thumbnails"]
 
-        return file_stem.endswith("_preview") and is_picture_file
+        file_parent_folder = file_path.parent.name.lower()
+        parent_folder_is_preview = file_parent_folder in ["preview", "previews", "thumbnail", "thumbnails"]
+
+        return is_picture_file and file_name_is_preview or is_picture_file and parent_folder_is_preview
 
     @staticmethod
     def is_directory_path(file_path) -> bool:
         return len(file_path.name.split("/")[-1].split(".")) == 1
 
+    @staticmethod
+    def remove_preview_suffix(file_path) -> str:
+        file_stem = file_path.stem.lower()
+
+        for suffix in ["preview", "previews", "thumbnail", "thumbnails"]:
+            if file_stem.endswith(suffix):
+                new_stem = file_stem.replace(suffix, "")
+                break
+
+        return file_stem
+
 
 class CsvAssetMapper(AssetMapper):
 

bulk_upload_cli/bulk_upload/asset_mappers.py

@@ -84,7 +84,10 @@ def get_collection(org_id, project_id) -> str:
                                                                description=collection)
             uc.assets.create_collection(collection_creation, org_id, project_id)
 
-        return collection if collection != "No collection" else ""
+        if collection == "No collection":
+            return ""
+
+        return collection
 
     @staticmethod
     def get_assets_organization() -> bool:
@@ -157,7 +160,13 @@ def apply_asset_customization(self, assets: [AssetInfo], config: ProjectUploader
 
 def get_cloud_collections(org_id: str, project_id: str):
     collections = uc.assets.list_collections(org_id, project_id)
-    return [collection.name for collection in collections]
+    collections_choices = []
+    for collection in collections:
+        if collection.parent_path == "":
+            collections_choices.append(collection.name)
+        else:
+            collections_choices.append(f"{collection.parent_path}/{collection.name}")
+    return collections_choices
 
 
 def sanitize_tags(tags: str) -> list[str]:

bulk_upload_cli/bulk_upload/assets_customization_providers.py

@@ -27,7 +27,15 @@ def __init__(self):
     def upload_assets(self, asset_infos: [AssetInfo], config: ProjectUploaderConfig, app_settings: AppSettings):
         self.config = config
 
-        cloud_assets = [] if config.strategy == Strategy.CLOUD_ASSET else uc.assets.get_asset_list(self.config.org_id, self.config.project_id)
+        cloud_assets = []
+        if config.strategy != Strategy.CLOUD_ASSET:
+            try:
+                cloud_assets = uc.assets.get_asset_list(self.config.org_id, self.config.project_id)
+            except Exception as e:
+                logger.exception(f"Failed to get cloud assets: {e}")
+                logger.warning("====== WARNING ====")
+                logger.warning("Upload will continue, but no update can be made, only creation. /n")
+
 
         if asset_infos is None:
             return
@@ -222,6 +230,9 @@ def set_asset_decorations(self, asset: AssetInfo, skip_freeze: bool = False):
             print(asset.customization.description)
             asset_update.description = asset.customization.description
 
+        if len(asset.preview_files) == 0 and asset.is_audio_asset():
+            asset_update = AssetUpdate(name=asset.name, preview_file=asset.files[0].cloud_path)
+
         try:
             uc.assets.update_asset(asset_update, self.config.org_id, self.config.project_id, asset.am_id, asset.version)
         except Exception as e:
@@ -238,6 +249,8 @@ def create_collections(self, collections: [CollectionInfo]):
                 if not collection.exists_in_cloud:
                     collection_creation = CollectionCreation(name=collection.get_name(), parent_path=collection.get_parent(), description=collection.get_name())
                     uc.assets.create_collection(collection_creation, self.config.org_id, self.config.project_id)
+                    # wait for the collection to be created since this can cause unauthorized errors if the collection is not ready
+                    time.sleep(0.5)
                     collection.exists_in_cloud = True
 
             except Exception as e:
@@ -248,8 +261,9 @@ def set_collections(self, collections: [CollectionInfo]):
         for collection in collections:
             try:
                 if len(collection.assets) > 0:
-                    uc.assets.link_assets_to_collection(self.config.org_id, self.config.project_id, collection.path.__str__(), [asset.am_id for asset in collection.assets])
-
+                    uc.assets.link_assets_to_collection(self.config.org_id, self.config.project_id,
+                                                        collection.path.__str__(),
+                                                        [asset.am_id for asset in collection.assets])
             except Exception as e:
                 print(f'Failed to set assets to collection : {collection.path.__str__()}', flush=True)
                 print(e, flush=True)

bulk_upload_cli/bulk_upload/assets_uploaders.py

@@ -178,6 +178,8 @@ def get_folder_config(self, strategy: Strategy) -> ProjectUploaderConfig:
             self.config.hierarchical_level = self.execute_prompt_auto(inquirer.number(
                 message="Enter the depth of directory grouping (for example, 1 to group by top folders in your asset directory)"),
                 self.config.hierarchical_level)
+
+        if strategy == Strategy.SINGLE_FILE_ASSET or strategy == Strategy.FOLDER_GROUPING:
             self.config.preview_detection = self.execute_prompt_auto(inquirer.confirm(
                 message="Would you like to enable automatic preview detection (see documentation to see how it is detected)?"),
                 self.config.preview_detection)

bulk_upload_cli/bulk_upload/config_providers.py

@@ -265,6 +265,18 @@ def from_csv(self, csv_row: {}):
     def get_files_size(self):
         return sum([os.stat(f.path.__str__()).st_size for f in self.files])
 
+    def is_audio_asset(self):
+        if len(self.files) == 1:
+            return self.is_audio_extension(self.files[0].path.suffix)
+        elif len(self.files) == 2:
+            return any(self.is_audio_extension(f.path.suffix) for f in self.files) \
+                    and any(f.path.suffix in [".meta"] for f in self.files)
+        return False
+
+    @staticmethod
+    def is_audio_extension(extension: str):
+        return extension.lower() in [".wav", ".mp3", ".ogg", ".aiff", ".aif"]
+
 
 class AssetCustomization(object):
     def __init__(self):

bulk_upload_cli/bulk_upload/models.py

@@ -1,6 +1,6 @@
 # This file lists all pip dependencies
 
 --extra-index-url https://unity3ddist.jfrog.io/artifactory/api/pypi/am-pypi-prod-local/simple
-unity_cloud == 0.10.6
+unity_cloud == 0.10.7
 
-InquirerPy
+InquirerPy