microfs2 2.0.0__tar.gz

microfs2-2.0.0/AUTHORS

@@ -0,0 +1,3 @@
+Blackteahamburger (blackteahamburger@outlook.com)
+Nicholas H.Tollervey (ntoll@ntoll.org)
+Carlos Pereira Atencio (https://github.com/carlosperate)

microfs2-2.0.0/CHANGES.rst

@@ -0,0 +1,153 @@
+Release History
+===============
+
+2.0.0
+-----
+
+* When reading a file, byte strings can use single and double quotes.
+* The module is changed to be a package.
+* Support for `--timeout` command line parameter.
+  The default value of timeout is adjusted to 10.
+* Support for `--version` flag.
+* Support for `cp`, `mv`, `cat`, `du`, and `version` subcommands.
+* **API CHANGE**: New `MicroBitSerial` class to manage serial connections.
+  Related functions have become methods of this class.
+* **API CHANGE**: Functions now accept `MicroBitSerial` instances instead
+  of raw `serial.Serial` objects.
+* **API CHANGE**: Functions are not accepting None as a serial argument.
+  A `MicroBitSerial` instance must be provided.
+  Use `MicroBitSerial.get_serial()` to get a serial connection
+  of the detected micro:bit.
+* **API CHANGE**: The order of function arguments has changed.
+* **API CHANGE**: The `find_microbit` function now returns the port
+  (previously returned a tuple of (port string, serial number)).
+* **API CHANGE**: Exception handling is now more granular. Introduced
+  `MicroBitError`, `MicroBitIOError`, and `MicroBitNotFoundError` for
+  micro:bit-specific errors, replacing generic `IOError` usage.
+* **API CHANGE**: The `ls`, `rm`, `put`, and `get` functions now return None
+  instead of True.
+* **API CHANGE**: The `put` and `get` functions now use `pathlib.Path` objects
+  for local file arguments (`filename` and `target`), instead of plain strings.
+* **API CHANGE**: The `execute` function now returns only the stdout bytes
+  (previously returned a tuple of (stdout, stderr)). Errors are now raised as
+  exceptions instead of being returned.
+* **API CHANGE**: The `put` and `get` command-line interfaces now require
+  `pathlib.Path` objects for file arguments.
+* ... See the file docstring and function docstrings for more details.
+
+1.4.5
+-----
+
+* Updated version of PySerial used by the script.
+* Non-zero exit codes when things go wrong.
+* Execute as ``__main__``.
+* Black formatting updates.
+* Thanks to @carlosperate for these updates.
+
+1.4.4
+-----
+
+* New feature. Thanks to @makinteract, it is possible to add an optional
+  delimeter for the ``ls`` command. Please see PR #28 for more details.
+
+1.4.3
+-----
+
+* Bug fix. See commentary in issue #22. Thanks again to alexandros769.
+
+1.4.2
+-----
+
+* Update getting of data from micro:bit device to deal with control characters
+  found within the file on the device. Thanks to Damien George for the fix and
+  to GitHub user alexandros769 for reporting it.
+
+1.4.1
+-----
+
+* Clamp PySerial version to use with microfs to a version known to work.
+
+1.4.0
+-----
+
+* Updated and changed the ``get`` functionality to work on a wider range of
+  supported boards. Many thanks to Carlos Pereira Atencio for putting in the
+  effort to make this happen.
+
+1.3.1
+-----
+
+* Fix bug in version parsing that was mangling the ``machine`` attribute.
+
+1.3.0
+-----
+
+* Added a new function (not available via the command line) to get the version
+  of MicroPython on the device.
+* **API CHANGE** The find_microbit function now returns a tuple with position 0
+  as the port and position 1 as the serial number of the connected device.
+
+1.2.3
+-----
+
+* Extensive debugging and a fix by Carlos Pereira Atencio to ensure that serial
+  connections are opened, closed and made ready for microfs related commands in
+  a robust manner.
+
+1.2.2
+-----
+
+* The get and put commands optionally take a further argument to specify the
+  name of the target file.
+
+1.2.1
+-----
+
+* Made implicit string concatenation explicit.
+
+1.2.0
+-----
+
+* **API CHANGE** the serial object passed into command functions is optional.
+* **API CHANGE** call signature changes on command functions.
+
+1.1.2
+-----
+
+* Allow external modules to use built-in device detection and connection.
+
+1.1.1
+-----
+
+* Unlink command logic from device detection and serial connection.
+
+1.1.0
+-----
+
+* Fix broken 'put' and 'get' commands to work with arbitrary file sizes.
+* Fix error when working with binary data.
+* Update execute function to work with lists of multiple commands.
+* Minor refactor to extract raw mode related code.
+* Updated tests to keep coverage at 100% on both Python 2 and Python 3.
+
+1.0.2
+-----
+
+* Remove spare print call.
+
+1.0.1
+-----
+
+* Fix broken setup.
+
+1.0.0
+-----
+
+* Full implementation of all the expected features.
+* 100% test coverage.
+* Comprehensive documentation.
+
+0.0.1
+-----
+
+* Initial release. Basic functionality.

microfs2-2.0.0/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Blackteahamburger <blackteahamburger@outlook.com>
+
+Copyright (c) 2016 Nicholas H.Tollervey
+
+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.

microfs2-2.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include CHANGES.rst
+include README.rst
+include LICENSE
+include *.pyi py.typed

microfs2-2.0.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: microfs2
+Version: 2.0.0
+Summary: A module and utility to work with the simple filesystem on the BBC micro:bit
+Author: Carlos Pereira Atencio
+Author-email: Blackteahamburger <blackteahamburger@outlook.com>, "Nicholas H.Tollervey" <ntoll@ntoll.org>
+Maintainer-email: Blackteahamburger <blackteahamburger@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/blackteahamburger/microfs
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+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.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: pyserial<4.0,>=3.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=5; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+MicroFS
+=======
+
+A community fork of `MicroFS <https://github.com/ntoll/microfs>`_.
+
+A simple command line tool and module for interacting with the limited
+file system provided by MicroPython on the BBC micro:bit.
+
+Installation
+------------
+
+To install simply type::
+
+    $ pip install microfs2
+
+Usage
+-----
+
+There are two ways to use microfs - as a module in your Python code or as a
+stand-alone command to use from your shell (``ufs``).
+
+In Code
+^^^^^^^
+
+In your Python script import the required functions like this::
+
+    from microfs.lib import MicroBitSerial, ls, rm, cp, mv, cat, du, put, get, version
+
+Read the API documentation below to learn how each of the functions works.
+
+Command Line
+^^^^^^^^^^^^
+
+From the command line (but not the Python shell) use the "ufs" ("u" = micro)
+command.
+
+To read the built-in help::
+
+    $ ufs --help
+
+To see the version of microfs::
+
+    $ ufs --version
+
+To set the device timeout (default is 10 seconds)::
+
+    $ ufs --timeout 3 command
+
+List the files on the device::
+
+    $ ufs ls
+
+You can also specify a delimiter to separate file names displayed on the output
+(default is whitespace ' ')::
+
+    # use ';' as a delimiter
+    $ ufs ls ';'
+
+Delete a file on the device::
+
+    $ ufs rm foo.txt
+
+Copy a file from one location to another on the device::
+
+    $ ufs cp foo.txt bar.txt
+
+Move a file from one location to another on the device::
+
+    $ ufs mv foo.txt bar.txt
+
+Display the contents of a file on the device::
+
+    $ ufs cat foo.txt
+
+Get the size of a file on the device in bytes::
+
+    $ ufs du foo.txt
+
+Copy a file onto the device::
+
+    $ ufs put path/to/local.txt
+
+Get a file from the device::
+
+    $ ufs get remote.txt
+
+The ``put`` and ``get`` commands optionally take a further argument to specify
+the name of the target file::
+
+    $ ufs put /path/to/local.txt remote.txt
+    $ ufs get remote.txt local.txt
+
+Get version information for MicroPython running on the device::
+
+    $ ufs version
+
+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/microfs.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.

microfs2-2.0.0/README.rst

@@ -0,0 +1,114 @@
+MicroFS
+=======
+
+A community fork of `MicroFS <https://github.com/ntoll/microfs>`_.
+
+A simple command line tool and module for interacting with the limited
+file system provided by MicroPython on the BBC micro:bit.
+
+Installation
+------------
+
+To install simply type::
+
+    $ pip install microfs2
+
+Usage
+-----
+
+There are two ways to use microfs - as a module in your Python code or as a
+stand-alone command to use from your shell (``ufs``).
+
+In Code
+^^^^^^^
+
+In your Python script import the required functions like this::
+
+    from microfs.lib import MicroBitSerial, ls, rm, cp, mv, cat, du, put, get, version
+
+Read the API documentation below to learn how each of the functions works.
+
+Command Line
+^^^^^^^^^^^^
+
+From the command line (but not the Python shell) use the "ufs" ("u" = micro)
+command.
+
+To read the built-in help::
+
+    $ ufs --help
+
+To see the version of microfs::
+
+    $ ufs --version
+
+To set the device timeout (default is 10 seconds)::
+
+    $ ufs --timeout 3 command
+
+List the files on the device::
+
+    $ ufs ls
+
+You can also specify a delimiter to separate file names displayed on the output
+(default is whitespace ' ')::
+
+    # use ';' as a delimiter
+    $ ufs ls ';'
+
+Delete a file on the device::
+
+    $ ufs rm foo.txt
+
+Copy a file from one location to another on the device::
+
+    $ ufs cp foo.txt bar.txt
+
+Move a file from one location to another on the device::
+
+    $ ufs mv foo.txt bar.txt
+
+Display the contents of a file on the device::
+
+    $ ufs cat foo.txt
+
+Get the size of a file on the device in bytes::
+
+    $ ufs du foo.txt
+
+Copy a file onto the device::
+
+    $ ufs put path/to/local.txt
+
+Get a file from the device::
+
+    $ ufs get remote.txt
+
+The ``put`` and ``get`` commands optionally take a further argument to specify
+the name of the target file::
+
+    $ ufs put /path/to/local.txt remote.txt
+    $ ufs get remote.txt local.txt
+
+Get version information for MicroPython running on the device::
+
+    $ ufs version
+
+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/microfs.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.

microfs2-2.0.0/microfs/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (c) 2025 Blackteahamburger <blackteahamburger@outlook.com>
+#
+# See the LICENSE file for more information.
+"""Functions for file system operations on the BBC micro:bit."""
+
+from microfs.lib import *

microfs2-2.0.0/microfs/__init__.pyi

@@ -0,0 +1,2 @@
+# Copyright (c) 2025 Blackteahamburger <blackteahamburger@outlook.com>
+from microfs.lib import *

microfs2-2.0.0/microfs/__main__.py

@@ -0,0 +1,9 @@
+# Copyright (c) 2025 Blackteahamburger <blackteahamburger@outlook.com>
+#
+# See the LICENSE file for more information.
+"""Entry point for the command line tool 'ufs'."""
+
+from microfs.main import main
+
+if __name__ == "__main__":
+    main()