Add PyPI

Author: Alexander Brinkman

.github/workflows/publish.yml

@@ -0,0 +1,43 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.14"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Verify tag format
+        run: |
+          if [[ ! "${{ github.ref }}" =~ ^refs/tags/v[0-9]+\.[0-9]+\.[0-9]+ ]]; then
+            echo "Tag does not match version format (v*.*.*)"
+            exit 1
+          fi
+
+      - name: Build distribution
+        run: python -m build
+
+      - name: Check distribution
+        run: twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

binding_configuration.py

@@ -66,9 +66,7 @@ def _load_config(self) -> ET.Element:
         tree = ET.parse(self.config_path)
         return tree.getroot()
 
-    def add_binding(
-        self, vendor_id: str, product_id: str, serial_number: str = ""
-    ) -> bool:
+    def add_binding(self, vendor_id: str, product_id: str, serial_number: str = "") -> bool:
         """
         Add a device binding to the configuration.
 
@@ -107,9 +105,7 @@ def add_binding(
         self._write_config(root)
         return True
 
-    def remove_binding(
-        self, vendor_id: str, product_id: str, serial_number: str = ""
-    ) -> bool:
+    def remove_binding(self, vendor_id: str, product_id: str, serial_number: str = "") -> bool:
         """
         Remove a device binding from the configuration.
 
@@ -182,14 +178,9 @@ def get_all_bindings(self) -> list[dict]:
         if bindings is None:
             return []
 
-        return [
-            self._device_element_to_dict(device)
-            for device in bindings.findall("device")
-        ]
+        return [self._device_element_to_dict(device) for device in bindings.findall("device")]
 
-    def is_bound(
-        self, vendor_id: str, product_id: str, serial_number: str = ""
-    ) -> bool:
+    def is_bound(self, vendor_id: str, product_id: str, serial_number: str = "") -> bool:
         """
         Check if a device is bound.
 

libusb_backend.py

@@ -11,10 +11,9 @@
 import sys
 from typing import Any
 
-import usb.backend.libusb1 as libusb1
-
 # Import libusb to ensure it's installed (it's a required dependency)
 import libusb
+import usb.backend.libusb1 as libusb1
 
 
 def _get_bundled_libusb_path() -> str:

pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "usbipd-python"
+dynamic = ["version"]
+description = "A USB/IP server for sharing USB devices over the network"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "GPL-3.0"}
+authors = [
+    {name = "abrinkman", email = "abrinkman@github.com"},
+]
+keywords = ["usb", "usbip", "network", "device-sharing"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: System :: Networking",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+]
+
+dependencies = [
+    "pyusb>=1.2.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/abrinkman/usbipd-python"
+Repository = "https://github.com/abrinkman/usbipd-python.git"
+Issues = "https://github.com/abrinkman/usbipd-python/issues"
+
+[project.scripts]
+usbipd-python = "usbipd:main"
+
+[tool.setuptools]
+py-modules = ["usbipd", "usb_device", "usbip_server", "binding_configuration", "libusb_backend"]
+
+[tool.ruff]
+target-version = "py39"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP"]
+ignore = [
+    "E501",
+    "N806",  # USB spec variable names like bmRequestType, wValue, etc.
+]
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.setuptools_scm]
+# Version is derived from git tags (e.g., v0.1.0 -> 0.1.0)
+# If no tag, generates dev version like 0.1.0.dev1+g1234567

usb_device.py

@@ -9,7 +9,7 @@
 
 import logging
 import re
-from typing import Dict, List, Optional, Tuple
+from typing import Optional
 
 import usb.core
 import usb.util
@@ -78,7 +78,7 @@ def build_bus_id(device: usb.core.Device) -> str:
         return f"{device.bus}-{device.address}"
 
     @staticmethod
-    def parse_bus_id(bus_id: str) -> Tuple[int, Tuple[int, ...]]:
+    def parse_bus_id(bus_id: str) -> tuple[int, tuple[int, ...]]:
         """Parse a bus ID string into bus number and port numbers.
 
         Args:
@@ -113,9 +113,7 @@ def _load_strings(self) -> None:
 
         try:
             if self.device.iManufacturer:
-                raw_manufacturer = usb.util.get_string(
-                    self.device, self.device.iManufacturer
-                )
+                raw_manufacturer = usb.util.get_string(self.device, self.device.iManufacturer)
                 self._manufacturer = self.clean_usb_string(raw_manufacturer)
         except (usb.core.USBError, ValueError) as error:
             logger.debug("Could not read manufacturer string: %s", error)
@@ -137,12 +135,12 @@ def _load_strings(self) -> None:
     @property
     def vendor_id(self) -> int:
         """Get the vendor ID (VID) of the device."""
-        return self.device.idVendor
+        return int(self.device.idVendor)
 
     @property
     def product_id(self) -> int:
         """Get the product ID (PID) of the device."""
-        return self.device.idProduct
+        return int(self.device.idProduct)
 
     @property
     def manufacturer(self) -> Optional[str]:
@@ -170,7 +168,7 @@ def device_id(self) -> str:
             return f"{self.vendor_id:04x}:{self.product_id:04x}:{self._serial_number}"
         return f"{self.vendor_id:04x}:{self.product_id:04x}"
 
