https://github.com/ntoll/microfs

A simple command line tool and module for interacting with the simple filesystem on the BBC micro:bit.
https://github.com/ntoll/microfs

Last synced: 18 days ago
JSON representation

A simple command line tool and module for interacting with the simple filesystem on the BBC micro:bit.

• Host: GitHub
• URL: https://github.com/ntoll/microfs
• Owner: ntoll
• License: mit
• Created: 2016-05-28T21:43:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-05-29T18:40:32.000Z (over 1 year ago)
• Last Synced: 2024-10-11T22:45:10.544Z (about 1 month ago)
• Language: Python
• Size: 121 KB
• Stars: 39
• Watchers: 9
• Forks: 18
• Open Issues: 14
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-microbit-zh - MicroFs - 一个简单的命令行工具/模块,用于与micro:bit中的受限文件系统(由MicroPython提供)交互. (编程 / Python)

README

        
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 microfs

...and the package will download from PyPI. If you wish to upgrade to the

latest version, use the following command::

    $ pip install --no-cache --upgrade microfs

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 import ls, rm, put, get, get_serial

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

List the files on the device::

    $ ufs ls

You can also specify a delimiter to separte 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 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

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/ntoll/microfs.git

Ensure you have the correct dependencies for development installed by creating

a virtualenv and running::

    $ pip install -r requirements.txt

To locally install your development version of the module into a virtualenv,

run the following command::

    $ python setup.py develop

There is a Makefile that helps with most of the common workflows associated

with development. Typing "make" on its own will list the options thus::

    $make

    There is no default Makefile target right now. Try:

    make clean - reset the project and remove auto-generated assets.

    make pyflakes - run the PyFlakes code checker.

    make pep8 - run the PEP8 style checker.

    make test - run the test suite.

    make coverage - view a report on test coverage.

    make check - run all the checkers and tests.

    make package - create a deployable package for the project.

    make publish - publish the project to PyPI.

    make docs - run sphinx to create project documentation.