feat: add GET command (cutekit's simple package manager)

.github/workflows/checks.yml

@@ -13,12 +13,12 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2
 
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
-        python-version: '3.11'
+        python-version: '3.x'
 
     - name: Install dependencies
       run: |

.github/workflows/publish.yml

@@ -20,14 +20,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
+    - uses: actions/checkout@v3
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
-        python-version: '3.11'
-
+        python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

cutekit/__init__.py

@@ -6,6 +6,7 @@ from . import (
     builder,  # noqa: F401 this is imported for side effects
     cli,
     const,
+    get,  # noqa: F401 this is imported for side effects
     graph,  # noqa: F401 this is imported for side effects
     model,
     plugins,

cutekit/builder.py

@@ -203,10 +203,8 @@ def build(
     all = False
     shell.mkdir(target.builddir)
     ninjaPath = os.path.join(target.builddir, "build.ninja")
-
-    if not os.path.exists(ninjaPath):
-        with open(ninjaPath, "w") as f:
-            gen(f, target, registry)
+    with open(ninjaPath, "w") as f:
+        gen(f, target, registry)
 
     if components is None:
         all = True
@@ -230,9 +228,10 @@ def build(
         )
 
     outs = list(map(lambda p: str(p.path), products))
-
-    shell.exec("ninja", "-f", ninjaPath, *(outs if not all else []))
-
+    if all:
+        shell.exec("ninja", "-f", ninjaPath)
+    else:
+        shell.exec("ninja", "-f", ninjaPath, *outs)
     return products
 
 
@@ -244,9 +243,9 @@ def buildCmd(args: cli.Args):
     registry = model.Registry.use(args)
     target = model.Target.use(args)
     componentSpec = args.consumeArg()
-    component = None
-    if componentSpec is not None:
-        component = registry.lookup(componentSpec, model.Component)
+    if componentSpec is None:
+        raise RuntimeError("No component specified")
+    component = registry.lookup(componentSpec, model.Component)
     build(target, registry, component)[0]
 
 

cutekit/get.py

@@ -0,0 +1,67 @@
+from . import cli
+from . import const
+from . import model
+from . import shell
+
+import dataclasses as dt
+import json
+import logging
+
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+_logger = logging.getLogger(__name__)
+
+
+@dt.dataclass
+class InstallManifest:
+    plugins: list[str]
+    targets: list[str]
+
+
+@cli.command("G", "get", "Get a package from a remote repository")
+def getCmd(args: cli.Args):
+    pkg = args.consumeArg()
+    repo = args.consumeOpt(
+        "repository", "https://github.com/cute-engineering/cutekit-contrib.git"
+    )
+
+    project = model.Project.topmost()
+
+    if project is None:
+        raise RuntimeError("Not inside a project")
+
+    if pkg is None:
+        raise RuntimeError("No package specified")
+
+    with TemporaryDirectory() as temp:
+        try:
+            shell.cloneDir(repo, pkg, temp)
+        except FileNotFoundError:
+            raise RuntimeError(f"Package {pkg} not found")
+
+        pkg_path = Path(temp) / pkg
+
+        with (pkg_path / "install.json").open("r") as f:
+            manifest_json = json.load(f)
+
+            [
+                manifest_json.setdefault(key, [])
+                for key in InstallManifest.__dataclass_fields__.keys()
+            ]
+
+            manifest = InstallManifest(**manifest_json)
+
+        plugin_dir = Path(const.META_DIR) / "plugins"
+        target_dir = Path(const.TARGETS_DIR)
+
+        plugin_dir.mkdir(parents=True, exist_ok=True)
+        target_dir.mkdir(parents=True, exist_ok=True)
+
+        for plugin in manifest.plugins:
+            _logger.info(f"Copying {plugin} to {project.id}'s plugins")
+            shell.cp(str(pkg_path / plugin), plugin_dir)
+
+        for target in manifest.targets:
+            _logger.info(f"Copying {plugin} to {project.id}'s targets")
+            shell.cp(str(pkg_path / target), target_dir)

cutekit/model.py

@@ -71,7 +71,7 @@ class Manifest(DataClassJsonMixin):
         """
         Return the directory of the manifest
         """
-        return os.path.relpath(os.path.dirname(self.path), Path.cwd())
+        return os.path.dirname(self.path)
 
     def subpath(self, path) -> Path:
         return Path(self.dirname()) / path
@@ -121,18 +121,19 @@ class Project(Manifest):
 
     @staticmethod
     def ensure() -> "Project":
-        """
-        Ensure that a project exists in the current directory or any parent directory
-        and chdir to the root of the project.
-        """
         project = Project.topmost()
         if project is None:
             raise RuntimeError(
                 "No project found in this directory or any parent directory"
             )
-        os.chdir(project.dirname())
         return project
 
+    def chdir(self):
+        """
+        Change the current working directory to the root of the project
+        """
+        os.chdir(self.dirname())
+
     @staticmethod
     def at(path: Path) -> Optional["Project"]:
         projectManifest = Manifest.tryLoad(path / "project")

pyproject.toml

@@ -12,7 +12,7 @@ authors = [
     { name = "Cute Engineering", email = "contact@cute.engineering" },
 ]
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.10"
 license = { text = "MIT" }
 dynamic = ["version", "dependencies"]