circfirm 3.0.0__tar.gz → 4.0.0__tar.gz

{circfirm-3.0.0 → circfirm-4.0.0}/.github/workflows/push.yml

@@ -14,20 +14,37 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
-      max-parallel: 3
       matrix:
         py-version: [
-          "3.8",
           "3.9",
           "3.10",
           "3.11",
           "3.12",
+          "3.13",
         ]
         os: [
-          ubuntu-latest,
-          windows-latest,
-          macos-latest
+          "ubuntu-latest",
+          "windows-latest",
+          "macos-latest",
         ]
+        exclude:
+          - os: windows-latest
+            py-version: "3.10"
+          - os: windows-latest
+            py-version: "3.11"
+          - os: windows-latest
+            py-version: "3.12"
+          - os: windows-latest
+            py-version: "3.13"
+          - os: macos-latest
+            py-version: "3.10"
+          - os: macos-latest
+            py-version: "3.11"
+          - os: macos-latest
+            py-version: "3.12"
+          - os: macos-latest
+            py-version: "3.13"
+
     steps:
       - name: Setup Python 3.x
         uses: actions/setup-python@v5

{circfirm-3.0.0 → circfirm-4.0.0}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: reuse
         name: Check REUSE compatibility
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
         name: Check YAML
@@ -31,8 +31,8 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.2.2
     hooks:
+      - id: ruff-format
+        name: Format via ruff
       - id: ruff
         name: Lint via ruff
         args: [--fix]
-      - id: ruff-format
-        name: Format via ruff

{circfirm-3.0.0 → circfirm-4.0.0}/Makefile

@@ -59,8 +59,8 @@ test-run:
 test-clean:
 ifeq "$(OS)" "Windows_NT"
 	-@subst T: /d
-	-@python scripts/rmdir.py testmount
-	-@python scripts/rmdir.py tests/sandbox/circuitpython
+	-@python scripts\rmdir.py testmount
+	-@python scripts\rmdir.py tests\sandbox\circuitpython
 else ifeq "$(shell uname -s)" "Linux"
 	-@sudo umount testmount
 	-@sudo rm -rf testmount

circfirm-4.0.0/NOTICE

