circfirm 3.1.0__py3-none-any.whl → 4.0.0__py3-none-any.whl

circfirm/backend/__init__.py

@@ -9,7 +9,6 @@ Author(s): Alec Delaney
 
 import enum
 import re
-from typing import Tuple
 
 
 class Language(enum.Enum):
@@ -60,7 +59,7 @@ def get_uf2_filename(board_id: str, version: str, language: str = "en_US") -> st
     return f"adafruit-circuitpython-{board_id}-{language}-{version}.uf2"
 
 
-def parse_firmware_info(uf2_filename: str) -> Tuple[str, str]:
+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:

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
@@ -48,19 +47,21 @@ def download_uf2(board_id: str, version: str, language: str = "en_US") -> None:
 
     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)

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/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/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
@@ -27,7 +27,7 @@ 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(

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()
@@ -116,7 +130,7 @@ 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:
@@ -141,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/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/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)

circfirm/cli/install.py

@@ -23,10 +23,21 @@ import circfirm.cli
     default=None,
     help="Assume the given board ID (and connect in bootloader mode)",
 )
-def cli(version: str, language: str, board_id: Optional[str]) -> None:
+@click.option(
+    "-t",
+    "--timeout",
+    default=-1,
+    help="Set a timeout in seconds for the switch to bootloader mode",
+)
+def cli(version: str, language: str, board_id: Optional[str], timeout: int) -> None:
     """Install the specified version of CircuitPython."""
     circuitpy, bootloader = circfirm.cli.get_connection_status()
-    bootloader, board_id = circfirm.cli.get_board_id(circuitpy, bootloader, board_id)
+    try:
+        bootloader, board_id = circfirm.cli.get_board_id(
+            circuitpy, bootloader, board_id, timeout
+        )
+    except OSError as err:
+        raise click.ClickException(err.args[0])
     circfirm.cli.ensure_bootloader_mode(bootloader)
     circfirm.cli.download_if_needed(board_id, version, language)
     circfirm.cli.copy_cache_firmware(board_id, version, language, bootloader)

circfirm/cli/update.py

@@ -25,6 +25,12 @@ import circfirm.cli.install
     help="Assume the given board ID (and connect in bootloader mode)",
 )
 @click.option("-l", "--language", default="en_US", help="CircuitPython langauge/locale")
+@click.option(
+    "-t",
+    "--timeout",
+    default=-1,
+    help="Set a timeout in seconds for the switch to bootloader mode",
+)
 @click.option(
     "-p",
     "--pre-release",
@@ -46,9 +52,10 @@ import circfirm.cli.install
     default=False,
     help="Upgrade up to patch version updates",
 )
