Metadata-Version: 2.4
Name: microfs2
Version: 2.1.1
Summary: A module and utility to work with the simple filesystem on 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/microfs
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.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Education
Classifier: Topic :: Software Development :: Embedded Systems
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: AUTHORS
License-File: LICENSE
Requires-Dist: pyserial<4.0,>=3.0.1
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``/``microfs``).

In Code
^^^^^^^

Read the API documentation to learn how each of the class & functions works.

Command Line
^^^^^^^^^^^^

From the command line use the ``ufs``/``microfs`` command.

To read the built-in help::

    $ ufs --help

To read the help for a specific subcommand::

    $ ufs <subcommand> --help
