Refactoring (#3)

* Add mkdocs-glightbox to dependencies * Update sensor and output registration in pyproject.toml * Update asset browser name * Remove unused imports in environment.py * Update output path default value in CLI * Fix asset library addition to catalog * Remove Python formatting settings
DFKI-NI · Dec 1, 2023 · 31892f3 · 31892f3
1 parent 001bda8
commit 31892f3
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 37 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/docs/README.md b/docs/README.md
@@ -6,6 +6,7 @@ To build the documentation, you need to install [Material for MKDocs](https://sq
 
 ```bash
 pip install mkdocs-material
+pip install mkdocs-glightbox
 ```
 
 ## Serve

diff --git a/docs/docs/developement/add_functionality/create_sensor.md b/docs/docs/developement/add_functionality/create_sensor.md
@@ -149,13 +149,14 @@ class LaserDistanceOutput(OutputInterface):
 
 1. The `RevertAfter` context manager is used to revert all changes made to the scene after the context manager is exited.
 
-### Plugin Registration
+### Sensor and Ouput Registration
 
 To register your sensor and output plugins with Syclops, add entries in your pyproject.toml file under the [project.entry-points."syclops.plugins"] section. For example:
 
 ```toml title="pyproject.toml"
-[project.entry-points."syclops.plugins"]
+[project.entry-points."syclops.sensors"]
 syclops_laser_sensor = "path.to.laser_distance_sensor:LaserDistanceSensor"
+[project.entry-points."syclops.outputs"]
 syclops_laser_output = "path.to.laser_distance_output:LaserDistanceOutput"
 ```
 

diff --git a/syclops/asset_manager/asset_browser/public/index.html b/syclops/asset_manager/asset_browser/public/index.html
@@ -7,7 +7,7 @@
     <meta name="theme-color" content="#000000" />
     <meta
       name="description"
-      content="Syclopes Asset Browser"
+      content="Syclops Asset Browser"
     />
     <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
     <!--
@@ -28,7 +28,7 @@
       rel="stylesheet"
       href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap"
     />
-    <title>Syclopes Asset Browser</title>
+    <title>Syclops Asset Browser</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

diff --git a/syclops/asset_manager/asset_browser/public/manifest.json b/syclops/asset_manager/asset_browser/public/manifest.json
@@ -1,6 +1,6 @@
 {
   "short_name": "Asset Browser",
-  "name": "Syclopes Asset Browser",
+  "name": "Syclops Asset Browser",
   "icons": [
     {
       "src": "favicon.ico",

diff --git a/syclops/asset_manager/asset_crawler.py b/syclops/asset_manager/asset_crawler.py
@@ -117,12 +117,16 @@ def _merge_manifests(self, manifest_files: list, root_path: Path) -> dict:
         merged_manifest["root_path"] = str(root_path.absolute())
         return merged_manifest
 
+
     def _add_assets_to_catalog(self, manifest: dict):
         asset_library_name = manifest["name"]
         if asset_library_name in self.asset_catalog:
-            raise Exception(
-                "Asset library {} already exists in catalog.".format(asset_library_name)
+            print(
+                "Warning: Asset library '{}' already exists in catalog. Skipping addition.".format(
+                    asset_library_name
+                )
             )
+            return
         self.asset_catalog[asset_library_name] = manifest
 
     def check_catalog(self):
@@ -182,29 +186,26 @@ def write_catalog(self, catalog_path: str):
             self.yaml.dump(self.asset_catalog, f)
 
     def create_thumbnails(self, blender_path: Path):
-        thumbnail_generator_path = (
-            Path(__file__).parent / "thumbnail_generator.py"
-        )
+        thumbnail_generator_path = Path(__file__).parent / "thumbnail_generator.py"
 
         for manifest_path in self.manifest_files:
             print(f"Generate thumbnails for {manifest_path}")
             subprocess.run(
                 [
-                blender_path,
-                Path(__file__).resolve().parent / "studio.blend",
+                    blender_path,
+                    Path(__file__).resolve().parent / "studio.blend",
                     "-P",
                     thumbnail_generator_path,
                     "-b",
                     "--",
                     "--asset",
                     manifest_path,
                     "--site-packages-path",
-                    get_site_packages_path()
+                    get_site_packages_path(),
                 ]
             )
 
 
-
 if __name__ == "__main__":
     # Create a new asset crawler
     asset_crawler = AssetCrawler(ASSET_LIBRARY_PATHS)

diff --git a/syclops/blender/plugins/environment.py b/syclops/blender/plugins/environment.py
@@ -1,6 +1,4 @@
 import logging
-import os
-from pathlib import Path
 
 import bpy
 import numpy as np

diff --git a/syclops/cli.py b/syclops/cli.py
@@ -50,7 +50,7 @@
 parser.add_argument(
     "-o",
     "--output-path",
-    help="Output path of generated files",
+    help="Output path of generated files. Defaults to <install_folder>/output",
     default="./output",
 )
 parser.add_argument(
@@ -91,20 +91,6 @@
     help="Live view of textures in the job config",
 )
 
-parser.add_argument(
-    "-i",
-    "--install",
-    help="Install code from src to install folder. If no folders are specified, everything will be copied.",
-    nargs="*",
-)
-
-parser.add_argument(
-    "-p",
-    "--pull_repos",
-    help="Pull all or a list of git repos",
-    nargs="*",
-)
-
 parser.add_argument(
     "-if",
     "--install_folder",