uflash3 3.0.0__tar.gz

uflash3-3.0.0/AUTHORS

@@ -0,0 +1,6 @@
+Blackteahamburger (blackteahamburger@outlook.com)
+Nicholas H.Tollervey (ntoll@ntoll.org)
+Matt Wheeler (m@funkyhat.org)
+Tom Viner (uflash@viner.tv)
+Tom Gurion (nagasaki45@gmail.com)
+Scott Webster (ScottDWebsterNJ@gmail.com)

uflash3-3.0.0/CHANGES.rst

@@ -0,0 +1,177 @@
+Release History
+===============
+
+3.0.0
+-----
+
+* The `flash` function is rewritten, see the docstring for more information.
+* Updated to the latest version of MicroPython for micro:bit (1.1.1, 2.1.2).
+* --runtime is reintroduced to specify a custom MicroPython runtime.
+* The script is always minified by nudatus before flashing (original --minify).
+* The `uextract` command is introduced to extract Python scripts
+  from a hex file.
+* The module is changed to be a package.
+* ... And many more,
+  see function docstrings and command line help for more details.
+
+2.0.0
+-----
+
+* Update Universal Hex with MicroPython v2.0.0 (for micro:bit V2).
+
+1.2.4
+-----
+
+* Updated to the latest version of MicroPython for micro:bit (1.0.1).
+* This is the version of uflash to be used in Mu 1.0.2.
+
+1.2.3
+-----
+
+* Update to the latest version of MicroPython for micro:bit (1.0.0).
+* This is the version of uflash to be used in Mu 1.0.1.
+
+1.2.2
+-----
+
+* Update to latest version of MicroPython for micro:bit (1.0.0-rc.3).
+
+1.2.1
+-----
+
+* Update to latest version of MicroPython. Thanks to Damien George and Carlos
+  Pereira Atencio for their hard work.
+* This is the version of uflash to be used in Mu 1.0.0 (final).
+
+1.2.0
+-----
+
+* Update to latest version of MicroPython. Thanks to Damien George.
+* Add attribute called MICROPYTHON_VERSION to report the version of MicroPython
+  bundled with uflash.
+
+1.1.1
+-----
+
+* Update to the latest version of MicroPython for the BBC micro:bit -- fixes a
+  bug relating to flooding and the radio module. As always, many thanks to
+  Damien George for his work on MicroPython.
+
+1.1.0
+-----
+
+* Update to latest version of MicroPython for the BBC micro:bit
+  (many thanks to Damien George for his amazing efforts!).
+* Add a --version flag to uflash that
+  causes it to print the current version number
+  (many thanks to Lenz Grimmer for this work).
+* Allow uflash to accept the content of a script
+  as well as the path to a script
+  (many thanks to Zander Brown for this work).
+* Ensure uflash works nicely / better with external tools
+  (many thanks to Lex Robinson for this work).
+* Added copyright and license information to the start of the script.
+
+1.0.8
+-----
+
+* Refactor hex extraction to not depend on extended address record before
+  script (thanks Carlos).
+* Refactor tox tests to fix Windows related Gremlin (thanks again, Carlos).
+
+1.0.7
+-----
+
+* Watch for changes in a script. Automatically flash on save.
+
+1.0.5
+-----
+
+* Update runtime to include latest bug fixes and inclusion of input() builtin.
+* Detecting drives on Windows 10 no longer causes pop-ups in certain
+  situations.
+* Documentation updates.
+
+1.0.4
+-----
+
+* Add support for flash multiple microbits.
+
+1.0.3
+-----
+
+* Update runtime to include audio and speech modules.
+
+1.0.2
+-----
+
+* Update runtime to include the new radio module.
+
+1.0.1
+-----
+
+* Update runtime to include file system related changes.
+
+1.0.0.final.0
+-------------
+
+* Runtime updated to version 1.0 of MicroPython for the BBC micro:bit.
+
+1.0.0.beta.7
+------------
+
+* Runtime update to fix display related bug.
+
+1.0.0.beta.6
+------------
+
+* Runtime update to latest version of the DAL (swaps pins 4 and 5).
+
+1.0.0.beta.5
+------------
+
+* Runtime update to fix error reporting bug.
+
+1.0.0.beta.4
+------------
+
+* Documentation update.
+* Help text update.
+
+1.0.0.beta.3
+------------
+
+* Add ability to specify a MicroPython runtime to use.
+* Test fixes.
+
+1.0.0.beta.2
+------------
+
+* Updated to latest version of MicroPython runtime.
+
+1.0.0.beta.1
+------------
+
+* Works with Python 2.7 (thanks to @Funkyhat).
+* Updated to the latest build of MicroPython for the BBC micro:bit.
+* Minor refactoring and updates to the test suite due to MicroPython updates.
+
+0.9.17
+------
+
+* Minor code refactor.
+* Documentation update.
+
+0.9.14
+------
+
+* Feature complete.
+* Comprehensive test suite - 100% coverage.
+* Tested on Linux and Windows.
+* Documentation.
+* Access via the "uflash" command.
+
+0.0.1
+-----
+
+* Initial release. Basic functionality.

