Setup proper pip package for pandacan (#2239)

- Add setup.py with custom build command to optionally build firmware
- Add MANIFEST.in to include firmware, certs, and headers in package
- Update pyproject.toml with proper package metadata and CLI entry points
- Make opendbc import optional to prevent installation failures
- Add CLI entry points for panda-health, panda-flash, and panda-version
- Convert script main functions to be callable from CLI entry points

This allows pandacan to be installed as a standard pip package with all
necessary components including firmware, certificates, and build tools.

Author: AgentsLogic

MANIFEST.in

@@ -0,0 +1,7 @@
+recursive-include board *.h
+include board/obj/*.bin
+include board/obj/*.signed
+recursive-include certs *
+include README.md
+include LICENSE
+

pyproject.toml

@@ -1,21 +1,43 @@
 [project]
 name = "pandacan"
-version = "0.0.10"
+version = "0.0.11"
 description = "Code powering the comma.ai panda"
 readme = "README.md"
 requires-python = ">=3.11,<3.13"  # macOS doesn't work with 3.13 due to pycapnp from opendbc
 license = {text = "MIT"}
 authors = [{name = "comma.ai"}]
+maintainers = [{name = "comma.ai"}]
+keywords = ["panda", "can", "vehicle", "comma", "openpilot", "hardware", "embedded"]
 classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
   "Natural Language :: English",
+  "Operating System :: POSIX :: Linux",
+  "Operating System :: MacOS",
+  "Operating System :: Microsoft :: Windows",
   "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
   "Topic :: System :: Hardware",
+  "Topic :: System :: Hardware :: Hardware Drivers",
+  "Topic :: Software Development :: Embedded Systems",
 ]
 dependencies = [
   "libusb1",
-  "opendbc @ git+https://github.com/commaai/opendbc.git@master#egg=opendbc",
 ]
 
+[project.urls]
+Homepage = "https://github.com/commaai/panda"
+Repository = "https://github.com/commaai/panda"
+"Bug Reports" = "https://github.com/commaai/panda/issues"
+Changelog = "https://github.com/commaai/panda/blob/master/README.md"
+
+[project.scripts]
+panda-health = "panda.scripts.can_health:main"
+panda-flash = "panda.scripts.reflash_internal_panda:main"
+panda-version = "panda.scripts.get_version:main"
+
 [project.optional-dependencies]
 dev = [
   "scons",
@@ -30,6 +52,7 @@ dev = [
   "mypy",
   "setuptools",
   "spidev; platform_system == 'Linux'",
+  "opendbc @ git+https://github.com/commaai/opendbc.git@master#egg=opendbc",
 ]
 
 [build-system]
@@ -38,10 +61,19 @@ build-backend = "setuptools.build_meta"
 
 [tool.setuptools]
 packages = ["panda"]
+include-package-data = true
 
 [tool.setuptools.package-dir]
 panda = "."
 
+[tool.setuptools.package-data]
+"panda" = [
+  "board/**/*.h",
+  "board/obj/*.bin",
+  "board/obj/*.signed",
+  "certs/**",
+]
+
 [tool.mypy]
 # third-party packages
 ignore_missing_imports = true

python/__init__.py

@@ -9,7 +9,13 @@
 from functools import wraps, partial
 from itertools import accumulate
 
-from opendbc.car.structs import CarParams
+try:
+  from opendbc.car.structs import CarParams
+except ImportError:
+  # opendbc is optional, create a minimal CarParams stub
+  class CarParams:
+    class SafetyModel:
+      silent = 0
 
 from .base import BaseHandle
 from .constants import FW_PATH, McuType
@@ -18,7 +24,7 @@
 from .usb import PandaUsbHandle
 from .utils import logger
 
-__version__ = '0.0.10'
+__version__ = '0.0.11'
 
 CANPACKET_HEAD_SIZE = 0x6
 DLC_TO_LEN = [0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 32, 48, 64]

scripts/can_health.py

@@ -14,8 +14,7 @@ def colorize_errors(value):
       return f'{RED}{value}\033[0m'
   return str(value)
 
-if __name__ == "__main__":
-
+def main():
   panda = Panda()
   while True:
     print(chr(27) + "[2J") # clear screen
@@ -27,3 +26,6 @@ def colorize_errors(value):
         print(f"{key}: {colorize_errors(value)}  ", end=" ")
     print()
     time.sleep(1)
+
+if __name__ == "__main__":
+  main()

scripts/get_version.py

@@ -1,7 +1,10 @@
 #!/usr/bin/env python3
 from panda import Panda
 
-if __name__ == "__main__":
+def main():
   for p in Panda.list():
     pp = Panda(p)
     print(f"{pp.get_serial()[0]}: {pp.get_version()}")
+
+if __name__ == "__main__":
+  main()

scripts/reflash_internal_panda.py

@@ -16,7 +16,7 @@ def gpio_set(pin, high):
     f.write(b"1" if high else b"0")
 
 
-if __name__ == "__main__":
+def main():
   for pin in (GPIO.STM_RST_N, GPIO.STM_BOOT0):
     gpio_init(pin, True)
 
@@ -38,3 +38,6 @@ def gpio_set(pin, high):
   p = Panda()
   assert p.bootstub
   p.flash()
+
+if __name__ == "__main__":
+  main()

setup.py

@@ -0,0 +1,44 @@
+from setuptools import setup
+from setuptools.command.build_py import build_py
+import subprocess
+import os
+import shutil
+
+class BuildPyWithFW(build_py):
+    def run(self):
+        # Check if ARM toolchain is available
+        toolchain_available = self._check_toolchain()
+
+        if toolchain_available:
+            print("ARM toolchain found, building firmware...")
+            try:
+                result = subprocess.run(['scons'], cwd=os.path.dirname(__file__),
+                                      capture_output=True, text=True, timeout=300)
+                if result.returncode != 0:
+                    print("SCons build failed:")
+                    print("STDOUT:", result.stdout)
+                    print("STDERR:", result.stderr)
+                    print("Warning: Firmware build failed, but continuing with package build.")
+                    print("Note: The package will not include firmware binaries.")
+                    print("To include firmware, install ARM GCC toolchain and rebuild.")
+                else:
+                    print("Firmware build completed successfully.")
+            except subprocess.TimeoutExpired:
+                print("Firmware build timed out after 5 minutes.")
+                print("Continuing with package build without firmware.")
+            except FileNotFoundError:
+                print("SCons not found. Install with: pip install scons")
+                print("Continuing with package build without firmware.")
+        else:
+            print("ARM GCC toolchain not found.")
+            print("Continuing with package build without firmware binaries.")
+            print("To include firmware, install arm-none-eabi-gcc and rebuild.")
+
+        super().run()
+
+    def _check_toolchain(self):
+        """Check if ARM GCC toolchain is available."""
+        return shutil.which('arm-none-eabi-gcc') is not None
+
+setup(cmdclass={'build_py': BuildPyWithFW})
+