@@ -0,0 +1,64 @@
+Required Dependencies
+^^^^^^^^^^^^^^^^^^^^^
+
+This software interacts with the CircuitPython AWS S3 bucket using boto3 by
+Amazon.com Inc or its affiliates (https://github.com/boto/boto3) [Apache-2.0 license].
+
+This software uses type annotations for boto3 provided by boto3-stubs by Vlad
+Emelinaov and maintained by youtype (https://github.com/youtype/mypy_boto3_builder)
+[MIT license].
+
+This software creates its command line interface using click by the pallets
+project (https://palletsprojects.com/p/click/) [BSD-3-Clause license].
+
+This software uses a CLI spinner add-on click-spinner to clink to display loading
+animation created by Yoav Ram (https://github.com/click-contrib/click-spinner)
+[MIT license].
+
+This software compares and orders CircuitPython versions according to PEP 440
+using the packaging library by Donald Stufft and maintained by the Python Packaging
+Authority (https://packaging.pypa.io/en/stable/) [Apache-2.0 or BSD-2-Clause
+licenses].
+
+This software discovers connected CircuitPython boards using the system utilization
+features of psutil, created by Jay Loden, Dave Daeschler, and Giampaolo Rodola
+(https://github.com/giampaolo/psutil) [BSD-3-Clause license].
+
+This software reads and modifies the YAML configuration settings using PyYAML,
+created by Kirill Simonov and Ingy dot Net, and maintained by the YAML community
+(https://pyyaml.org/) [MIT license].
+
+requests~=2.31
+This software makes HTTP requests, such as communicating with the CircuitPython
+GitHub repository and downloading CircuitPython firmware files, using requests,
+created by Kenneth Reitz and maintained by the Python Software Foundation
+(https://requests.readthedocs.io/en/latest/) [Apache-2.0 license].
+
+
+Development Dependencies
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This software uses the build package for its build frontend, created by Filipe Lains
+and maintained by the Python Packaging Authority (https://build.pypa.io/en/stable/)
+[MIT license].
+
+This software measures code coverage metrics using Coverage.py, authored by and
+copyright Ned Batchelder (https://github.com/nedbat/coveragepy) [Apache-2.0 license].
+
+This software manages code checks such as linting and formatting using pre-commit,
+copyright Anythony Sottile and Ken Struys and (https://github.com/pre-commit/pre-commit)
+[MIT license].
+
+This software performs software tests using pytest, copyright Holger Krekel and others
+(https://docs.pytest.org/en/latest/) [MIT license].
+
+Ths software creates its documentation using Sphinx, copyright the Sphinx team
+(https://www.sphinx-doc.org/en/master/) [BSD license].
+
+This software uses tabs within its documentation provided by sphinx-tabs, copyright
+djungelorm (https://github.com/executablebooks/sphinx-tabs) [MIT license].
+
+sphinx-rtd-theme~=1.0
+This software displays its documentation using the ReadTheDocs Sphinx theme, copyright Dave
+Snider, Read the Docs, Inc. & contributors (https://sphinx-rtd-theme.readthedocs.io/en/stable/)
+[MIT license].

circfirm-4.0.0/NOTICE.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2024 Alec Delaney, for Adafruit Industries
+SPDX-License-Identifier: MIT

{circfirm-3.0.0 → circfirm-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: circfirm
-Version: 3.0.0
+Version: 4.0.0
 Summary: CLI tool for install firmware for CircuitPython boards
 Author-email: Alec Delaney <tekktrik@gmail.com>
 License: MIT
@@ -15,35 +15,37 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: Unix
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
 Classifier: Typing :: Typed
-Requires-Python: >=3.8.0
+Requires-Python: >=3.9.0
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: boto3~=1.34
-Requires-Dist: click~=8.0
+License-File: NOTICE
+License-File: NOTICE.license
+Requires-Dist: boto3~=1.35
+Requires-Dist: click~=8.1
 Requires-Dist: click-spinner~=0.1
-Requires-Dist: packaging~=23.2
-Requires-Dist: psutil~=5.9
+Requires-Dist: packaging~=24.2
+Requires-Dist: psutil~=6.1
 Requires-Dist: pyyaml~=6.0
-Requires-Dist: requests~=2.31
-Requires-Dist: boto3-stubs[essential]~=1.34
+Requires-Dist: requests~=2.32
+Requires-Dist: boto3-stubs[essential]~=1.35
 Provides-Extra: dev
-Requires-Dist: build~=1.0; extra == "dev"
-Requires-Dist: coverage~=7.4; extra == "dev"
-Requires-Dist: pre-commit~=2.20; extra == "dev"
-Requires-Dist: pytest~=8.0; extra == "dev"
-Requires-Dist: sphinx~=5.1; extra == "dev"
+Requires-Dist: build~=1.2; extra == "dev"
+Requires-Dist: coverage~=7.6; extra == "dev"
+Requires-Dist: pre-commit~=4.0; extra == "dev"
+Requires-Dist: pytest~=8.3; extra == "dev"
+Requires-Dist: sphinx~=7.4; extra == "dev"
 Requires-Dist: sphinx-tabs~=3.4; extra == "dev"
-Requires-Dist: sphinx-rtd-theme~=1.0; extra == "dev"
+Requires-Dist: sphinx-rtd-theme~=3.0; extra == "dev"
 
 ..
    SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries

circfirm-4.0.0/VERSION

@@ -0,0 +1 @@
+4.0.0

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/backend/__init__.py

@@ -8,6 +8,7 @@ Author(s): Alec Delaney
 """
 
 import enum
+import re
 
 
 class Language(enum.Enum):
@@ -51,3 +52,20 @@ FIRMWARE_REGEX = (
     .replace(r"[language]", f"({_ALL_LANGUAGES_REGEX})")
     .replace(r"[version]", _VALID_VERSIONS_CAPTURE)
 )
+
+
+def get_uf2_filename(board_id: str, version: str, language: str = "en_US") -> str:
+    """Get the structured name for a specific board/version CircuitPython."""
+    return f"adafruit-circuitpython-{board_id}-{language}-{version}.uf2"
+
+
+def parse_firmware_info(uf2_filename: str) -> tuple[str, str]:
+    """Get firmware info."""
+    regex_match = re.match(FIRMWARE_REGEX, uf2_filename)
+    if regex_match is None:
+        raise ValueError(
+            "Firmware information could not be determined from the filename"
+        )
+    version = regex_match[3]
+    language = regex_match[2]
+    return version, language

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/backend/cache.py

@@ -9,8 +9,7 @@ Author(s): Alec Delaney
 
 import os
 import pathlib
-import re
-from typing import Dict, List, Optional, Set, Tuple
+from typing import Optional
 
 import packaging.version
 import requests
@@ -19,16 +18,11 @@ import circfirm.backend
 import circfirm.startup
 
 
-def get_uf2_filename(board_id: str, version: str, language: str = "en_US") -> str:
-    """Get the structured name for a specific board/version CircuitPython."""
-    return f"adafruit-circuitpython-{board_id}-{language}-{version}.uf2"
-
-
 def get_uf2_filepath(
     board_id: str, version: str, language: str = "en_US"
 ) -> pathlib.Path:
     """Get the path to a downloaded UF2 file."""
-    file = get_uf2_filename(board_id, version, language)
+    file = circfirm.backend.get_uf2_filename(board_id, version, language)
     uf2_folder = get_board_folder(board_id)
     return uf2_folder / file
 
@@ -46,31 +40,33 @@ def is_downloaded(board_id: str, version: str, language: str = "en_US") -> bool:
 
 def download_uf2(board_id: str, version: str, language: str = "en_US") -> None:
     """Download a version of CircuitPython for a specific board."""
-    file = get_uf2_filename(board_id, version, language=language)
+    file = circfirm.backend.get_uf2_filename(board_id, version, language=language)
     uf2_file = get_uf2_filepath(board_id, version, language=language)
     url = f"https://downloads.circuitpython.org/bin/{board_id}/{language}/{file}"
     response = requests.get(url)
 
     SUCCESS = 200
     if response.status_code != SUCCESS:
-        raise ConnectionError(f"Could not download the specified UF2 file:\n{url}")
+        raise ConnectionError(
+            f"Could not download the specified UF2 file:\n{url}\nAre the board ID, version, and language correct?"
+        )
 
     uf2_file.parent.mkdir(parents=True, exist_ok=True)
     with open(uf2_file, mode="wb") as uf2file:
         uf2file.write(response.content)
 
 
-def get_sorted_boards(board_id: Optional[str]) -> Dict[str, Dict[str, Set[str]]]:
+def get_sorted_boards(board_id: Optional[str]) -> dict[str, dict[str, set[str]]]:
     """Get a sorted collection of boards, versions, and languages."""
-    boards: Dict[str, Dict[str, Set[str]]] = {}
+    boards: dict[str, dict[str, set[str]]] = {}
     for board_folder in sorted(os.listdir(circfirm.UF2_ARCHIVE)):
-        versions: Dict[str, List[str]] = {}
-        sorted_versions: Dict[str, Set[str]] = {}
+        versions: dict[str, list[str]] = {}
+        sorted_versions: dict[str, set[str]] = {}
         if board_id is not None and board_id != board_folder:
             continue
         board_folder_full = get_board_folder(board_folder)
         for item in os.listdir(board_folder_full):
-            version, language = parse_firmware_info(item)
+            version, language = circfirm.backend.parse_firmware_info(item)
             try:
                 version_set = set(versions[version])
                 version_set.add(language)
@@ -83,15 +79,3 @@ def get_sorted_boards(board_id: Optional[str]) -> Dict[str, Dict[str, Set[str]]]
             sorted_versions[sorted_version] = versions[sorted_version]
         boards[board_folder] = sorted_versions
     return boards
-
-
-def parse_firmware_info(uf2_filename: str) -> Tuple[str, str]:
-    """Get firmware info."""
-    regex_match = re.match(circfirm.backend.FIRMWARE_REGEX, uf2_filename)
-    if regex_match is None:
-        raise ValueError(
-            "Firmware information could not be determined from the filename"
-        )
-    version = regex_match[3]
-    language = regex_match[2]
-    return version, language

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/backend/device.py

@@ -9,7 +9,7 @@ Author(s): Alec Delaney
 
 import pathlib
 import re
-from typing import Optional, Tuple
+from typing import Optional
 
 import psutil
 
@@ -21,7 +21,7 @@ BOARD_VER_REGEX = (
 )
 
 
-def get_board_info(device_path: str) -> Tuple[str, str]:
+def get_board_info(device_path: str) -> tuple[str, str]:
     """Get the attached CircuitPytho board's name and version."""
     bootout_file = pathlib.Path(device_path) / circfirm.BOOTOUT_FILE
     with open(bootout_file, encoding="utf-8") as infofile:

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/backend/github.py

@@ -9,7 +9,7 @@ Author(s): Alec Delaney
 
 import datetime
 import re
-from typing import List, Tuple, TypedDict
+from typing import TypedDict
 
 import requests
 
@@ -42,7 +42,7 @@ class GitTreeItem(TypedDict):
     url: str
 
 
-def get_rate_limit() -> Tuple[int, int, datetime.datetime]:
+def get_rate_limit() -> tuple[int, int, datetime.datetime]:
     """Get the rate limit for the GitHub REST endpoint."""
     response = requests.get(
         url="https://api.github.com/rate_limit",
@@ -55,7 +55,7 @@ def get_rate_limit() -> Tuple[int, int, datetime.datetime]:
     return available, total, reset_time
 
 
-def get_board_id_list(token: str) -> List[str]:
+def get_board_id_list(token: str) -> list[str]:
     """Get a list of CircuitPython boards."""
     boards = set()
     headers = BASE_REQUESTS_HEADERS.copy()
@@ -69,7 +69,7 @@ def get_board_id_list(token: str) -> List[str]:
         headers=headers,
     )
     try:
-        tree_items: List[GitTreeItem] = response.json()["tree"]
+        tree_items: list[GitTreeItem] = response.json()["tree"]
     except KeyError as err:
         raise ValueError("Could not parse JSON response, check token") from err
     for tree_item in tree_items:

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/backend/s3.py

@@ -8,7 +8,7 @@ Author(s): Alec Delaney
 """
 
 import re
-from typing import List, Optional
+from typing import Optional
 
 import boto3
 import botocore
@@ -17,6 +17,7 @@ import packaging.version
 from mypy_boto3_s3 import S3ServiceResource
 
 import circfirm.backend
+import circfirm.backend.cache
 
 S3_CONFIG = botocore.client.Config(signature_version=botocore.UNSIGNED)
 S3_RESOURCE: S3ServiceResource = boto3.resource("s3", config=S3_CONFIG)
@@ -26,24 +27,25 @@ BUCKET = S3_RESOURCE.Bucket(BUCKET_NAME)
 
 def get_board_versions(
     board_id: str, language: str = "en_US", *, regex: Optional[str] = None
-) -> List[str]:
+) -> list[str]:
     """Get a list of CircuitPython versions for a given board."""
     prefix = f"bin/{board_id}/{language}"
     firmware_regex = circfirm.backend.FIRMWARE_REGEX_PATTERN.replace(
         r"[board]", board_id
     ).replace(r"[language]", language)
-    version_regex = f"({regex})" if regex else circfirm.backend._VALID_VERSIONS_CAPTURE
+    version_regex = circfirm.backend._VALID_VERSIONS_CAPTURE
     firmware_regex = firmware_regex.replace(r"[version]", version_regex)
     s3_objects = BUCKET.objects.filter(Prefix=prefix)
     versions = set()
     for s3_object in s3_objects:
         result = re.match(f"{prefix}/{firmware_regex}", s3_object.key)
         if result:
-            try:
-                _ = packaging.version.Version(result[1])
-                versions.add(result[1])
-            except packaging.version.InvalidVersion:
-                pass
+            if regex:
+                firmware_filename = s3_object.key.split("/")[-1]
+                version, _ = circfirm.backend.parse_firmware_info(firmware_filename)
+                if not re.match(regex, version):
+                    continue
+            versions.add(result[1])
     return sorted(versions, key=packaging.version.Version, reverse=True)
 
 

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/cli/__init__.py

@@ -13,7 +13,8 @@ import pkgutil
 import shutil
 import sys
 import time
-from typing import Any, Callable, Dict, Iterable, Optional, Tuple, TypeVar
+from collections.abc import Iterable
+from typing import Any, Callable, Optional, TypeVar
 
 import click
 import click_spinner
@@ -43,8 +44,11 @@ def maybe_support(msg: str) -> None:
 
 
 def get_board_id(
-    circuitpy: Optional[str], bootloader: Optional[str], board: Optional[str]
-) -> Tuple[str, str]:
+    circuitpy: Optional[str],
+    bootloader: Optional[str],
+    board: Optional[str],
+    timeout: int = -1,
+) -> tuple[str, str]:
     """Get the board ID of a device via CLI."""
     if not board:
         if not circuitpy and bootloader:
@@ -56,12 +60,22 @@ def get_board_id(
         board = circfirm.backend.device.get_board_info(circuitpy)[0]
 
         click.echo("Board ID detected, please switch the device to bootloader mode.")
+        if timeout == -1:
+            skip_timeout = True
+        else:
+            skip_timeout = False
+            start_time = time.time()
+
         while not (bootloader := circfirm.backend.device.find_bootloader()):
-            time.sleep(1)
+            if not skip_timeout and time.time() >= start_time + timeout:
+                raise OSError(
+                    "Bootloader mode device not found within the timeout period"
+                )
+            time.sleep(0.05)
     return bootloader, board
 
 
-def get_connection_status() -> Tuple[Optional[str], Optional[str]]:
+def get_connection_status() -> tuple[Optional[str], Optional[str]]:
     """Get the status of a connectted CircuitPython device as a CIRCUITPY and bootloader location."""
     circuitpy = circfirm.backend.device.find_circuitpy()
     bootloader = circfirm.backend.device.find_bootloader()
@@ -108,14 +122,15 @@ def copy_cache_firmware(
     announce_and_await(
         f"Copying UF2 to {board}", shutil.copyfile, args=(uf2file, uf2_path)
     )
-    click.echo("Device should reboot momentarily.")
+    click.echo(f"CircuitPython version now upgraded to {version}")
+    click.echo("Device should reboot momentarily")
 
 
 def announce_and_await(
     msg: str,
     func: Callable[..., _T],
     args: Iterable = (),
-    kwargs: Optional[Dict[str, Any]] = None,
+    kwargs: Optional[dict[str, Any]] = None,
     *,
     use_spinner: bool = True,
 ) -> _T:
@@ -140,7 +155,7 @@ def announce_and_await(
         raise err
 
 
-def get_settings() -> Dict[str, Any]:
+def get_settings() -> dict[str, Any]:
     """Get the contents of the settings file."""
     with open(circfirm.SETTINGS_FILE, encoding="utf-8") as yamlfile:
         return yaml.safe_load(yamlfile)

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/cli/cache.py

@@ -9,14 +9,15 @@ Author(s): Alec Delaney
 
 import os
 import pathlib
+import re
 import shutil
-import sys
 from typing import Optional
 
 import click
 
 import circfirm
 import circfirm.backend.cache
+import circfirm.backend.s3
 import circfirm.cli
 import circfirm.startup
 
@@ -30,8 +31,18 @@ def cli():
 @click.option("-b", "--board-id", default=None, help="CircuitPython board ID")
 @click.option("-v", "--version", default=None, help="CircuitPython version")
 @click.option("-l", "--language", default=None, help="CircuitPython language/locale")
-def clear(
-    board_id: Optional[str], version: Optional[str], language: Optional[str]
+@click.option(
+    "-r",
+    "--regex",
+    is_flag=True,
+    default=False,
+    help="The board ID, version, and language options represent regex patterns",
+)
+def clear(  # noqa: PLR0913
+    board_id: Optional[str],
+    version: Optional[str],
+    language: Optional[str],
+    regex: bool,
 ) -> None:
     """Clear the cache, either entirely or for a specific board/version."""
     if board_id is None and version is None and language is None:
@@ -40,13 +51,33 @@ def clear(
         click.echo("Cache cleared!")
         return
 
-    glob_pattern = "*-*" if board_id is None else f"*-{board_id}"
-    language_pattern = "-*" if language is None else f"-{language}"
-    glob_pattern += language_pattern
-    version_pattern = "-*" if version is None else f"-{version}.uf2"
-    glob_pattern += version_pattern
+    if regex:
+        glob_pattern = "*-*-*-*"
+    else:
+        glob_pattern = "*-*" if board_id is None else f"*-{board_id}"
+        language_pattern = "-*" if language is None else f"-{language}"
+        glob_pattern += language_pattern
+        version_pattern = "-*" if version is None else f"-{version}.uf2"
+        glob_pattern += version_pattern
+
     matching_files = pathlib.Path(circfirm.UF2_ARCHIVE).rglob(glob_pattern)
+
     for matching_file in matching_files:
+        if regex:
+            board_id = ".*" if board_id is None else board_id
+            version = ".*" if version is None else version
+            language = ".*" if language is None else language
+
+            current_board_id = matching_file.parent.name
+            current_version, current_language = circfirm.backend.parse_firmware_info(
+                matching_file.name
+            )
+
+            board_id_matches = re.search(board_id, current_board_id)
+            version_matches = re.match(version, current_version)
+            language_matches = re.match(language, current_language)
+            if not all([board_id_matches, version_matches, language_matches]):
+                continue
         matching_file.unlink()
 
     # Delete board folder if empty
@@ -88,7 +119,7 @@ def cache_list(board_id: Optional[str]) -> None:
 @click.argument("version")
 @click.option("-l", "--language", default="en_US", help="CircuitPython language/locale")
 def cache_save(board_id: str, version: str, language: str) -> None:
-    """Install a version of CircuitPython to cache."""
+    """Download a version of CircuitPython to the cache."""
     try:
         circfirm.cli.announce_and_await(
             f"Caching firmware version {version} for {board_id}",
@@ -97,3 +128,28 @@ def cache_save(board_id: str, version: str, language: str) -> None:
         )
     except ConnectionError as err:
         raise click.exceptions.ClickException(err.args[0])
+
+
+@cli.command(name="latest")
+@click.argument("board-id")
+@click.option("-l", "--language", default="en_US", help="CircuitPython language/locale")
+@click.option(
+    "-p",
+    "--pre-release",
+    is_flag=True,
+    default=False,
+    help="Whether pre-release versions should be considered",
+)
+def cache_latest(board_id: str, language: str, pre_release: bool) -> None:
+    """Download the latest version of CircuitPython to the cache."""
+    try:
+        version = circfirm.backend.s3.get_latest_board_version(
+            board_id, language, pre_release
+        )
+        circfirm.cli.announce_and_await(
+            f"Caching firmware version {version} for {board_id}",
+            circfirm.backend.cache.download_uf2,
+            args=(board_id, version, language),
+        )
+    except ConnectionError as err:
+        raise click.exceptions.ClickException(err.args[0])

{circfirm-3.0.0 → circfirm-4.0.0}/circfirm/cli/current.py

@@ -7,15 +7,13 @@
 Author(s): Alec Delaney
 """
 
-from typing import Tuple
-
 import click
 
 import circfirm.backend.device
 import circfirm.cli
 
 
-def get_board_info() -> Tuple[str, str]:
+def get_board_info() -> tuple[str, str]:
     """Get board info via the CLI."""
     circuitpy, _ = circfirm.cli.get_connection_status()
     if not circuitpy:

circfirm-4.0.0/circfirm/cli/detect.py

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2024 Alec Delaney, for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""CLI functionality for the detect subcommand.
+
+Author(s): Alec Delaney
+"""
+
+
+import click
+
+import circfirm.backend.device
+
+
+@click.group()
+def cli() -> None:
+    """Detect connected CircuitPython boards."""
+
+
+@cli.command(name="circuitpy")
+def detect_circuitpy() -> None:
+    """Detect a connected board in CIRCUITPY or equivalent mode."""
+    circuitpy = circfirm.backend.device.find_circuitpy()
+    if not circuitpy:
+        click.echo("No board connected in CIRCUITPY or equivalent mode")
+        return
+    click.echo(circuitpy)
+
+
+@cli.command(name="bootloader")
+def detect_bootloader() -> None:
+    """Detect a connected board in bootloader mode."""
+    bootloader = circfirm.backend.device.find_bootloader()
+    if not bootloader:
+        click.echo("No board connected in bootloader mode")
+        return
+    click.echo(bootloader)