mpflash 0.2.2__py3-none-any.whl → 0.2.2.post2__py3-none-any.whl

mpflash/cli_group.py

@@ -40,11 +40,11 @@ def cb_ignore(ctx, param, value):
     "--ignore",
     "-i",
     is_eager=True,
-    help="Serial port(s) to ignore. Defaults to MPTOOL_IGNORE.",
+    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
     callback=cb_ignore,
     multiple=True,
     default=[],
-    envvar="MPTOOL_IGNORE",
+    envvar="MPFLASH_IGNORE",
     show_default=True,
     metavar="SERIALPORT",
 )

mpflash/cli_main.py

@@ -14,7 +14,7 @@ def mpflash():
     # cli.add_command(flash_board)
     # cli.add_command(list_boards)
     # cli.add_command(download)
-    cli()  # auto_envvar_prefix='MPTOOL')
+    cli(auto_envvar_prefix="MPFLASH")
 
 
 if __name__ == "__main__":

mpflash/common.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from typing import Dict, Union
 
+import platformdirs
 from github import Github
 from loguru import logger as log
 from packaging.version import parse
@@ -12,11 +13,11 @@ PORT_FWTYPES = {
     "rp2": ".uf2",
     "samd": ".uf2",
     "mimxrt": ".hex",
-    "nrf": ".hex",
+    "nrf": ".uf2",
     "renesas-ra": ".hex",
 }
 
-DEFAULT_FW_PATH = Path.cwd() / "firmware"
+DEFAULT_FW_PATH = platformdirs.user_downloads_path() / "firmware"
 # DEFAULT_FW_PATH = Path.home() / "mp_firmware"
 
 FWInfo = Dict[str, Union[str, bool]]
@@ -87,9 +88,7 @@ def micropython_versions(minver: str = "v1.9.2"):
         g = Github()
         _ = 1 / 0
         repo = g.get_repo("micropython/micropython")
