mpflash 1.24.6__tar.gz → 1.25.0.post1__tar.gz

{mpflash-1.24.6 → mpflash-1.25.0.post1}/PKG-INFO

@@ -1,17 +1,15 @@
 Metadata-Version: 2.3
 Name: mpflash
-Version: 1.24.6
+Version: 1.25.0.post1
 Summary: Flash and download tool for MicroPython firmwares
 License: MIT
 Keywords: MicroPython,firmware,flash,download,UF2,esptool
 Author: Jos Verlinde
 Author-email: jos_verlinde@hotmail.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-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
@@ -32,14 +30,15 @@ Requires-Dist: mpremote (>=1.22.0,<2.0.0)
 Requires-Dist: packaging (>=24.2,<25.0)
 Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
 Requires-Dist: poetry (>=2.0.1,<3.0.0)
-Requires-Dist: psutil (>=5.9.8,<6.0.0)
+Requires-Dist: psutil (>=5.9.8,<8.0.0)
 Requires-Dist: pygithub (>=2.1.1,<3.0.0)
 Requires-Dist: pyusb (>=1.2.1,<2.0.0)
+Requires-Dist: pywin32 (>=310,<311) ; sys_platform == "win32"
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: rich-click (>=1.8.1,<2.0.0)
-Requires-Dist: tenacity (==8.2.3)
-Project-URL: Homepage, https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
-Project-URL: Repository, https://github.com/Josverl/micropython-stubber
+Requires-Dist: tenacity (==9.0.0)
+Project-URL: Homepage, https://github.com/Josverl/mpflash/blob/main/README.md
+Project-URL: Repository, https://github.com/Josverl/mpflash
 Description-Content-Type: text/markdown
 
 # MPFLASH
