Metadata-Version: 2.4
Name: pyawe_ffs
Version: 1.0.1
Summary: A generator and parser for an AWE Flash File System (FFS).
Project-URL: Documentation, https://dochub.dspconcepts.com/py/pyawe-ffs/latest/
Project-URL: Homepage, https://w.dspconcepts.com/audio-weaver
Author-email: "python@dspconcepts.com" <python@dspconcepts.com>
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: construct>=2.10.70
Requires-Dist: numpy~=2.2.4
Description-Content-Type: text/markdown

# PyAWE FFS

The Python package supports creating an AWE FFS (Flash Files System) container.

## Installation

`(venv) pip install pyawe_ffs[doc]`

## Description

This Python library provides a small programmatic interface to create an FFS file container.
These containers are used in the integration and deployment of large audio (WAV, OGG) data
to a platform which runs AWE Core. See https://documentation.dspconcepts.com/awe-core/latest-version/flash-file-system-integration-guide
for more detail.


## Usage

The package provides a script to be used on the command line.

```
(venv) awe-ffs -h
usage: awe-ffs [-h] [--version] [-v] [--show-docs] {add,list,extract} ...

Creates or parses an FFS binary file.
Version: 0.1.1

positional arguments:
  {add,list,extract}
    add               Add files to FFS Container
    list              List files in FFS Container
    extract           Extract data from FFS Container

options:
  -h, --help          show this help message and exit
  --version           Shows program version.
``` 

For programmatic access, use the API:

```python
from pyawe_ffs.FfsContainer import FfsContainer
ffs = FfsContainer()
ffs.append("my_wavedata_1.wav")
ffs.append("my_wavedata_2.wav")
ffs.save("my_ffs_buffer.bin")

```

More information can be obtained with `(venv) awe-ffs-docs` or `(venv) awe-ffs --show-docs`.


