Merge pull request #26 from bp100a/first-release

cleanup for 1.0 release

Author: bp100a

CHANGES

@@ -0,0 +1,6 @@
+# CHANGES
+
+## [0.1.7] - 2024-09-03
+### Added
+- updated SOUP to include typing-extensions
+- typos fixed in comments

README.md

@@ -57,10 +57,11 @@ response: bytes = connections[0].response_data(size=0)  # reads until delimiter
 SOUP
 --------------------------------------------------------------------------
 ___
-| Module          | Version    | comments                                    |
-|-----------------|------------|---------------------------------------------|
-| Python          | 3.11, 3.12 | Python interpreter                          |
-| py-datastruct   | 1.0.0      | Serialization of binary to/from dataclasses |
+| Module          | Version    | comments                                     |
+|-----------------|------------|----------------------------------------------|
+| Python          | 3.11, 3.12 | Python interpreter                           |
+| py-datastruct   | 1.0.0      | Serialization of binary to/from dataclasses  |
+| type-extensions | 4.12.2     | extensions for typing (SocketWrapper typing) |
 
 
 Useful Resources

pyproject.toml

@@ -11,6 +11,7 @@ readme = "README.md"
 license = {text = "BSD License"}
 dependencies = [
   "py-datastruct>=1.0.0",
+  "typing-extensions>=4.12",
 ]
 requires-python = ">= 3.11"
 keywords = ["usb", "usbipd", "serial"]
@@ -21,7 +22,7 @@ classifiers = [
      #   3 - Alpha
      #   4 - Beta
      #   5 - Production/Stable
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     # Indicate who your project is intended for
     "Intended Audience :: Developers",
     "Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Communications Device Class (CDC)",
@@ -34,7 +35,6 @@ classifiers = [
 
     # Specify the Python versions you support here.
     "Programming Language :: Python :: Implementation :: CPython",
-    "Programming Language :: Python :: Implementation :: PyPy",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -48,7 +48,7 @@ Repository = "https://github.com/bp100a/serial-usbipclient"
 name = "serial-usbipclient"
 authors = ["Harry J. Collins <bp100a@gmail.com>"]
 maintainers = ["Harry J. Collins <bp100a@gmail.com>"]
-version = "0.1.6"
+version = "1.0.0"
 description = "Simple serial connectivity to CDC (serial) USB devices exposed by a USBIPD service."
 readme = "README.md"
 package-mode = true

serial_usbipclient/socket_wrapper.py

@@ -15,7 +15,7 @@ def __init__(self, family: AddressFamily, kind: SocketKind):
         self._address: tuple[str, int] = ('', 0)
 
     def raw_socket(self) -> socket:
-        """return the underly, raw socket"""
+        """return the underlying, raw socket"""
         return self._socket
 
     def settimeout(self, timeout: float | None) -> None:

serial_usbipclient/tests/mock_usbip.py

@@ -660,7 +660,7 @@ def wait_for_message(self, conn: Optional[USBIPClient] = None) -> tuple[USBIPCli
         """wait for a response (or a shutdown)"""
         self.logger.info(f"wait_for_message({conn=}), {self._clients=}")
         if self._wakeup is None or self.server_socket is None:
-            raise ValueError("neither the wakeup or server socket can be emptyed!")
+            raise ValueError("neither the wakeup or server socket can be emptied!")
 
         rlist: list[socket.socket | USBIPClient] = [self._wakeup.listener, self.server_socket]
         if conn: