Merge pull request #446 from JnyJny/uv

The Great UV / GitHub Action Disruption

Author: JnyJny

.github/workflows/pytest-linux.yaml

@@ -0,0 +1,72 @@
+name: Test and Publish Release
+
+on:
+  push:
+    branches:
+      - testing
+    tags:
+      - 'v*-test'
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  test:
+    name: Test on Linux/MacOS/Window
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set Python version.
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.7.5"
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install libusb on Linux.
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libusb-1.0-0-dev libudev-dev
+
+      - name: Run tests - ${{ matrix.python-version }} - ${{ matrix.os }}
+        run: |
+          uv run --all-extras pytest
+
+  publish:
+    name: Build & Publish
+    needs: test
+    if: |
+      github.ref_type == 'tag' &&
+      startsWith(github.ref, 'refs/tags/v') &&
+      !endsWith(github.ref, '-test') &&
+      success()
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/busylight-for-humans
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set Python version.
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.7.5"
+          python-version: 3.9
+
+      - name: Build package.
+        run: |
+          uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/pytest-macos.yaml

@@ -12,5 +12,6 @@ tst.py
 htmlcov
 *token
 .python-version
-
+.direnv/
 .vscode/
+.envrc

.github/workflows/pytest-windows.yaml

@@ -86,25 +86,33 @@ $ python3 -m pip install busylight-for-humans[webapi]
 
 ## Development Install
 
-I use the tool [poetry][poetry-docs] to manage various aspects of this project, including:
-- dependencies
+I am in the process of switching from [poetry][poetry-docs] to the new hotness [uv][uv-docs].
+
+Like `poetry`, I use `uv` for:
+- dependency management
 - pytest configuration
 - versioning
 - optional dependencies
 - virtual environment creation
 - building packages
 - publishing packages to PyPi
 
+
 ```console
-$ python3 -m pip install poetry 
+$ python3 -m pip install uv
 $ cd path/to/busylight
-$ poetry shell
-<venv> $ poetry install -E webapi
+$ uv venv .venv
+$ source .venv/bin/activate
+<venv> $ uv sync --all-extras
 <venv> $ which busylight
 <venv> $ which busyserve
+<venv> $ pytest
 ```
 
-After installing into the virtual environment, the project is now available in editable mode.  Changes made in the source will be reflected in the runtime behavior when running in the poetry initiated shell.
+After installing into the virtual environment, the project is now
+available in editable mode.  Changes made in the source will be
+reflected in the runtime behavior when running in the poetry initiated
+shell.
 
 ## Linux Post-Install Activities
 
@@ -271,7 +279,6 @@ manager.off()
 
 [0]: https://github.com/JnyJny/busylight
 
-
 <!-- doc links -->
 [2]: https://github.com/JnyJny/busylight/blob/master/docs/devices/agile_innovative.md
 [3]: https://github.com/JnyJny/busylight/blob/master/docs/devices/embrava.md
@@ -287,12 +294,15 @@ manager.off()
 [HELP]: https://github.com/JnyJny/busylight/blob/master/docs/busylight.1.md
 [WEBAPI]: https://github.com/JnyJny/busylight/blob/master/docs/busylight_api.pdf
 
+
 <!-- [DEMO]: demo/demo-updated.gif -->
 [DEMO]: https://github.com/JnyJny/busylight/blob/master/docs/assets/HerdOfLights.png
 
+<!-- Miscellaneous -->
 [BASICAUTH]: https://en.wikipedia.org/wiki/Basic_access_authentication
 [UDEV]: https://en.wikipedia.org/wiki/Udev
-
+[poetry-docs]: https://python-poetry.org/docs/
+[uv-docs]: https://docs.astral.sh/uv/
 [todbot]: https://github.com/todbot
 [thingm]: https://thingm.com
 
@@ -304,5 +314,4 @@ manager.off()
 [license]: https://img.shields.io/pypi/l/busylight-for-humans
 [dependencies]: https://img.shields.io/librariesio/github/JnyJny/busylight
 [monthly-downloads]: https://img.shields.io/pypi/dm/busylight-for-humans
-[poetry-docs]: https://python-poetry.org/docs/
 [visits]: https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJnyJny%2Fbusylight&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Visits&edge_flat=false

.github/workflows/release.yaml

@@ -1,6 +1,4 @@
-"""Busylight command-line interface
-
-"""
+"""Busylight command-line interface"""
 
 from dataclasses import dataclass, field
 from os import environ
@@ -65,7 +63,6 @@ def precommand_callback(
         False,
         "--debug",
         "-D",
-        is_flag=True,
         help="Enable debugging output.",
     ),
     targets: str = typer.Option(
@@ -98,7 +95,6 @@ def precommand_callback(
     version: bool = typer.Option(
         False,
         "--version",
-        is_flag=True,
         is_eager=True,
         callback=report_version,
     ),
@@ -208,7 +204,9 @@ def rainbow_lights(
 ) -> None:
     """Display rainbow colors on specified lights."""
     logger.info("applying rainbow effect")
-    rainbow = Effects.for_name("spectrum")(speed.duty_cycle / 4, scale=ctx.obj.dim, count=count)
+    rainbow = Effects.for_name("spectrum")(
+        speed.duty_cycle / 4, scale=ctx.obj.dim, count=count
+    )
 
     try:
         manager.apply_effect(rainbow, ctx.obj.lights, timeout=ctx.obj.timeout)
@@ -296,7 +294,6 @@ def list_available_lights(
         False,
         "--verbose",
         "-v",
-        is_flag=True,
         help="Shows additional information about each light.",
     ),
 ) -> None:
@@ -333,7 +330,6 @@ def list_supported_lights(
         False,
         "--verbose",
         "-v",
-        is_flag=True,
         help="Print vendor and product identifiers.",
     ),
 ) -> None:
@@ -394,7 +390,7 @@ def generate_udev_rules(
 
 @webcli.command()
 def serve_http_api(
-    debug: bool = typer.Option(False, "--debug", "-D", is_flag=True),
+    debug: bool = typer.Option(False, "--debug", "-D"),
     host: str = typer.Option(
         "0.0.0.0",
         "--host",

.gitignore

@@ -1,11 +1,9 @@
-"""
-"""
+""" """
 
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 import hid
 
-
 # Why This File Exists.
 #
 # The 'apmorton/pyhidapi' package and 'trezor/cython-hidapi' packages both
@@ -45,7 +43,7 @@ def open(
         self,
         vendor_id: int,
         product_id: int,
-        serial_number: str = None,
+        serial_number: Optional[str] = None,
     ) -> None:
         """Open the first device matching vendor_id and product_id or serial number."""
         if self._handle:
@@ -69,7 +67,7 @@ def close(self) -> None:
         except AttributeError:
             raise IOError("device not open") from None
 
-    def read(self, nbytes: int, timeout_ms: int = None) -> List[int]:
+    def read(self, nbytes: int, timeout_ms: Optional[int] = None) -> List[int]:
         """Read nbytes from the device, returns a list of ints."""
         try:
             return self._handle.read(nbytes, timeout_ms)