Merge pull request #258 from jumpstarter-dev/entrypoints

Implement `jmp driver list` command for listing locally installed drivers

Author: NickCao

packages/jumpstarter-cli-driver/README.md

@@ -0,0 +1 @@
+# Jumpstarter Driver CLI

packages/jumpstarter-cli-driver/jumpstarter_cli_driver/__init__.py

@@ -0,0 +1,24 @@
+import logging
+from typing import Optional
+
+import asyncclick as click
+from jumpstarter_cli_common import AliasedGroup, opt_log_level, version
+
+from .driver import list_drivers
+
+
+@click.group(cls=AliasedGroup)
+@opt_log_level
+def driver(log_level: Optional[str]):
+    """Jumpstarter driver CLI tool"""
+    if log_level:
+        logging.basicConfig(level=log_level.upper())
+    else:
+        logging.basicConfig(level=logging.INFO)
+
+
+driver.add_command(list_drivers)
+driver.add_command(version)
+
+if __name__ == "__main__":
+    driver()

packages/jumpstarter-cli-driver/jumpstarter_cli_driver/driver.py

@@ -0,0 +1,13 @@
+from importlib.metadata import entry_points
+
+import asyncclick as click
+from jumpstarter_cli_common import make_table
+
+
+@click.command("list")
+async def list_drivers():
+    drivers = list(entry_points(group="jumpstarter.drivers"))
+    if not drivers:
+        click.echo("No drivers found.")
+    else:
+        click.echo(make_table(["NAME", "TYPE"], [{"NAME": e.name, "TYPE": e.value.replace(":", ".")} for e in drivers]))

packages/jumpstarter-cli-driver/jumpstarter_cli_driver/driver_test.py

@@ -0,0 +1,20 @@
+import pytest
+from asyncclick.testing import CliRunner
+
+from . import driver
+
+
+@pytest.mark.anyio
+async def test_list_drivers():
+    runner = CliRunner()
+
+    result = await runner.invoke(
+        driver,
+        ["list"],
+    )
+    assert result.exit_code == 0
+
+
+@pytest.fixture
+def anyio_backend():
+    return "asyncio"

packages/jumpstarter-cli-driver/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "jumpstarter-cli-driver"
+dynamic = ["version", "urls"]
+description = ""
+authors = [
+  { name = "Nick Cao", email = "[email protected]" },
+  { name = "Miguel Angel Ajo Pelayo", email = "[email protected]" },
+  { name = "Kirk Brauer", email = "[email protected]" },
+]
+readme = "README.md"
+license = { text = "Apache-2.0" }
+requires-python = ">=3.11"
+dependencies = [
+    "jumpstarter-cli-common",
+    "asyncclick>=8.1.7.2",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.2",
+    "pytest-anyio>=0.0.0",
+    "pytest-asyncio>=0.0.0",
+    "pytest-cov>=5.0.0",
+]
+
+[project.scripts]
+jmp-driver = "jumpstarter_cli_driver:driver"
+
+[tool.hatch.build.targets.wheel]
+packages = ["jumpstarter_cli_driver"]
+
+[tool.hatch.metadata.hooks.vcs.urls]
+Homepage = "https://jumpstarter.dev"
+source_archive = "https://github.com/jumpstarter-dev/repo/archive/{commit_hash}.zip"
+
+[tool.hatch.version]
+source = "vcs"
+raw-options = { 'root' = '../../'}
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"

packages/jumpstarter-cli/jumpstarter_cli/__init__.py

@@ -2,6 +2,7 @@
 from jumpstarter_cli_admin import admin
 from jumpstarter_cli_client import client
 from jumpstarter_cli_common import AliasedGroup, version
+from jumpstarter_cli_driver import driver
 from jumpstarter_cli_exporter import exporter
 
 
@@ -11,6 +12,7 @@ def jmp():
 
 
 jmp.add_command(client)
+jmp.add_command(driver)
 jmp.add_command(exporter)
 jmp.add_command(admin)
 jmp.add_command(version)

packages/jumpstarter-cli/pyproject.toml

@@ -13,6 +13,7 @@ requires-python = ">=3.11"
 dependencies = [
   "jumpstarter-cli-admin",
   "jumpstarter-cli-client",
+  "jumpstarter-cli-driver",
   "jumpstarter-cli-exporter",
 ]
 

packages/jumpstarter-driver-can/pyproject.toml

@@ -16,6 +16,11 @@ dependencies = [
     "can-isotp>=2.0.6",
 ]
 
+[project.entry-points."jumpstarter.drivers"]
+Can = "jumpstarter_driver_can.driver:Can"
+IsoTpPython = "jumpstarter_driver_can.driver:IsoTpPython"
+IsoTpSocket = "jumpstarter_driver_can.driver:IsoTpSocket"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

packages/jumpstarter-driver-composite/pyproject.toml

@@ -14,6 +14,9 @@ dependencies = [
     "asyncclick>=8.1.7.2"
 ]
 
+[project.entry-points."jumpstarter.drivers"]
+Composite = "jumpstarter_driver_composite.driver:Composite"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

packages/jumpstarter-driver-dutlink/pyproject.toml

@@ -22,6 +22,12 @@ dependencies = [
     "asyncclick>=8.1.7.2"
 ]
 
+[project.entry-points."jumpstarter.drivers"]
+Dutlink = "jumpstarter_driver_dutlink.driver:Dutlink"
+DutlinkSerial = "jumpstarter_driver_dutlink.driver:DutlinkSerial"
+DutlinkStorageMux = "jumpstarter_driver_dutlink.driver:DutlinkStorageMux"
+DutlinkPower = "jumpstarter_driver_dutlink.driver:DutlinkPower"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

packages/jumpstarter-driver-network/pyproject.toml

@@ -16,6 +16,18 @@ dependencies = [
     "wsproto>=1.2.0"
 ]
 
+[project.entry-points."jumpstarter.drivers"]
+TcpNetwork = "jumpstarter_driver_network.driver:TcpNetwork"
+UdpNetwork = "jumpstarter_driver_network.driver:UdpNetwork"
+UnixNetwork = "jumpstarter_driver_network.driver:UnixNetwork"
+EchoNetwork = "jumpstarter_driver_network.driver:EchoNetwork"
+
+[project.entry-points."jumpstarter.adapters"]
+TcpPortforward = "jumpstarter_driver_network.adapters:TcpPortforwardAdapter"
+UnixPortforward = "jumpstarter_driver_network.adapters:UnixPortforwardAdapter"
+Pexpect = "jumpstarter_driver_network.adapters:PexpectAdapter"
+Novnc = "jumpstarter_driver_network.adapters:NovncAdapter"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

packages/jumpstarter-driver-opendal/pyproject.toml

@@ -15,6 +15,9 @@ dependencies = [
     "asyncclick>=8.1.7.2"
 ]
 
+[project.entry-points."jumpstarter.adapters"]
+Opendal = "jumpstarter_driver_opendal.adapters:OpendalAdapter"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

packages/jumpstarter-driver-power/pyproject.toml

@@ -15,6 +15,9 @@ dependencies = [
     "asyncclick>=8.1.7.2"
 ]
 
+[project.entry-points."jumpstarter.drivers"]
+MockPower = "jumpstarter_driver_power.driver:MockPower"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

packages/jumpstarter-driver-raspberrypi/pyproject.toml

@@ -15,6 +15,10 @@ dependencies = [
     "gpiozero>=2.0.1",
 ]
 
+[project.entry-points."jumpstarter.drivers"]
+DigitalInput = "jumpstarter_driver_raspberrypi.driver:DigitalInput"
+DigitalOutput = "jumpstarter_driver_raspberrypi.driver:DigitalOutput"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

packages/jumpstarter-driver-sdwire/pyproject.toml

@@ -15,6 +15,9 @@ dependencies = [
     "pyudev>=0.24.3",
 ]
 
+[project.entry-points."jumpstarter.drivers"]
+SDWire = "jumpstarter_driver_sdwire.driver:SDWire"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.2",

pyproject.toml

@@ -7,6 +7,7 @@ jumpstarter-cli = { workspace = true }
 jumpstarter-cli-admin = { workspace = true }
 jumpstarter-cli-client = { workspace = true }
 jumpstarter-cli-common = { workspace = true }
+jumpstarter-cli-driver = { workspace = true }
 jumpstarter-cli-exporter = { workspace = true }
 jumpstarter-driver-can = { workspace = true }
 jumpstarter-driver-composite = { workspace = true }