Metadata-Version: 2.1
Name: littlefs-tools
Version: 1.0.1
Summary: Python package to create littleFS filesystem image binaries
Home-page: https://github.com/vppillai/littlefs_tools
Author: Vysakh P Pillai
Author-email: vysakhpillai@embeddedinn.xyz
License: MIT
Description: # littlefs_tools
        
        ![](https://github.com/vppillai/littlefs_tools/workflows/Build_Tests/badge.svg)
        
        Tools create, view and extract [littleFS](https://github.com/littlefs-project/littlefs) filesystem images.
        
        Though distributed as a python module, these tools are intended to be executed as a command-line tool. Consequently, the code is written into a single python file without classes. The Invocation commands are provided below.
        
        *Attribution*: `littlefs_tools` are built on top of [littlefs-python](https://github.com/jrast/littlefs-python). To use littlefs functionality within your python code, please use `littlefs-python` directly.
        
        ## Installation
        
        ```bash
        pip install littlefs_tools
        ```
        
        ## Usage
        
        ### littlefs_create
        
        Tool to create a littleFS filesystem binary image.
        
        ```bash
        usage: littlefs_create [-h] [-b BLOCKSIZE] [-c BLOCKCOUNT] [-i IMAGE] [-v] -s SOURCE
        
        Tool to generate lfs images from a source folder
        
        optional arguments:
          -h, --help            show this help message and exit
          -b BLOCKSIZE, --block_size BLOCKSIZE
                                block size of the LFS image (defaults to 4096)
          -c BLOCKCOUNT, --block_count BLOCKCOUNT
                                block Count of the LFS image (defaults to 64)
          -i IMAGE, --image IMAGE
                                image file name
          -v, --verbose         Verbose
        
        required arguments:
          -s SOURCE, --source SOURCE
                                source path
        ```
        
        ### littlefs_list
        
        Tool to list contents of a littleFS filesystem image as a tree.
        
        ```bash
        usage: littlefs_list [-h] [-b BLOCKSIZE] [-c BLOCKCOUNT] [-v] -i IMAGE
        
        Tool to list files in a littlefs file image
        
        optional arguments:
          -h, --help            show this help message and exit
          -b BLOCKSIZE, --block_size BLOCKSIZE
                                block size of the LFS image (defaults to 4096)
          -c BLOCKCOUNT, --block_count BLOCKCOUNT
                                block Count of the LFS image (defaults to 64)
          -v, --verbose         Verbose
        
        required arguments:
          -i IMAGE, --image IMAGE
                                image file name
        ```
        
        ### littlefs_extract
        
        Tool to extract contents of a littleFS filesystem image to a destination folder.
        
        ```bash
        usage: littlefs_extract [-h] [-b BLOCKSIZE] [-c BLOCKCOUNT] [-f] [-v] -i IMAGE -d DESTINATION
        
        Tool to extract files from a littlefs file image
        
        optional arguments:
          -h, --help            show this help message and exit
          -b BLOCKSIZE, --block_size BLOCKSIZE
                                block size of the LFS image (defaults to 4096)
          -c BLOCKCOUNT, --block_count BLOCKCOUNT
                                block Count of the LFS image (defaults to 64)
          -f, --force           Force extract even if destination folder is not empty
          -v, --verbose         Verbose
        
        required arguments:
          -i IMAGE, --image IMAGE
                                image file name
          -d DESTINATION, --destination DESTINATION
                                destination directory to extract the contents into
        ```
        
        ## Building the package locally
        
        The tools package can be built locally using the following command:
        
        ```bash
        python setup.py bdist_wheel --universal
        ```
        
        And then installed with 
        
        ```bash
        pip install dist/littlefs_tools-1.0.0-py2.py3-none-any.whl  --force
        ```
        
        > Note: The wheel package must match the version of the package. The version of the package is determined by the version of the package in the `setup.py` file.
        
        Source distribution is created with the following command:
        
        ```bash
        python setup.py sdist
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Filesystems
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