-        versions = [
-            tag.name for tag in repo.get_tags() if parse(tag.name) >= parse(minver)
-        ]
+        versions = [tag.name for tag in repo.get_tags() if parse(tag.name) >= parse(minver)]
     except Exception:
         versions = [
             "v9.99.9-preview",

mpflash/downloader.py

@@ -18,7 +18,7 @@ from loguru import logger as log
 from rich.progress import track
 
 from .cli_group import cli
-from .common import PORT_FWTYPES, clean_version
+from .common import DEFAULT_FW_PATH, PORT_FWTYPES, clean_version
 
 MICROPYTHON_ORG_URL = "https://micropython.org/"
 
@@ -40,6 +40,7 @@ DEFAULT_BOARDS = [
     "ARDUINO_NANO_RP2040_CONNECT",
     "PIMORONI_PICOLIPO_16MB",
     "SEEED_WIO_TERMINAL",
+    "PARTICLE_XENON",
 ]
 
 
@@ -77,9 +78,7 @@ def firmware_list(board_url: str, base_url: str, ext: str) -> List[str]:
     tags = soup.findAll(
         "a",
         recursive=True,
-        attrs={
-            "href": re.compile(r"^/resources/firmware/.*\." + ext.lstrip(".") + "$")
-        },
+        attrs={"href": re.compile(r"^/resources/firmware/.*\." + ext.lstrip(".") + "$")},
     )
     if "?" in base_url:
         base_url = base_url.split("?")[0]
@@ -94,9 +93,7 @@ FirmwareInfo = Dict[str, str]
 # boards we are interested in ( this avoids getting a lot of boards we don't care about)
 # The first run takes ~60 seconds to run for 4 ports , all boards
 # so it makes sense to cache the results and skip boards as soon as possible
-def get_boards(
-    fw_types: Dict[str, str], board_list: List[str], clean: bool
-) -> List[FirmwareInfo]:
+def get_boards(fw_types: Dict[str, str], board_list: List[str], clean: bool) -> List[FirmwareInfo]:
     board_urls: List[FirmwareInfo] = []
     for port in fw_types:
         download_page_url = f"{MICROPYTHON_ORG_URL}download/?port={port}"
@@ -107,9 +104,7 @@ def get_boards(
         for board in _urls:
             board["port"] = port
 
-        for board in track(
-            _urls, description="Checking download pages", transient=True
-        ):
+        for board in track(_urls, description=f"Checking {port} download pages", transient=True):
             # add a board to the list for each firmware found
             firmwares = firmware_list(board["url"], MICROPYTHON_ORG_URL, fw_types[port])
             for _url in firmwares:
@@ -130,11 +125,7 @@ def get_boards(
                     # remove hash from firmware name
                     fname = re.sub(RE_HASH, ".", fname)
                 board["filename"] = fname
-                board["variant"] = (
-                    board["filename"].split("-v")[0]
-                    if "-v" in board["filename"]
-                    else ""
-                )
+                board["variant"] = board["filename"].split("-v")[0] if "-v" in board["filename"] else ""
                 board_urls.append(board.copy())
     return board_urls
 
@@ -171,9 +162,7 @@ def download_firmwares(
 
     firmware_folder.mkdir(exist_ok=True)
 
-    with open(
-        firmware_folder / "firmware.jsonl", "a", encoding="utf-8", buffering=1
-    ) as f_jsonl:
+    with open(firmware_folder / "firmware.jsonl", "a", encoding="utf-8", buffering=1) as f_jsonl:
         for board in unique_boards:
             filename = firmware_folder / board["port"] / board["filename"]
             filename.parent.mkdir(exist_ok=True)
@@ -197,21 +186,16 @@ def download_firmwares(
     log.info(f"Downloaded {downloaded} firmwares, skipped {skipped} existing files.")
 
 
-def get_firmware_list(
-    board_list: List[str], version_list: List[str], preview: bool, clean: bool
-):
+def get_firmware_list(board_list: List[str], version_list: List[str], preview: bool, clean: bool):
     log.trace("Checking MicroPython download pages")
 
-    board_urls = sorted(
-        get_boards(PORT_FWTYPES, board_list, clean), key=key_fw_variant_ver
-    )
+    board_urls = sorted(get_boards(PORT_FWTYPES, board_list, clean), key=key_fw_variant_ver)
 
     log.debug(f"Total {len(board_urls)} firmwares")
     relevant = [
         board
         for board in board_urls
-        if board["board"] in board_list
-        and (board["version"] in version_list or board["preview"] and preview)
+        if board["board"] in board_list and (board["version"] in version_list or board["preview"] and preview)
         # and b["port"] in ["esp32", "rp2"]
     ]
     log.debug(f"Matching firmwares: {len(relevant)}")
@@ -233,7 +217,7 @@ def get_firmware_list(
     "--destination",
     "-d",
     type=click.Path(file_okay=False, dir_okay=True, path_type=Path),
-    default="./firmware",
+    default=DEFAULT_FW_PATH,
     show_default=True,
     help="The folder to download the firmware to.",
 )
@@ -267,19 +251,13 @@ def get_firmware_list(
     help="""Force download of firmware even if it already exists.""",
     show_default=True,
 )
-def download(
-    destination: Path, boards: List[str], versions: List[str], force: bool, clean: bool
-):
+def download(destination: Path, boards: List[str], versions: List[str], force: bool, clean: bool):
     versions = list(versions)
     # preview is not a version, it is an option to include preview versions
     preview = "preview" in versions
     versions = [v for v in versions if v != "preview"]
 
     boards = list(boards) or DEFAULT_BOARDS
-    versions = [
-        clean_version(v, drop_v=True) for v in versions
-    ]  # remove leading v from version
+    versions = [clean_version(v, drop_v=True) for v in versions]  # remove leading v from version
     destination.mkdir(exist_ok=True)
-    download_firmwares(
-        destination, boards, versions, preview=preview, force=force, clean=clean
-    )
+    download_firmwares(destination, boards, versions, preview=preview, force=force, clean=clean)

mpflash/flasher.py

@@ -104,9 +104,7 @@ def auto_update(conn_boards: List[MPRemoteBoard], target_version: str, fw_folder
     wl: WorkList = []
     for mcu in conn_boards:
         if mcu.family != "micropython":
-            log.warning(
-                f"Skipping {mcu.board} on {mcu.serialport} as it is not a micropython board"
-            )
+            log.warning(f"Skipping {mcu.board} on {mcu.serialport} as it is not a micropython board")
             continue
         board_firmwares = find_firmware(
             fw_folder=fw_folder,
@@ -117,19 +115,13 @@ def auto_update(conn_boards: List[MPRemoteBoard], target_version: str, fw_folder
         )
 
         if not board_firmwares:
-            log.error(
-                f"No {target_version} firmware found for {mcu.board} on {mcu.serialport}."
-            )
+            log.error(f"No {target_version} firmware found for {mcu.board} on {mcu.serialport}.")
             continue
         if len(board_firmwares) > 1:
-            log.debug(
-                f"Multiple {target_version} firmwares found for {mcu.board} on {mcu.serialport}."
-            )
+            log.debug(f"Multiple {target_version} firmwares found for {mcu.board} on {mcu.serialport}.")
         # just use the last firmware
         fw_info = board_firmwares[-1]
-        log.info(
-            f"Found {target_version} firmware {fw_info['filename']} for {mcu.board} on {mcu.serialport}."
-        )
+        log.info(f"Found {target_version} firmware {fw_info['filename']} for {mcu.board} on {mcu.serialport}.")
         wl.append((mcu, fw_info))
     return wl
 
@@ -148,7 +140,7 @@ def auto_update(conn_boards: List[MPRemoteBoard], target_version: str, fw_folder
     "-f",
     "fw_folder",
     type=click.Path(exists=True, file_okay=False, dir_okay=True, path_type=Path),
-    default="./firmware",
+    default=DEFAULT_FW_PATH,
     show_default=True,
     help="The folder to retrieve the firmware from.",
 )
@@ -233,9 +225,7 @@ def flash_board(
         if serial_port == "auto":
             # update all connected boards
             conn_boards = [
-                MPRemoteBoard(sp)
-                for sp in MPRemoteBoard.connected_boards()
-                if sp not in config.ignore_ports
+                MPRemoteBoard(sp) for sp in MPRemoteBoard.connected_boards() if sp not in config.ignore_ports
             ]
         else:
             # just this serial port
@@ -247,9 +237,7 @@ def flash_board(
     for mcu, fw_info in todo:
         fw_file = fw_folder / fw_info["filename"]  # type: ignore
         if not fw_file.exists():
-            log.error(
-                f"File {fw_file} does not exist, skipping {mcu.board} on {mcu.serialport}"
-            )
+            log.error(f"File {fw_file} does not exist, skipping {mcu.board} on {mcu.serialport}")
             continue
         log.info(f"Updating {mcu.board} on {mcu.serialport} to {fw_info['version']}")
 
@@ -269,12 +257,13 @@ def flash_board(
 
     if flashed:
         log.info(f"Flashed {len(flashed)} boards")
-        conn_boards = [
-            MPRemoteBoard(sp)
-            for sp in MPRemoteBoard.connected_boards()
-            if sp not in config.ignore_ports
-        ]
-        show_boards(conn_boards, title="Connected boards after flashing")
+        # conn_boards = [
+        #     MPRemoteBoard(sp)
+        #     for sp in MPRemoteBoard.connected_boards()
+        #     if sp not in config.ignore_ports
+        # ]
+
+        show_boards(flashed, title="Connected boards after flashing")
 
 
 # TODO:

mpflash/list.py

@@ -24,11 +24,7 @@ from .config import config
     help="""Output in json format""",
 )
 def list_boards(as_json: bool):
-    conn_boards = [
-        MPRemoteBoard(sp)
-        for sp in MPRemoteBoard.connected_boards()
-        if sp not in config.ignore_ports
-    ]
+    conn_boards = [MPRemoteBoard(sp) for sp in MPRemoteBoard.connected_boards() if sp not in config.ignore_ports]
 
     for mcu in track(conn_boards, description="Getting board info"):
         try:

{mpflash-0.2.2.dist-info → mpflash-0.2.2.post2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.2.2
+Version: 0.2.2.post2
 Summary: Download and flashing tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT
@@ -23,6 +23,7 @@ Requires-Dist: esptool (>=4.7.0,<5.0.0)
 Requires-Dist: jsonlines (>=4.0.0,<5.0.0)
 Requires-Dist: loguru (>=0.7.2,<0.8.0)
 Requires-Dist: micropython-stubber (>=1.17.4)
+Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
 Requires-Dist: psutil (>=5.9.8,<6.0.0)
 Requires-Dist: pygithub (>=2.1.1,<3.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
@@ -76,9 +77,12 @@ This will download the latest stable version of the MicroPython firmware for the
 The stable version (default) is determined based on the most recent published release,
 other optionse are `--version preview` and `--version x.y.z` to download the latest preview or version x.y.z respectively.
 
+by default the firmware will be downloaded to  Downloads  in a `firmware` folder in your, but you can specify a different directory using the `--dir` option.
+
+```bash
 The directory structure will be something like this:
 ```
-firmware
+Downloads/firmware
 |   firmware.jsonl
 +---esp8266
 |       ESP8266_GENERIC-FLASH_1M-v1.22.2.bin

mpflash-0.2.2.post2.dist-info/RECORD

@@ -0,0 +1,20 @@
+mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mpflash/cli_group.py,sha256=oWgZlUoXY_Wc9-XMXxuxH3F0TevYNafsFWpRtT_WiiU,1228
+mpflash/cli_main.py,sha256=nLFfR-ti_stLVvgwDRsNXgaQ43gQVZUOz_xvRERPuy0,494
+mpflash/common.py,sha256=RBNfbojPKLK3_cxLFIvtHWy8UZUbBxN0ogBN0nliVR4,3896
+mpflash/config.py,sha256=R_sYZ_UwzIc9H2vhwIU5RSDhpcV3fHIX83FEURWOd5E,160
+mpflash/downloader.py,sha256=QVtgocj4b-c9ZunzEZnsyhEZu_Lbk8Hk-43qWBMJ0AI,9783
+mpflash/flash_esp.py,sha256=XffVg1BKzaQo4pzSJdUoHmHa7h4s4gBlNQR50ahGJ1E,2301
+mpflash/flash_stm32.py,sha256=Pn1y9rKw48D0khucT8yU3NjFkHQ9YYTvwco9ir4MmpQ,3742
+mpflash/flash_uf2.py,sha256=8rZRqdi3Rtp8UsHxKgmoMfZ1yBXZbMFXcOeyVVMmX5w,2029
+mpflash/flash_uf2_linux.py,sha256=wXtpqFan6x5k8h2bwwLqwY-LKbpyTg7n2SbD4eb6yH0,4012
+mpflash/flash_uf2_windows.py,sha256=AiFg5jrSyEMX2QxC2sgfn8GekKBw-fPkIi8emlU7Z7o,711
+mpflash/flasher.py,sha256=J7-bsrfQ0MPEKrnUx47q0OqAS61roLBaETu4nv4MfMU,9400
+mpflash/list.py,sha256=7GpZEK7fh6GCzgUdRLHGp8FMEeCbLstV-2u3ohaRYsc,1970
+mpflash/logger.py,sha256=FvGQSR2l4O9nmJV0rKbyoeJDd7fbY2vKQTmPEED0h6s,1048
+mpflash/uf2_boardid.py,sha256=WZKucGu_hJ8ymb236uuZbiR6pD6AA_l4LA-7LwtQhq8,414
+mpflash-0.2.2.post2.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-0.2.2.post2.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-0.2.2.post2.dist-info/METADATA,sha256=_Dem1zESHqzvSoy3kpmUnuJ8Doz5tqY90B9hLeQ2iv8,12786
+mpflash-0.2.2.post2.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+mpflash-0.2.2.post2.dist-info/RECORD,,

mpflash-0.2.2.dist-info/RECORD

@@ -1,20 +0,0 @@
-mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpflash/cli_group.py,sha256=FuSJwE0z1lvnT1TMFs8Ejsps3UUzxyI-xdzYOa_HA3A,1226
-mpflash/cli_main.py,sha256=fAh_gUrn2Tvo5PkFjiCNy0FX_KYlRY6y627WG0t1MGE,498
-mpflash/common.py,sha256=bW1_JY5904cm6luUlMQmzgYXk7ukrDyMaxwovOyfHes,3875
-mpflash/config.py,sha256=R_sYZ_UwzIc9H2vhwIU5RSDhpcV3fHIX83FEURWOd5E,160
-mpflash/downloader.py,sha256=OsOTNjv-91RQc2quD8ptUzI1-pJhHekE8jARdg-1rhk,9961
-mpflash/flash_esp.py,sha256=XffVg1BKzaQo4pzSJdUoHmHa7h4s4gBlNQR50ahGJ1E,2301
-mpflash/flash_stm32.py,sha256=Pn1y9rKw48D0khucT8yU3NjFkHQ9YYTvwco9ir4MmpQ,3742
-mpflash/flash_uf2.py,sha256=8rZRqdi3Rtp8UsHxKgmoMfZ1yBXZbMFXcOeyVVMmX5w,2029
-mpflash/flash_uf2_linux.py,sha256=wXtpqFan6x5k8h2bwwLqwY-LKbpyTg7n2SbD4eb6yH0,4012
-mpflash/flash_uf2_windows.py,sha256=AiFg5jrSyEMX2QxC2sgfn8GekKBw-fPkIi8emlU7Z7o,711
-mpflash/flasher.py,sha256=_N-CYZZZ401kxZ45CDgl1XDj3lqdMPHjhpbn82ow2Kc,9575
-mpflash/list.py,sha256=shFNDyEnmqqDjiJ4WSpJLTkDO_6H3fvYBeJKzfGFJMw,2004
-mpflash/logger.py,sha256=FvGQSR2l4O9nmJV0rKbyoeJDd7fbY2vKQTmPEED0h6s,1048
-mpflash/uf2_boardid.py,sha256=WZKucGu_hJ8ymb236uuZbiR6pD6AA_l4LA-7LwtQhq8,414
-mpflash-0.2.2.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-0.2.2.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-0.2.2.dist-info/METADATA,sha256=eq_XOtT3s1qrapRnQohULy9OTyMgEBaBFdOesxKeheU,12558
-mpflash-0.2.2.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-mpflash-0.2.2.dist-info/RECORD,,