Rename project to pyserial-pyusb / serial_pyusb and add PyPI publish workflow

Rename from pyserial-usbip/pyserial_usbip to pyserial-pyusb/serial_pyusb.
Move pyusb-usbip-backend to an optional "usbip" dependency. Add GitHub
Actions workflow for publishing to PyPI via trusted publishing (OIDC).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: tannewt

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyserial-pyusb"
+version = "0.1.0"
+description = "Pyserial backend for USB serial devices via pyusb (CDC ACM and CP210x)"
+requires-python = ">=3.9"
+dependencies = [
+    "pyserial>=3.5",
+    "pyusb>=1.3.1",
+]
+
+[project.optional-dependencies]
+usbip = ["pyusb-usbip-backend>=0.1.0"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

src/serial_pyusb/__init__.py

@@ -0,0 +1,15 @@
+"""Pyserial backend for USB serial devices via pyusb.
+
+Supports local USB devices (via libusb) and remote devices (via USB/IP).
+"""
+
+from serial_pyusb.serial import Serial
+
+# Auto-register the pyusb:// URL handler with pyserial on import.
+import importlib as _importlib
+_serial_pkg = _importlib.import_module("serial")
+_HANDLER_PACKAGE = "serial_pyusb.urlhandler"
+if _HANDLER_PACKAGE not in _serial_pkg.protocol_handler_packages:
+    _serial_pkg.protocol_handler_packages.append(_HANDLER_PACKAGE)
+
+__all__ = ["Serial"]

src/serial_pyusb/drivers/__init__.py

@@ -0,0 +1,7 @@
+"""USB serial device drivers."""
+
+from serial_pyusb.drivers.base import USBSerialDriver
+from serial_pyusb.drivers.cdc_acm import CDCACMDriver
+from serial_pyusb.drivers.cp210x import CP210xDriver
+
+__all__ = ["USBSerialDriver", "CDCACMDriver", "CP210xDriver"]

src/serial_pyusb/drivers/base.py

@@ -0,0 +1,85 @@
+"""Base class for USB serial drivers."""
+
+import usb.core
+import usb.util
+
+
+class USBSerialDriver:
+    """Abstract base for USB serial device drivers.
+
+    Subclasses implement the vendor-specific USB control transfers needed to
+    configure baud rate, line parameters, and modem control signals for a
+    particular USB-to-serial chip.
+    """
+
+    def __init__(self, dev: usb.core.Device):
+        self.dev = dev
+        self.logger = None
+        self._ep_in = None
+        self._ep_out = None
+        self._find_endpoints()
+
+    def _find_endpoints(self):
+        """Locate bulk IN and OUT endpoints on the data interface."""
+        cfg = self.dev.get_active_configuration()
+        intf = self._get_data_interface(cfg)
+        for ep in intf:
+            direction = usb.util.endpoint_direction(ep.bEndpointAddress)
+            ep_type = usb.util.endpoint_type(ep.bmAttributes)
+            if ep_type == usb.util.ENDPOINT_TYPE_BULK:
+                if direction == usb.util.ENDPOINT_IN:
+                    self._ep_in = ep.bEndpointAddress
+                elif direction == usb.util.ENDPOINT_OUT:
+                    self._ep_out = ep.bEndpointAddress
+        if self._ep_in is None or self._ep_out is None:
+            raise usb.core.USBError("Could not find bulk IN/OUT endpoints")
+
+    def _get_data_interface(self, cfg):
+        """Return the USB interface that carries serial data.
+
+        Override in subclasses if the data interface is not interface 0.
+        """
+        return cfg[(0, 0)]
+
+    # -- Methods subclasses must implement --
+
+    def open(self):
+        """Enable the serial interface on the device."""
+        raise NotImplementedError
+
+    def close(self):
+        """Disable the serial interface on the device."""
+        raise NotImplementedError
+
+    def set_baudrate(self, baudrate: int):
+        raise NotImplementedError
+
+    def set_line_params(self, bytesize: int, parity: str, stopbits: float):
+        """Configure data bits, parity, and stop bits."""
+        raise NotImplementedError
+
+    def set_dtr(self, state: bool):
+        raise NotImplementedError
+
+    def set_rts(self, state: bool):
+        raise NotImplementedError
+
+    def get_modem_status(self) -> dict:
+        """Return dict with bool keys: cts, dsr, ri, cd."""
+        return {"cts": True, "dsr": True, "ri": False, "cd": True}
+
+    def set_break(self, state: bool):
+        pass
+
+    # -- Data transfer --
+
+    def write(self, data: bytes, timeout: int = 0) -> int:
+        return self.dev.write(self._ep_out, data, timeout=timeout)
+
+    def read(self, size: int, timeout: int = 0) -> bytes:
+        return bytes(self.dev.read(self._ep_in, size, timeout=timeout))
+
+    @classmethod
+    def matches(cls, dev: usb.core.Device) -> bool:
+        """Return True if this driver can handle the given USB device."""
+        raise NotImplementedError

src/serial_pyusb/drivers/cdc_acm.py

@@ -0,0 +1,140 @@
+"""Standard USB CDC ACM serial driver."""
+
+import struct
+
+import usb.core
+import usb.util
+
+from serial_pyusb.drivers.base import USBSerialDriver
+
+# CDC class requests
+_SET_LINE_CODING = 0x20
+_GET_LINE_CODING = 0x21
+_SET_CONTROL_LINE_STATE = 0x22
+_SEND_BREAK = 0x23
+
+# Line coding: parity
+_PARITY = {"N": 0, "O": 1, "E": 2, "M": 3, "S": 4}
+
+# Line coding: stop bits
+_STOP_BITS = {1: 0, 1.5: 1, 2: 2}
+
+# USB CDC interface class/subclass
+_CDC_CLASS = 0x02
+_CDC_ACM_SUBCLASS = 0x02
+_CDC_DATA_CLASS = 0x0A
+
+
+class CDCACMDriver(USBSerialDriver):
+    """Driver for standard USB CDC ACM serial devices."""
+
+    def __init__(self, dev: usb.core.Device):
+        self._ctrl_intf = 0
+        self._data_intf = 1
+        self._dtr = False
+        self._rts = False
+        self._baudrate = 9600
+        self._stop_val = 0
+        self._parity_val = 0
+        self._data_bits = 8
+        super().__init__(dev)
+        self._detect_interfaces()
+
+    def _detect_interfaces(self):
+        """Find the CDC control and data interfaces from descriptors."""
+        try:
+            cfg = self.dev.get_active_configuration()
+        except usb.core.USBError:
+            self.dev.set_configuration()
+            cfg = self.dev.get_active_configuration()
+        for intf in cfg:
+            if (intf.bInterfaceClass == _CDC_CLASS and
+                    intf.bInterfaceSubClass == _CDC_ACM_SUBCLASS):
+                self._ctrl_intf = intf.bInterfaceNumber
+            elif intf.bInterfaceClass == _CDC_DATA_CLASS:
+                self._data_intf = intf.bInterfaceNumber
+
+    def _get_data_interface(self, cfg):
+        return cfg[(self._data_intf, 0)]
+
+    def _send_line_state(self):
+        """Send SET_CONTROL_LINE_STATE with current DTR/RTS."""
+        value = (int(self._dtr)) | (int(self._rts) << 1)
+        if self.logger:
+            self.logger.debug("cdc_acm SET_CONTROL_LINE_STATE val=0x%04x (DTR=%s RTS=%s)", value, self._dtr, self._rts)
+        self.dev.ctrl_transfer(
+            0x21, _SET_CONTROL_LINE_STATE, value, self._ctrl_intf, timeout=1000
+        )
+
+    def open(self):
+        self._dtr = True
+        self._rts = True
+        self._send_line_state()
+
+    def close(self):
+        self._dtr = False
+        self._rts = False
+        self._send_line_state()
+
+    def _send_line_coding(self):
+        """Send SET_LINE_CODING with current cached values."""
+        payload = struct.pack(
+            "<IBBB",
+            self._baudrate,
+            self._stop_val,
+            self._parity_val,
+            self._data_bits,
+        )
+        if self.logger:
+            self.logger.debug(
+                "cdc_acm SET_LINE_CODING baud=%d stop=%d parity=%d bits=%d payload=%s",
+                self._baudrate, self._stop_val, self._parity_val, self._data_bits,
+                payload.hex(),
+            )
+        self.dev.ctrl_transfer(
+            0x21, _SET_LINE_CODING, 0, self._ctrl_intf, payload, timeout=1000
+        )
+
+    def set_baudrate(self, baudrate: int):
+        self._baudrate = baudrate
+        self._send_line_coding()
+
+    def set_line_params(self, bytesize: int, parity: str, stopbits: float):
+        self._stop_val = _STOP_BITS.get(stopbits, 0)
+        self._parity_val = _PARITY.get(parity, 0)
+        self._data_bits = bytesize
+        self._send_line_coding()
+
+    def set_dtr(self, state: bool):
+        self._dtr = state
+        self._send_line_state()
+
+    def set_rts(self, state: bool):
+        self._rts = state
+        self._send_line_state()
+
+    def set_break(self, state: bool):
+        # SEND_BREAK: wValue = duration in ms, 0xFFFF = on until cleared, 0 = off
+        value = 0xFFFF if state else 0x0000
+        if self.logger:
+            self.logger.debug("cdc_acm SEND_BREAK val=0x%04x", value)
+        self.dev.ctrl_transfer(
+            0x21, _SEND_BREAK, value, self._ctrl_intf, timeout=1000
+        )
+
+    @classmethod
+    def matches(cls, dev: usb.core.Device) -> bool:
+        """Match any device with a CDC ACM interface."""
+        try:
+            cfg = dev.get_active_configuration()
+        except usb.core.USBError:
+            try:
+                dev.set_configuration()
+                cfg = dev.get_active_configuration()
+            except usb.core.USBError:
+                return False
+        for intf in cfg:
+            if (intf.bInterfaceClass == _CDC_CLASS and
+                    intf.bInterfaceSubClass == _CDC_ACM_SUBCLASS):
+                return True
+        return False