-    def to_dict(self) -> Dict[str, Optional[str]]:
+    def to_dict(self) -> dict[str, Optional[str]]:
         """Get basic device information as a dictionary.
 
         Returns:
@@ -259,19 +257,15 @@ def claim(self) -> bool:
                         access_denied = True
                         logger.debug("Access denied for interface %d", interface_number)
                     else:
-                        logger.warning(
-                            "Could not claim interface %d: %s", interface_number, error
-                        )
+                        logger.warning("Could not claim interface %d: %s", interface_number, error)
 
         except usb.core.USBError as error:
             if error.errno == 13:
                 access_denied = True
             logger.warning("Error claiming device: %s", error)
 
         if access_denied:
-            logger.error(
-                "Insufficient permissions to access USB device. Try running with sudo."
-            )
+            logger.error("Insufficient permissions to access USB device. Try running with sudo.")
             return False
 
         return True
@@ -291,9 +285,7 @@ def release(self) -> None:
                     usb.util.release_interface(self.device, interface_number)
                     logger.debug("Released interface %d", interface_number)
                 except usb.core.USBError as error:
-                    logger.debug(
-                        "Could not release interface %d: %s", interface_number, error
-                    )
+                    logger.debug("Could not release interface %d: %s", interface_number, error)
         except usb.core.USBError as error:
             logger.debug("Could not get configuration for release: %s", error)
 
@@ -363,7 +355,7 @@ def __init__(self) -> None:
         """Initialize the USBDeviceManager."""
         self._logger = logging.getLogger(__name__)
 
-    def list_devices(self) -> List[USBDevice]:
+    def list_devices(self) -> list[USBDevice]:
         """List all available USB devices.
 
         Returns:
@@ -443,7 +435,7 @@ def find_by_identity(
 
         return None
 
-    def find_by_binding(self, binding: Dict[str, str]) -> Optional[USBDevice]:
+    def find_by_binding(self, binding: dict[str, str]) -> Optional[USBDevice]:
         """Find a device that matches a binding configuration.
 
         The binding dictionary should contain 'vendor_id', 'product_id',

usbip_server.py

@@ -65,7 +65,7 @@ def __init__(self, host: str = "::", port: int = DEFAULT_PORT) -> None:
         self.port = port
         self._server_socket: Optional[socket.socket] = None
         self._running = False
-        self._exported_devices: dict[str, "USBDevice"] = {}
+        self._exported_devices: dict[str, USBDevice] = {}
         self._active_connections: list[threading.Thread] = []
         self._lock = threading.Lock()
 
@@ -155,9 +155,7 @@ def stop(self) -> None:
             self._server_socket = None
         logger.info("USB/IP server stopped")
 
-    def _handle_client(
-        self, client_socket: socket.socket, client_address: tuple
-    ) -> None:
+    def _handle_client(self, client_socket: socket.socket, client_address: tuple) -> None:
         """
         Handle a client connection.
 
@@ -260,7 +258,7 @@ def _build_device_info(self, bus_id: str, device: usb.core.Device) -> bytes:
             The packed device information bytes.
         """
         # Path (256 bytes, zero-padded)
-        path = f"/sys/devices/usb/{bus_id}".encode("utf-8")
+        path = f"/sys/devices/usb/{bus_id}".encode()
         path = path[:255] + b"\x00" * (256 - len(path))
 
         # Bus ID (32 bytes, zero-padded)
@@ -402,7 +400,7 @@ def _build_import_device_info(self, bus_id: str, device: usb.core.Device) -> byt
             The packed device information bytes.
         """
         # Path (256 bytes, zero-padded)
-        path = f"/sys/devices/usb/{bus_id}".encode("utf-8")
+        path = f"/sys/devices/usb/{bus_id}".encode()
         path = path[:255] + b"\x00" * (256 - len(path))
 
         # Bus ID (32 bytes, zero-padded)
@@ -462,9 +460,7 @@ def _handle_urb_traffic(self, client_socket: socket.socket, bus_id: str) -> None
 
         # Claim the device for exclusive access
         if not usb_device.claim():
-            logger.error(
-                f"Cannot handle URB traffic for {bus_id} - device claim failed"
-            )
+            logger.error(f"Cannot handle URB traffic for {bus_id} - device claim failed")
             return
 
         logger.info(f"Starting URB traffic handling for {bus_id}")
@@ -548,9 +544,7 @@ def _handle_urb_submit(
                 is_device_to_host = (bmRequestType & 0x80) != 0
                 if not is_device_to_host:
                     # Host to Device (OUT) - read the data
-                    recv_result = self._recv_exact(
-                        client_socket, transfer_buffer_length
-                    )
+                    recv_result = self._recv_exact(client_socket, transfer_buffer_length)
                     if recv_result is None:
                         return
                     transfer_buffer = recv_result
@@ -642,9 +636,7 @@ def _do_control_transfer(
         Returns:
             A tuple of (response_data, actual_length).
         """
-        bmRequestType, bRequest, wValue, wIndex, wLength = struct.unpack(
-            "<BBHHH", setup
-        )
+        bmRequestType, bRequest, wValue, wIndex, wLength = struct.unpack("<BBHHH", setup)
 
         # Direction is encoded in bmRequestType bit 7:
         # 0 = Host to Device (OUT), 1 = Device to Host (IN)
@@ -727,9 +719,7 @@ def _do_bulk_interrupt_transfer(
             result = device.write(endpoint_addr, data, timeout=5000)
             return b"", result
 
-    def _handle_urb_unlink(
-        self, client_socket: socket.socket, header: bytes, seqnum: int
-    ) -> None:
+    def _handle_urb_unlink(self, client_socket: socket.socket, header: bytes, seqnum: int) -> None:
         """
         Handle USBIP_CMD_UNLINK command.