CLI Source Option (#11)

* option to source custom code in CLI * removed empty dicts * [Automated] Updated coverage badge --------- Co-authored-by: GitHub Actions <[email protected]>
luxonis · Oct 9, 2024 · 92fd295 · 92fd295
1 parent 2c654a5
commit 92fd295
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 239 deletions.
diff --git a/luxonis_train/__main__.py b/luxonis_train/__main__.py
@@ -214,13 +214,18 @@ def common(
             "--version", callback=version_callback, help="Show version and exit."
         ),
     ] = False,
+    source: Annotated[
+        Optional[Path],
+        typer.Option(
+            help="Path to a python file with custom components. "
+            "Will be sourced before running the command.",
+            metavar="FILE",
+        ),
+    ] = None,
 ):
-    ...
-
-
-def main():
-    app()
+    if source:
+        exec(source.read_text())
 
 
 if __name__ == "__main__":
-    main()
+    app()
diff --git a/luxonis_train/core/exporter.py b/luxonis_train/core/exporter.py
@@ -18,15 +18,12 @@
 
 
 class Exporter(Core):
-    """Main API which is used to create the model, setup pytorch lightning environment
-    and perform training based on provided arguments and config."""
-
     def __init__(
         self,
         cfg: str | dict[str, Any] | Config,
         opts: list[str] | tuple[str, ...] | dict[str, Any] | None = None,
     ):
-        """Constructs a new Exporter instance.
+        """Provides an interface for exporting models to .onnx and .blob formats.
 
         @type cfg: str | dict[str, Any] | Config
         @param cfg: Path to config file or config dict used to setup training.

diff --git a/media/coverage_badge.svg b/media/coverage_badge.svg
diff --git a/pyproject.toml b/pyproject.toml
@@ -19,7 +19,7 @@ classifiers = [
 ]
 
 [project.scripts]
-luxonis_train = "tools.main:main"
+luxonis_train = "luxonis_train.__main__:app"
 
 [project.urls]
 repository = "https://github.com/luxonis/luxonis-train"

diff --git a/tools/main.py b/tools/main.py