@@ -48,7 +47,7 @@ Description-Content-Type: text/markdown
 [![Downloads](https://static.pepy.tech/badge/mpflash)](https://pepy.tech/project/mpflash)
 
 
-`mpflash` is a command-line tool for working with MicroPython firmware. It provides features to help you flash and update Micropython on one or more .
+`mpflash` is a command-line tool for working with MicroPython firmware. It provides features to help you flash and update Micropython on one or more attached microcontrollers.
 
 This tool was initially created to be used in a CI/CD pipeline to automate the process of downloading and flashing MicroPython firmware to multiple boards, but it has been extend with a TUI to be used for manual downloadig, flashing and development.
 
@@ -69,7 +68,10 @@ Not yet implemented: `nrf`, `cc3200`, `mimxrt`, `renesas`
  3. Flash one or all connected MicroPython boards with a specific firmware or version.  
  
 ## Installation
-To install mpflash, you can use: `pipx install mpflash` or `pip install mpflash`
+To install mpflash, you can use either of the following commands: 
+- `uv tool install mpflash`
+- `pipx install mpflash`
+- `pip install mpflash`
 
 ## Basic usage
 You can use mpflash to perform various operations on your MicroPython boards. Here is an example of basic usage:
@@ -102,6 +104,7 @@ description = "Blue Norwegian actuator"
 
 If you want the board to be ignored by mpflash, you can add the following to the board_info.toml file:
 ```toml
+description = "Blue Norwegian feeder"
 [mpflash]
 ignore = true
 ```
@@ -110,8 +113,13 @@ ignore = true
 ## Linux permissions to access usb devices 
 In order to flash the firmware to the board, you need to have the correct permissions to access the USB devices.
 On Windows this will not be an issue, but on Linux you can use  udev rules to give non-root users access to the USB devices.
-[See the stm32_permissions documentation](./stm32_udev_rules.md) for more information.
+[See the stm32_permissions documentation](docs/stm32_udev_rules.md) for more information.
 
+## Use MPFlash in your own project
+
+MPFlash can be used as a library in your own project. mpflash is used in [micropython-stubber]() to download and flash the firmware to the connected boards.
+
+The interface is not well documented other than the code itself, but you can use the following example to get started:  - docs/mpflash_api_example.ipynb
 
 ## Detailed usage
 You can list the connected boards using the following command:
@@ -257,9 +265,59 @@ Note that if no matching firmware can be found for a board, it will be skipped.
 (For example, the PYBV11 and ESP32_GENERIC_S3 boards in the example above.)
 
 ## Issues and bug reports
-mpflash is currently co-located in the [micropython-stubber](https://github.com/Josverl/micropython-stubber) repository.  
-Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/micropython-stubber/issues) using the MPflash feedback template.
+Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/mpflash/issues).
 
 ## License
 mpflash is licensed under the MIT license. See the LICENSE file for more details.
 
+# Contributions
+<!-- spell-checker: disable -->
+<!-- 
+To add via the cli run the following command:
+npx all-contributors-cli add user things
+
+ - bug
+ - tool
+ - stubs
+ - test
+ - doc
+ - code
+ - research
+ - ideas
+ - content
+ - mpflash
+ -->
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Josverl"><img src="https://avatars2.githubusercontent.com/u/981654?v=4?s=100" width="100px;" alt="Jos Verlinde"/><br /><sub><b>Jos Verlinde</b></sub></a><br /><a href="https://github.com/Josverl/mpflash/commits?author=josverl" title="Code">💻</a> <a href="#research-josverl" title="Research">🔬</a> <a href="#ideas-josverl" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-josverl" title="Content">🖋</a> <a href="#test-josverl" title="Test">✅</a> <a href="#mpflash-josverl" title="mpflash">💥</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shariltumin"><img src="https://avatars.githubusercontent.com/u/186120?v=4?s=100" width="100px;" alt="shariltumin"/><br /><sub><b>shariltumin</b></sub></a><br /><a href="#mpflash-shariltumin" title="mpflash">💥</a> <a href="#test-shariltumin" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mattytrentini"><img src="https://avatars.githubusercontent.com/u/194201?v=4?s=100" width="100px;" alt="Matt Trentini"/><br /><sub><b>Matt Trentini</b></sub></a><br /><a href="#mpflash-mattytrentini" title="mpflash">💥</a> <a href="#test-mattytrentini" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://scruss.com/blog/"><img src="https://avatars.githubusercontent.com/u/425706?v=4?s=100" width="100px;" alt="Stewart Russell"/><br /><sub><b>Stewart Russell</b></sub></a><br /><a href="#mpflash-scruss" title="mpflash">💥</a> <a href="#test-scruss" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.gitlab.com/alelec"><img src="https://avatars.githubusercontent.com/u/3318786?v=4?s=100" width="100px;" alt="Andrew Leech"/><br /><sub><b>Andrew Leech</b></sub></a><br /><a href="#mpflash-andrewleech" title="mpflash">💥</a> <a href="#test-andrewleech" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/wovo"><img src="https://avatars.githubusercontent.com/u/9039468?v=4?s=100" width="100px;" alt="Wouter van Ooijen"/><br /><sub><b>Wouter van Ooijen</b></sub></a><br /><a href="#mpflash-wovo" title="mpflash">💥</a> <a href="#test-wovo" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shaneapowell"><img src="https://avatars.githubusercontent.com/u/12113620?v=4?s=100" width="100px;" alt="Shane Powell"/><br /><sub><b>Shane Powell</b></sub></a><br /><a href="#mpflash-shaneapowell" title="mpflash">💥</a> <a href="#test-shaneapowell" title="Test">✅</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/robert-hh"><img src="https://avatars.githubusercontent.com/u/12476868?v=4?s=100" width="100px;" alt="Robert Hammelrath"/><br /><sub><b>Robert Hammelrath</b></sub></a><br /><a href="#mpflash-robert-hh" title="mpflash">💥</a> <a href="#test-robert-hh" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/beetlegigg"><img src="https://avatars.githubusercontent.com/u/34552737?v=4?s=100" width="100px;" alt="Bg"/><br /><sub><b>Bg</b></sub></a><br /><a href="#mpflash-beetlegigg" title="mpflash">💥</a> <a href="#test-beetlegigg" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rkompass"><img src="https://avatars.githubusercontent.com/u/90282516?v=4?s=100" width="100px;" alt="Raul Kompaß"/><br /><sub><b>Raul Kompaß</b></sub></a><br /><a href="#mpflash-rkompass" title="mpflash">💥</a> <a href="#test-rkompass" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/garryp4"><img src="https://avatars.githubusercontent.com/u/96994876?v=4?s=100" width="100px;" alt="garryp4"/><br /><sub><b>garryp4</b></sub></a><br /><a href="#mpflash-garryp4" title="mpflash">💥</a> <a href="#test-garryp4" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shanepowell-ast"><img src="https://avatars.githubusercontent.com/u/102747617?v=4?s=100" width="100px;" alt="Shane Powell"/><br /><sub><b>Shane Powell</b></sub></a><br /><a href="#mpflash-shanepowell-ast" title="mpflash">💥</a> <a href="#test-shanepowell-ast" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://andypiper.org/"><img src="https://avatars.githubusercontent.com/u/552452?v=4?s=100" width="100px;" alt="Andy Piper"/><br /><sub><b>Andy Piper</b></sub></a><br /><a href="#mpflash-andypiper" title="mpflash">💥</a> <a href="#test-andypiper" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/DavesCodeMusings"><img src="https://avatars.githubusercontent.com/u/61114342?v=4?s=100" width="100px;" alt="David Horton"/><br /><sub><b>David Horton</b></sub></a><br /><a href="#mpflash-DavesCodeMusings" title="mpflash">💥</a> <a href="#test-DavesCodeMusings" title="Test">✅</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+

{mpflash-1.24.6 → mpflash-1.25.0.post1}/README.md

@@ -4,7 +4,7 @@
 [![Downloads](https://static.pepy.tech/badge/mpflash)](https://pepy.tech/project/mpflash)
 
 
-`mpflash` is a command-line tool for working with MicroPython firmware. It provides features to help you flash and update Micropython on one or more .
+`mpflash` is a command-line tool for working with MicroPython firmware. It provides features to help you flash and update Micropython on one or more attached microcontrollers.
 
 This tool was initially created to be used in a CI/CD pipeline to automate the process of downloading and flashing MicroPython firmware to multiple boards, but it has been extend with a TUI to be used for manual downloadig, flashing and development.
 
@@ -25,7 +25,10 @@ Not yet implemented: `nrf`, `cc3200`, `mimxrt`, `renesas`
  3. Flash one or all connected MicroPython boards with a specific firmware or version.  
  
 ## Installation
-To install mpflash, you can use: `pipx install mpflash` or `pip install mpflash`
+To install mpflash, you can use either of the following commands: 
+- `uv tool install mpflash`
+- `pipx install mpflash`
+- `pip install mpflash`
 
 ## Basic usage
 You can use mpflash to perform various operations on your MicroPython boards. Here is an example of basic usage:
@@ -58,6 +61,7 @@ description = "Blue Norwegian actuator"
 
 If you want the board to be ignored by mpflash, you can add the following to the board_info.toml file:
 ```toml
+description = "Blue Norwegian feeder"
 [mpflash]
 ignore = true
 ```
@@ -66,8 +70,13 @@ ignore = true
 ## Linux permissions to access usb devices 
 In order to flash the firmware to the board, you need to have the correct permissions to access the USB devices.
 On Windows this will not be an issue, but on Linux you can use  udev rules to give non-root users access to the USB devices.
-[See the stm32_permissions documentation](./stm32_udev_rules.md) for more information.
+[See the stm32_permissions documentation](docs/stm32_udev_rules.md) for more information.
 
+## Use MPFlash in your own project
+
+MPFlash can be used as a library in your own project. mpflash is used in [micropython-stubber]() to download and flash the firmware to the connected boards.
+
+The interface is not well documented other than the code itself, but you can use the following example to get started:  - docs/mpflash_api_example.ipynb
 
 ## Detailed usage
 You can list the connected boards using the following command:
@@ -213,8 +222,58 @@ Note that if no matching firmware can be found for a board, it will be skipped.
 (For example, the PYBV11 and ESP32_GENERIC_S3 boards in the example above.)
 
 ## Issues and bug reports
-mpflash is currently co-located in the [micropython-stubber](https://github.com/Josverl/micropython-stubber) repository.  
-Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/micropython-stubber/issues) using the MPflash feedback template.
+Please report any issues or bugs in the [issue tracker](https://github.com/Josverl/mpflash/issues).
 
 ## License
 mpflash is licensed under the MIT license. See the LICENSE file for more details.
+
+# Contributions
+<!-- spell-checker: disable -->
+<!-- 
+To add via the cli run the following command:
+npx all-contributors-cli add user things
+
+ - bug
+ - tool
+ - stubs
+ - test
+ - doc
+ - code
+ - research
+ - ideas
+ - content
+ - mpflash
+ -->
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Josverl"><img src="https://avatars2.githubusercontent.com/u/981654?v=4?s=100" width="100px;" alt="Jos Verlinde"/><br /><sub><b>Jos Verlinde</b></sub></a><br /><a href="https://github.com/Josverl/mpflash/commits?author=josverl" title="Code">💻</a> <a href="#research-josverl" title="Research">🔬</a> <a href="#ideas-josverl" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-josverl" title="Content">🖋</a> <a href="#test-josverl" title="Test">✅</a> <a href="#mpflash-josverl" title="mpflash">💥</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shariltumin"><img src="https://avatars.githubusercontent.com/u/186120?v=4?s=100" width="100px;" alt="shariltumin"/><br /><sub><b>shariltumin</b></sub></a><br /><a href="#mpflash-shariltumin" title="mpflash">💥</a> <a href="#test-shariltumin" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mattytrentini"><img src="https://avatars.githubusercontent.com/u/194201?v=4?s=100" width="100px;" alt="Matt Trentini"/><br /><sub><b>Matt Trentini</b></sub></a><br /><a href="#mpflash-mattytrentini" title="mpflash">💥</a> <a href="#test-mattytrentini" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://scruss.com/blog/"><img src="https://avatars.githubusercontent.com/u/425706?v=4?s=100" width="100px;" alt="Stewart Russell"/><br /><sub><b>Stewart Russell</b></sub></a><br /><a href="#mpflash-scruss" title="mpflash">💥</a> <a href="#test-scruss" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.gitlab.com/alelec"><img src="https://avatars.githubusercontent.com/u/3318786?v=4?s=100" width="100px;" alt="Andrew Leech"/><br /><sub><b>Andrew Leech</b></sub></a><br /><a href="#mpflash-andrewleech" title="mpflash">💥</a> <a href="#test-andrewleech" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/wovo"><img src="https://avatars.githubusercontent.com/u/9039468?v=4?s=100" width="100px;" alt="Wouter van Ooijen"/><br /><sub><b>Wouter van Ooijen</b></sub></a><br /><a href="#mpflash-wovo" title="mpflash">💥</a> <a href="#test-wovo" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shaneapowell"><img src="https://avatars.githubusercontent.com/u/12113620?v=4?s=100" width="100px;" alt="Shane Powell"/><br /><sub><b>Shane Powell</b></sub></a><br /><a href="#mpflash-shaneapowell" title="mpflash">💥</a> <a href="#test-shaneapowell" title="Test">✅</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/robert-hh"><img src="https://avatars.githubusercontent.com/u/12476868?v=4?s=100" width="100px;" alt="Robert Hammelrath"/><br /><sub><b>Robert Hammelrath</b></sub></a><br /><a href="#mpflash-robert-hh" title="mpflash">💥</a> <a href="#test-robert-hh" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/beetlegigg"><img src="https://avatars.githubusercontent.com/u/34552737?v=4?s=100" width="100px;" alt="Bg"/><br /><sub><b>Bg</b></sub></a><br /><a href="#mpflash-beetlegigg" title="mpflash">💥</a> <a href="#test-beetlegigg" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rkompass"><img src="https://avatars.githubusercontent.com/u/90282516?v=4?s=100" width="100px;" alt="Raul Kompaß"/><br /><sub><b>Raul Kompaß</b></sub></a><br /><a href="#mpflash-rkompass" title="mpflash">💥</a> <a href="#test-rkompass" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/garryp4"><img src="https://avatars.githubusercontent.com/u/96994876?v=4?s=100" width="100px;" alt="garryp4"/><br /><sub><b>garryp4</b></sub></a><br /><a href="#mpflash-garryp4" title="mpflash">💥</a> <a href="#test-garryp4" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shanepowell-ast"><img src="https://avatars.githubusercontent.com/u/102747617?v=4?s=100" width="100px;" alt="Shane Powell"/><br /><sub><b>Shane Powell</b></sub></a><br /><a href="#mpflash-shanepowell-ast" title="mpflash">💥</a> <a href="#test-shanepowell-ast" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://andypiper.org/"><img src="https://avatars.githubusercontent.com/u/552452?v=4?s=100" width="100px;" alt="Andy Piper"/><br /><sub><b>Andy Piper</b></sub></a><br /><a href="#mpflash-andypiper" title="mpflash">💥</a> <a href="#test-andypiper" title="Test">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/DavesCodeMusings"><img src="https://avatars.githubusercontent.com/u/61114342?v=4?s=100" width="100px;" alt="David Horton"/><br /><sub><b>David Horton</b></sub></a><br /><a href="#mpflash-DavesCodeMusings" title="mpflash">💥</a> <a href="#test-DavesCodeMusings" title="Test">✅</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/ask_input.py

@@ -11,8 +11,7 @@ from loguru import logger as log
 
 from .common import DownloadParams, FlashParams, ParamType
 from .config import config
-from .mpboard_id import (get_known_boards_for_port, get_known_ports,
-                         known_stored_boards)
+from .mpboard_id import get_known_boards_for_port, get_known_ports, known_stored_boards
 from .mpremoteboard import MPRemoteBoard
 from .versions import micropython_versions
 
@@ -73,11 +72,11 @@ def ask_missing_params(
         #  params.ports = [p for p in params.ports if p != "?"]  # remove the "?" if present
         if isinstance(answers["port"], str):
             params.ports.append(answers["port"])
-        elif isinstance(answers["port"], list): # type: ignore
+        elif isinstance(answers["port"], list):  # type: ignore
             params.ports.extend(answers["port"])
         else:
             raise ValueError(f"Unexpected type for answers['port']: {type(answers['port'])}")
-        
+
     if "boards" in answers:
         params.boards = [b for b in params.boards if b != "?"]  # remove the "?" if present
         params.boards.extend(answers["boards"] if isinstance(answers["boards"], list) else [answers["boards"]])
@@ -157,23 +156,24 @@ def ask_port_board(*, multi_select: bool, action: str):
         ),
         inquirer_ux(
             "boards",
-            message=(
-                "Which {port} board firmware do you want to {action} " + "to {serial} ?" if action == "flash" else "?"
-            ),
+            message=("Which {port} board firmware do you want to {action} " + "to {serial} ?" if action == "flash" else "?"),
             choices=filter_matching_boards,
             validate=at_least_one_validation,  # type: ignore
             # validate=lambda _, x: True if x else "Please select at least one board",  # type: ignore
         ),
     ]
 
+
 def at_least_one_validation(answers, current) -> bool:
     import inquirer.errors
+
     if not current:
         raise inquirer.errors.ValidationError("", reason="Please select at least one item.")
     if isinstance(current, list) and not any(current):
         raise inquirer.errors.ValidationError("", reason="Please select at least one item.")
     return True
 
+
 def ask_mp_version(multi_select: bool, action: str):
     """
     Asks the user for the version selection.

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/basicgit.py

@@ -4,28 +4,25 @@ Simple Git module, where needed via powershell
 Some of the functions are based on the PyGithub module
 """
 
-import os
 import subprocess
 from pathlib import Path
 from typing import List, Optional, Union
 
 import cachetools.func
-from github import Auth, BadCredentialsException, Github
 from loguru import logger as log
-from packaging.version import parse
 
-# from mpflash.versions import SET_PREVIEW
+from mpflash.config import config
 
-# Token with no permissions to avoid throttling
-# https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#getting-a-higher-rate-limit
-PAT_NO_ACCESS = (
-    "github_pat_"
-    + "11AAHPVFQ0G4NTaQ73Bw5J"
-    + "_fAp7K9sZ1qL8VFnI9g78eUlCdmOXHB3WzSdj2jtEYb4XF3N7PDJBl32qIxq"
-)
-PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
-GH_CLIENT = Github(auth=Auth.Token(PAT))
+# from github import Auth, BadCredentialsException, Github
 
+# # Token with no permissions to avoid throttling
+# # https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#getting-a-higher-rate-limit
+# PAT_NO_ACCESS = "github_pat_" + "11AAHPVFQ0G4NTaQ73Bw5J" + "_fAp7K9sZ1qL8VFnI9g78eUlCdmOXHB3WzSdj2jtEYb4XF3N7PDJBl32qIxq"
+# PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
+
+# # GH_CLIENT = Github(auth=Auth.Token(PAT))
+
+# GH_CLIENT = None
 
 def _run_local_git(
     cmd: List[str],
@@ -47,14 +44,14 @@ def _run_local_git(
                 encoding="utf-8",
             )
         else:
-            result = subprocess.run(
-                cmd, capture_output=capture_output, check=True, encoding="utf-8"
-            )
+            result = subprocess.run(cmd, capture_output=capture_output, check=True, encoding="utf-8")
     except (NotADirectoryError, FileNotFoundError) as e:  # pragma: no cover
+        log.error(f"Not a directory: {e}")
         return None
     except subprocess.CalledProcessError as e:  # pragma: no cover
         # add some logging for github actions
-        log.error(f"{str(e)} : { e.stderr}")
+        log.info(f"Command: {cmd}")
+        log.error(f"{str(e)} : {e.returncode}\n{e.stdout}\n{e.stderr}")
         return None
     if result.stderr and result.stderr != b"":
         stderr = result.stderr
@@ -88,9 +85,7 @@ def clone(remote_repo: str, path: Path, shallow: bool = False, tag: Optional[str
         return False
 
 
-def get_local_tag(
-    repo: Optional[Union[str, Path]] = None, abbreviate: bool = True
-) -> Union[str, None]:
+def get_local_tag(repo: Optional[Union[str, Path]] = None, abbreviate: bool = True) -> Union[str, None]:
     """
     get the most recent git version tag of a local repo
     repo Path should be in the form of : repo = "./repo/micropython"
@@ -123,6 +118,9 @@ def get_local_tags(repo: Optional[Path] = None, minver: Optional[str] = None) ->
     """
     get list of all tags of a local repo
     """
+    # Just in time import
+    from packaging.version import parse
+
     if not repo:
         repo = Path(".")
 
@@ -136,19 +134,22 @@ def get_local_tags(repo: Optional[Path] = None, minver: Optional[str] = None) ->
     return sorted(tags)
 
 
-from github.GithubException import BadCredentialsException
-
-
 @cachetools.func.ttl_cache(maxsize=16, ttl=60)  # 60 seconds
 def get_tags(repo: str, minver: Optional[str] = None) -> List[str]:
     """
     Get list of tag of a repote github repo.
     only the last -preview tag is kept
     """
+    # Just in time import
+    from github import BadCredentialsException
+    from packaging.version import parse
+
     if not repo or not isinstance(repo, str) or "/" not in repo:  # type: ignore
         return []
+
+    gh_client = config.gh_client
     try:
-        gh_repo = GH_CLIENT.get_repo(repo)
+        gh_repo = gh_client.get_repo(repo)
     except BadCredentialsException as e:
         log.error(f"Github authentication error - {e}")
         return []
@@ -179,40 +180,6 @@ def checkout_tag(tag: str, repo: Optional[Union[str, Path]] = None) -> bool:
     return True
 
 
-def sync_submodules(repo: Union[Path, str]) -> bool:
-    """
-    make sure any submodules are in sync
-    """
-    cmds = [
-        ["git", "submodule", "sync", "--quiet"],
-        # ["git", "submodule", "update", "--quiet"],
-        ["git", "submodule", "update", "--init", "lib/micropython-lib"],
-    ]
-    for cmd in cmds:
-        if result := _run_local_git(cmd, repo=repo, expect_stderr=True):
-            # actually a good result
-            log.debug(result.stderr)
-        else:
-            return False
-    checkout_arduino_lib(Path(repo))
-    return True
-
-
-def checkout_arduino_lib(mpy_path: Path):
-    """
-    Checkout the arduino-lib submodule repo if it exists
-
-    This is needed as some of the arduino boards freeze modules originationg from the arduino-lib
-    """
-    # arduino_lib_path = mpy_path / "lib/arduino-lib"
-    if (mpy_path / "lib/arduino-lib").exists():
-        cmd = ["git", "submodule", "update", "--init", "lib/arduino-lib"]
-        try:
-            result = subprocess.run(cmd, cwd=mpy_path, check=True)
-            log.info(f"checkout arduino-lib: {result.returncode}")
-        except subprocess.CalledProcessError as e:
-            log.warning("Could not check out arduino-lib, error: ", e)
-
 
 def checkout_commit(commit_hash: str, repo: Optional[Union[Path, str]] = None) -> bool:
     """
@@ -300,7 +267,7 @@ def pull(repo: Union[Path, str], branch: str = "main") -> bool:
     return result.returncode == 0
 
 
-def get_git_describe(folder: Optional[str] = None):
+def get_git_describe(folder: Optional[Union[Path, str]] = None):
     """
     Based on MicroPython makeversionhdr.py
     returns : current git tag, commits ,commit hash : "v1.19.1-841-g3446"

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/bootloader/activate.py

@@ -12,7 +12,7 @@ from .touch1200 import enter_bootloader_touch_1200bps
 
 BL_OPTIONS = {
     "stm32": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
-    "rp2": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
+    "rp2": [BootloaderMethod.MPY, BootloaderMethod.TOUCH_1200, BootloaderMethod.MANUAL],
     "samd": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
     "esp32": [BootloaderMethod.NONE],
     "esp8266": [BootloaderMethod.NONE],

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/bootloader/detect.py

@@ -1,5 +1,4 @@
-""" Detect if a board is in bootloader mode 
-"""
+"""Detect if a board is in bootloader mode"""
 
 import os
 

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/bootloader/manual.py

@@ -52,7 +52,6 @@ mcu_theme = Theme(
 
 
 def enter_bootloader_manual(mcu: MPRemoteBoard, timeout: int = 10):
-
     message: str
     if mcu.port == "rp2":
         message = f"""\

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/bootloader/touch1200.py

@@ -27,10 +27,10 @@ def enter_bootloader_touch_1200bps(mcu: MPRemoteBoard, timeout: int = 10):
 
     except serial.SerialException as e:
         log.exception(e)
-        raise MPFlashError("pySerial error: " + str(e) + "\n") from e
+        raise MPFlashError(f"pySerial error: {str(e)}") from e
     except Exception as e:
         log.exception(e)
-        raise MPFlashError("Error: " + str(e) + "\n") from e
+        raise MPFlashError(f"Error: {str(e)}") from e
 
     # be optimistic
     return True

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/cli_flash.py

@@ -92,6 +92,14 @@ from mpflash.versions import clean_version
     help="The MicroPython board ID to flash. If not specified will try to read the BOARD_ID from the connected MCU.",
     metavar="BOARD_ID or ?",
 )
+@click.option(
+    "--variant",
+    "-var",
+    "variant",  # single board
+    multiple=False,
+    help="The board VARIANT to flash or '-'. If not specified will try to read the variant from the connected MCU.",
+    metavar="VARIANT",
+)
 @click.option(
     "--cpu",
     "--chip",
@@ -102,9 +110,9 @@ from mpflash.versions import clean_version
 )
 @click.option(
     "--erase/--no-erase",
-    default=True,
+    default=False,
     show_default=True,
-    help="""Erase flash before writing new firmware. (Not supported on UF2 boards)""",
+    help="""Erase flash before writing new firmware.""",
 )
 @click.option(
     "--bootloader",
@@ -115,14 +123,21 @@ from mpflash.versions import clean_version
     show_default=True,
     help="""How to enter the (MicroPython) bootloader before flashing.""",
 )
+@click.option(
+    "--flash_mode", "-fm",
+    type=click.Choice(["keep", "qio", "qout", "dio", "dout"]),
+    default="keep",
+    show_default=True,
+    help="""Flash mode for ESP boards. (default: keep)""",
+)
 def cli_flash_board(**kwargs) -> int:
     # version to versions, board to boards
-    kwargs["versions"] = [kwargs.pop("version")] if kwargs["version"] != None else []
+    kwargs["versions"] = [kwargs.pop("version")] if kwargs["version"] is not None else []
     if kwargs["board"] is None:
         kwargs["boards"] = []
         kwargs.pop("board")
     else:
-        kwargs["boards"] = [kwargs.pop("board")]
+        kwargs["boards"] = [kwargs.pop("board")]   
 
     params = FlashParams(**kwargs)
     params.versions = list(params.versions)
@@ -141,7 +156,9 @@ def cli_flash_board(**kwargs) -> int:
     all_boards: List[MPRemoteBoard] = []
     if not params.boards:
         # nothing specified - detect connected boards
-        params.ports, params.boards, all_boards = connected_ports_boards(include=params.ports, ignore=params.ignore, bluetooth=params.bluetooth)
+        params.ports, params.boards, all_boards = connected_ports_boards(
+            include=params.ports, ignore=params.ignore, bluetooth=params.bluetooth
+        )
         if params.boards == []:
             # No MicroPython boards detected, but it could be unflashed or in bootloader mode
             # Ask for serial port and board_id to flash
@@ -171,6 +188,11 @@ def cli_flash_board(**kwargs) -> int:
         if not all_boards:
             log.trace("No boards detected yet, scanning for connected boards")
             _, _, all_boards = connected_ports_boards(include=params.ports, ignore=params.ignore)
+        # if variant id provided on the cmdline, treat is as an override
+        if params.variant:
+            for b in all_boards:
+                b.variant = params.variant if (params.variant.lower() not in {"-","none"}) else ""
+
         worklist = full_auto_worklist(
             all_boards=all_boards,
             version=params.versions[0],
@@ -199,6 +221,7 @@ def cli_flash_board(**kwargs) -> int:
         params.fw_folder,
         params.erase,
         params.bootloader,
+        flash_mode = params.flash_mode,
     ):
         log.info(f"Flashed {len(flashed)} boards")
         show_mcus(flashed, title="Updated boards after flashing")

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/cli_group.py

@@ -39,6 +39,7 @@ def cb_test(ctx, param, value):
         config.tests = value
     return value
 
+
 def cb_usb(ctx, param, value: bool):
     config.usb = bool(value)
     return value

{mpflash-1.24.6 → mpflash-1.25.0.post1}/mpflash/cli_list.py

@@ -73,15 +73,14 @@ def cli_list_mcus(serial: List[str], ignore: List[str], bluetooth: bool, as_json
     # TODO? Ask user to select a serialport if [?] is given ?
 
     conn_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
-    # ignore boards that have the [micropython-stubber] ignore flag set
-    conn_mcus = [item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))]    
+    # ignore boards that have the [mpflash] ignore flag set
+    conn_mcus = [item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))]
     if as_json:
-        # remove the path and firmware attibutes from the json output as they are always empty
-        for mcu in conn_mcus:
-            del mcu.path
-            del mcu.firmware
-        print(json.dumps([mcu.__dict__ for mcu in conn_mcus], indent=4))
-        progress = False
+        print(json.dumps([mcu.to_dict() for mcu in conn_mcus], indent=4))
+        
     if progress:
         show_mcus(conn_mcus, refresh=False)
+    for mcu in conn_mcus:
+        # reset the board so it can continue to whatever it was running before
+        mcu.run_command("reset")
     return 0 if conn_mcus else 1