-def cli(
+def cli(  # noqa: PLR0913
     board_id: Optional[str],
     language: str,
+    timeout: int,
     pre_release: bool,
     limit_to_minor: bool,
     limit_to_patch: bool,
@@ -65,7 +72,12 @@ def cli(
             "The latest version will be installed regardless of the currently installed version."
         )
         current_version = "0.0.0"
-    bootloader, board_id = circfirm.cli.get_board_id(circuitpy, bootloader, board_id)
+    try:
+        bootloader, board_id = circfirm.cli.get_board_id(
+            circuitpy, bootloader, board_id, timeout
+        )
+    except OSError as err:
+        raise click.ClickException(err.args[0])
 
     new_versions = circfirm.backend.s3.get_board_versions(board_id, language)
 

circfirm/startup.py

@@ -10,13 +10,12 @@ Author(s): Alec Delaney
 import os
 import pathlib
 import shutil
-from typing import List, Tuple
 
 import click
 
-FOLDER_LIST: List[str] = []
-FILE_LIST: List[str] = []
-TEMPLATE_LIST: List[Tuple[str, str]] = []
+FOLDER_LIST: list[str] = []
+FILE_LIST: list[str] = []
+TEMPLATE_LIST: list[tuple[str, str]] = []
 
 
 def specify_app_dir(app_name: str) -> str:

{circfirm-3.1.0.dist-info → circfirm-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: circfirm
-Version: 3.1.0
+Version: 4.0.0
 Summary: CLI tool for install firmware for CircuitPython boards
 Author-email: Alec Delaney <tekktrik@gmail.com>
 License: MIT
@@ -15,37 +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
 License-File: NOTICE
 License-File: NOTICE.license
-Requires-Dist: boto3 ~=1.34
-Requires-Dist: click ~=8.0
-Requires-Dist: click-spinner ~=0.1
-Requires-Dist: packaging ~=23.2
-Requires-Dist: psutil ~=5.9
-Requires-Dist: pyyaml ~=6.0
-Requires-Dist: requests ~=2.31
-Requires-Dist: boto3-stubs[essential] ~=1.34
+Requires-Dist: boto3~=1.35
+Requires-Dist: click~=8.1
+Requires-Dist: click-spinner~=0.1
+Requires-Dist: packaging~=24.2
+Requires-Dist: psutil~=6.1
+Requires-Dist: pyyaml~=6.0
+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: sphinx-tabs ~=3.4 ; extra == 'dev'
-Requires-Dist: sphinx-rtd-theme ~=1.0 ; 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~=3.0; extra == "dev"
 
 ..
    SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries

circfirm-4.0.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+circfirm/__init__.py,sha256=Uk6XRo7aFQcwUOMfst4GVt8tuXbMRnDIsPRrWeBtxLQ,719
+circfirm/py.typed,sha256=F2H7kdQErBIQUjr5WG2gdwj35iaUHi4Eyc2hovaLTMA,97
+circfirm/startup.py,sha256=HoeMpISAJswKTFn-sHhtoCD5yISHW5z8ZPW7WgSr2xg,1946
+circfirm/backend/__init__.py,sha256=fzxooHsys60iPrj6q6l-t3m2iGAC6FEIinP1UFgGHKE,1858
+circfirm/backend/cache.py,sha256=cxd_Za68SotnQ4td9R3-_F20Rci5BMVO1LgD0CVpKRo,2931
+circfirm/backend/device.py,sha256=t_g4iPJ4C2Qg5xKUr1AI6XPu5-ULTDZ4e3qAZVSfJs8,1776
+circfirm/backend/github.py,sha256=ePHXTCxqGcJOyVsutdbsL80MaxIYBdNIV9Yzz8aG4Yg,2090
+circfirm/backend/s3.py,sha256=eTwCD79E8TCia2kPcj1-p7qmIvTt2vqQC_K7mHKWeyk,2175
+circfirm/cli/__init__.py,sha256=TBJxvMqzTXQNEv2jKTZHqxeTTvGoQ9sz4o4R91Qe4Kg,6454
+circfirm/cli/about.py,sha256=_QNqXtbyerlxewPVieCdOvQ6BZWqdgvncBIzj39zpCU,340
+circfirm/cli/cache.py,sha256=z1DtWFusGAeUnzFTl0dcxyko7eOQmJUyR1x3orfEWk8,5222
+circfirm/cli/config.py,sha256=9ye3jQhgXaOMAXIlJWHp8PhBEtjUTJSL9szTXCQU2Cg,3122
+circfirm/cli/current.py,sha256=3kjvAQ5oFuXxey8RtU6T5GJPnTmIy2saEpyYoqVOTU8,1034
+circfirm/cli/detect.py,sha256=hXOIFjQAylx5kDT1chU2HJXqIv14scDJheO5-XUioeI,944
+circfirm/cli/install.py,sha256=z0pT7J_n4A3dJn-ocZk-uYcKkOZ3iUHbId-f-k97cg0,1253
+circfirm/cli/query.py,sha256=628UQhQxUMoTnKwPJhhL0ZjmKR_zNJTFgq-PzV-SPlM,2959
+circfirm/cli/update.py,sha256=S25Cty4HXy71hQvAXbxP_JNN_2JgcvXxfocte0rzMWE,3433
+circfirm/templates/settings.yaml,sha256=SM1zjXvZg1jikzn9TjgOufl0Pn9KBbrw8sIcJ01BRhQ,69
+circfirm/templates/settings.yaml.license,sha256=F2H7kdQErBIQUjr5WG2gdwj35iaUHi4Eyc2hovaLTMA,97
+circfirm-4.0.0.dist-info/LICENSE,sha256=6pPP6gJ00tqCkxg5gABHDwWUiXZ_mBzH94xxPOqwGj4,1069
+circfirm-4.0.0.dist-info/METADATA,sha256=vedVLmckngt1DSxN0IUD9q5c_NujIfxih9JTUg0ktok,4678
+circfirm-4.0.0.dist-info/NOTICE,sha256=-iTImDmAffekkp_kj8De0_pvckHvXAHLPAJTWOgQsiw,2956
+circfirm-4.0.0.dist-info/NOTICE.license,sha256=FIvC5TnLXwPBj-dgEV4FBwAlJxzMXhgl50TXLv2d88o,96
+circfirm-4.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+circfirm-4.0.0.dist-info/entry_points.txt,sha256=33qZTmSuXz8dgi29yjSyb8VsEA8HyhWuhn2MNcjatGQ,46
+circfirm-4.0.0.dist-info/top_level.txt,sha256=qA2407wap3My6jGA5uchH2JjUM7qn73oBPwALN7GR5k,9
+circfirm-4.0.0.dist-info/RECORD,,

{circfirm-3.1.0.dist-info → circfirm-4.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

circfirm-3.1.0.dist-info/RECORD

@@ -1,26 +0,0 @@
-circfirm/__init__.py,sha256=Uk6XRo7aFQcwUOMfst4GVt8tuXbMRnDIsPRrWeBtxLQ,719
-circfirm/py.typed,sha256=F2H7kdQErBIQUjr5WG2gdwj35iaUHi4Eyc2hovaLTMA,97
-circfirm/startup.py,sha256=eorElSnwGkW7jb87t0J7y7JAtg1yyeSD2xNqDjXPI6I,1977
-circfirm/backend/__init__.py,sha256=H9X3u-13jHhCeDYeTTCAAEBwrlfkZzJScOgv2bY7Oto,1883
-circfirm/backend/cache.py,sha256=nwJPobc93jaOuEvM7srYfYbolz9fYycicUmp0iI5LUU,2893
-circfirm/backend/device.py,sha256=4K36uMVdH3kGnBBbZ_ApGrwB-G3CtC-aMdH_fP6k7S0,1783
-circfirm/backend/github.py,sha256=vyDeUS76haKMVVOewS4xq1tRHGtHb1SWXP6ippOKtZs,2103
-circfirm/backend/s3.py,sha256=OZ7Pewxspk_W_AjIaWVQajVPCQcOgVHy9e1ulugT8YA,2181
-circfirm/cli/__init__.py,sha256=sW58Qwk4H_BquDioJjTIi7PNQOznsAgOfq4hFGM8Dlg,6059
-circfirm/cli/about.py,sha256=_QNqXtbyerlxewPVieCdOvQ6BZWqdgvncBIzj39zpCU,340
-circfirm/cli/cache.py,sha256=z1DtWFusGAeUnzFTl0dcxyko7eOQmJUyR1x3orfEWk8,5222
-circfirm/cli/config.py,sha256=9ye3jQhgXaOMAXIlJWHp8PhBEtjUTJSL9szTXCQU2Cg,3122
-circfirm/cli/current.py,sha256=ZfMbBVYS5AyVdHb8s0ElvkUX5QuX6_iOrvjVfyAfNGU,1060
-circfirm/cli/install.py,sha256=dJQhZVpNOVcspcPMSyTtZq3BiX_RgXEm9ejaaNWcvXA,989
-circfirm/cli/query.py,sha256=628UQhQxUMoTnKwPJhhL0ZjmKR_zNJTFgq-PzV-SPlM,2959
-circfirm/cli/update.py,sha256=qZ7BEdyt4mTOjfmISRzeP3yl74yZ2-xVBTEcr9XlUlc,3148
-circfirm/templates/settings.yaml,sha256=SM1zjXvZg1jikzn9TjgOufl0Pn9KBbrw8sIcJ01BRhQ,69
-circfirm/templates/settings.yaml.license,sha256=F2H7kdQErBIQUjr5WG2gdwj35iaUHi4Eyc2hovaLTMA,97
-circfirm-3.1.0.dist-info/LICENSE,sha256=6pPP6gJ00tqCkxg5gABHDwWUiXZ_mBzH94xxPOqwGj4,1069
-circfirm-3.1.0.dist-info/METADATA,sha256=WpyUEuANc09J5kyAo3yXXG54jVGzWxVTWSEr_2khFPI,4700
-circfirm-3.1.0.dist-info/NOTICE,sha256=-iTImDmAffekkp_kj8De0_pvckHvXAHLPAJTWOgQsiw,2956
-circfirm-3.1.0.dist-info/NOTICE.license,sha256=FIvC5TnLXwPBj-dgEV4FBwAlJxzMXhgl50TXLv2d88o,96
-circfirm-3.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-circfirm-3.1.0.dist-info/entry_points.txt,sha256=33qZTmSuXz8dgi29yjSyb8VsEA8HyhWuhn2MNcjatGQ,46
-circfirm-3.1.0.dist-info/top_level.txt,sha256=qA2407wap3My6jGA5uchH2JjUM7qn73oBPwALN7GR5k,9
-circfirm-3.1.0.dist-info/RECORD,,