uflash3-3.0.0/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Blackteahamburger <blackteahamburger@outlook.com>
+
+Copyright (c) 2015-2018 Nicholas H.Tollervey and others.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

uflash3-3.0.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include uflash/*.hex
+include uflash/RT_LIVE_VERINFO
+include CHANGES.rst
+include README.rst
+include LICENSE
+include *.pyi py.typed

uflash3-3.0.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: uflash3
+Version: 3.0.0
+Summary: A module and utility to flash Python onto the BBC micro:bit.
+Author-email: Blackteahamburger <blackteahamburger@outlook.com>
+Maintainer-email: Blackteahamburger <blackteahamburger@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/blackteahamburger/uflash
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+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: Topic :: Education
+Classifier: Topic :: Software Development :: Embedded Systems
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: AUTHORS
+License-File: LICENSE
+Requires-Dist: microfs2>=2.0.6
+Requires-Dist: nudatus>=0.0.2
+Requires-Dist: semver
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest>=5; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Dynamic: license-file
+
+uFlash
+======
+
+A community fork of `uFlash <https://github.com/ntoll/uflash>`_.
+
+A utility for flashing the BBC micro:bit with Python scripts and the
+MicroPython runtime. You pronounce the name of this utility "micro-flash". ;-)
+
+It provides three services:
+
+1. A library of functions to programatically create a hex file and
+   flash it onto a BBC micro:bit.
+2. A command line utility called `uflash` that will flash Python scripts
+   onto a BBC micro:bit.
+3. A command line utility called `uextract` that will extract
+   Python scripts from a hex file created by uFlash.
+
+Several essential operations are implemented:
+
+* Encode Python into the hex format.
+* Embed the resulting hexified Python into the MicroPython runtime hex.
+* Extract an encoded Python script from a MicroPython hex file.
+* Discover the connected micro:bit.
+* Copy the resulting hex onto the micro:bit, thus flashing the device.
+* Specify the MicroPython runtime hex in which to embed your Python code.
+
+Installation
+------------
+
+To install simply type::
+
+    $ pip install uflash3
+
+**NB:** You must use a USB *data* cable to connect the micro:bit to your
+computer (some cables are power only). You're in good shape if, when plugged
+in, the micro:bit appears as a USB storage device on your file system.
+
+Linux users: For uflash to work you must ensure the micro:bit is mounted as a
+USB storage device. Usually this is done automatically. If not you've probably
+configured automounting to be off. If that's the case, we assume you
+have the technical knowledge to mount the device yourself or to install the
+required kernel modules if they're missing. Default installs of popular Linux
+distros "should just work" (tm) out of the box given a default install.
+
+Command Usage
+-------------
+
+To read help simply type::
+
+    $ uflash --help
+
+or::
+
+    $ uextract --help
+
+Development
+-----------
+
+The source code is hosted in GitHub. Please feel free to fork the repository.
+Assuming you have Git installed you can download the code from the canonical
+repository with the following command::
+
+    $ git clone https://github.com/blackteahamburger/uflash.git
+
+To locally install your development version of the module into a virtualenv,
+run the following command::
+
+    $ pip install -e ".[dev]"
+
+This also ensures that you have the correct dependencies for development.
+
+There is a Makefile that helps with most of the common workflows
+associated with development.

uflash3-3.0.0/README.rst

@@ -0,0 +1,73 @@
+uFlash
+======
+
+A community fork of `uFlash <https://github.com/ntoll/uflash>`_.
+
+A utility for flashing the BBC micro:bit with Python scripts and the
+MicroPython runtime. You pronounce the name of this utility "micro-flash". ;-)
+
+It provides three services:
+
+1. A library of functions to programatically create a hex file and
+   flash it onto a BBC micro:bit.
+2. A command line utility called `uflash` that will flash Python scripts
+   onto a BBC micro:bit.
+3. A command line utility called `uextract` that will extract
+   Python scripts from a hex file created by uFlash.
+
+Several essential operations are implemented:
+
+* Encode Python into the hex format.
+* Embed the resulting hexified Python into the MicroPython runtime hex.
+* Extract an encoded Python script from a MicroPython hex file.
+* Discover the connected micro:bit.
+* Copy the resulting hex onto the micro:bit, thus flashing the device.
+* Specify the MicroPython runtime hex in which to embed your Python code.
+
+Installation
+------------
+
+To install simply type::
+
+    $ pip install uflash3
+
+**NB:** You must use a USB *data* cable to connect the micro:bit to your
+computer (some cables are power only). You're in good shape if, when plugged
+in, the micro:bit appears as a USB storage device on your file system.
+
+Linux users: For uflash to work you must ensure the micro:bit is mounted as a
+USB storage device. Usually this is done automatically. If not you've probably
+configured automounting to be off. If that's the case, we assume you
+have the technical knowledge to mount the device yourself or to install the
+required kernel modules if they're missing. Default installs of popular Linux
+distros "should just work" (tm) out of the box given a default install.
+
+Command Usage
+-------------
+
+To read help simply type::
+
+    $ uflash --help
+
+or::
+
+    $ uextract --help
+
+Development
+-----------
+
+The source code is hosted in GitHub. Please feel free to fork the repository.
+Assuming you have Git installed you can download the code from the canonical
+repository with the following command::
+
+    $ git clone https://github.com/blackteahamburger/uflash.git
+
+To locally install your development version of the module into a virtualenv,
+run the following command::
+
+    $ pip install -e ".[dev]"
+
+This also ensures that you have the correct dependencies for development.
+
+There is a Makefile that helps with most of the common workflows
+associated with development.

uflash3-3.0.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+    build-backend = "setuptools.build_meta"
+    requires      = ["setuptools>=77.0.3"]
+
+[project]
+    authors = [
+        { name = "Blackteahamburger", email = "blackteahamburger@outlook.com" },
+    ]
+    classifiers = [
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Console",
+        "Intended Audience :: Developers",
+        "Intended Audience :: Education",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Topic :: Education",
+        "Topic :: Software Development :: Embedded Systems",
+    ]
+    dependencies = ["microfs2>=2.0.6", "nudatus>=0.0.2", "semver"]
+    description = "A module and utility to flash Python onto the BBC micro:bit."
+    license = "MIT"
+    license-files = ["AUTHORS", "LICENSE"]
+    maintainers = [
+        { name = "Blackteahamburger", email = "blackteahamburger@outlook.com" },
+    ]
+    name = "uflash3"
+    readme = "README.rst"
+    requires-python = ">=3.10"
+    version = "3.0.0"
+
+    [project.optional-dependencies]
+        dev = ["coverage", "pytest-cov", "pytest>=5", "ruff", "sphinx"]
+
+    [project.urls]
+        Homepage = "https://github.com/blackteahamburger/uflash"
+
+    [project.scripts]
+        uextract = "uflash.uextract:uextract"
+        uflash   = "uflash.main:main"
+
+[tool.coverage.run]
+    omit = ["uflash/__main__.py"]

uflash3-3.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+