Metadata-Version: 2.3
Name: smartfs_tools
Version: 0.4.0
Summary: Python library and utilities for creating a dump of SmartsFS from a directory.
Project-URL: Documentation, https://github.com/shizacat/smartfs-tools
Project-URL: repository, https://github.com/shizacat/smartfs-tools
Author-email: Alexey Matveev <tippet@yandex.ru>
License: Apache License (2.0)
Keywords: dump,filesystem,filesystem dump,nuttx,smartfs
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: crc
Requires-Dist: pydantic<3,>=2
Description-Content-Type: text/markdown

# SmartFS tools

[![Coverage Status](https://coveralls.io/repos/github/shizacat/smartfs-tools/badge.svg?branch=main)](https://coveralls.io/github/shizacat/smartfs-tools?branch=main)

Python library and utilities for creating a dump of SmartsFS from a directory. The dump will be written on flash memory next.

SmartFS is a file system usage in NuttX. SmartFS stands for Sector Mapped Allocation for Really Tiny (SMART) flash.

# Links

- [SmartFS Internals](https://cwiki.apache.org/confluence/display/NUTTX/SmartFS+Internals)

# Usage

Install
```bash
pip install smartfs_tools
```

Example run:
```bash
# Veiw help
smartfs_mkdump --help

# Create dump
smartfs_mkdump \
    --base-dir ./dir_with_content \
    --out out.bin \
    --storage-size 1048576 \
    --smart-erase-block-size 4096 \
    --smart-sector-size 1024 \
    --smart-max-len-filename 16
```

# Developemnt

Run script (smartfs_mkdump):
```bash
python -m smartfs_tools.script
```
