https://github.com/w-kuipers/fmm-directory-compressor

A package to compress directory structures into a simple .FSA file
https://github.com/w-kuipers/fmm-directory-compressor

compression cpp directory filesystem python3 structure zip

Last synced: about 1 month ago
JSON representation

A package to compress directory structures into a simple .FSA file

• Host: GitHub
• URL: https://github.com/w-kuipers/fmm-directory-compressor
• Owner: w-kuipers
• License: gpl-3.0
• Created: 2022-01-29T16:13:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T09:12:42.000Z (over 3 years ago)
• Last Synced: 2026-05-05T23:06:54.666Z (about 2 months ago)
• Topics: compression, cpp, directory, filesystem, python3, structure, zip
• Language: C++
• Homepage:
• Size: 12.9 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# FMM Directory Compressor

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![PyPI release](https://img.shields.io/pypi/v/fmmpy-directory-compressor)](https://pypi.org/project/fmmpy-directory-compressor/)

Compress a directory into a single .FSA file.

## Installation

### Linux

#### Debian/Ubuntu

The project has not yet been published to any APT repository, but a .deb build is provided [here](https://github.com/w-kuipers/fmm-directory-compressor/releases/download/v0.1.0/fmm-directory-compressor_0.1.0-1_amd64.deb).

#### Windows

Windows installer is provided [here](https://github.com/w-kuipers/fmm-directory-compressor/releases/download/v0.1.0/fmm_directory_compressor_v0.1.0-beta_x64-windows_installer.exe).

The installer does not automatically it to the system environment path.

### Python API

    pip install fmmpy-directory-compressor

    

 Note the `pip` refers to the Python 3 package manager. In environment where Python 2 is also available the correct command may be `pip3`.

## Usage

### CLI

#### Compress directory

    fmm-directory-compressor compress-directory path/to/src path/to/dst

You'll be asked to provide a filename. A .fsa file will be generated.

If you are using windows, the compression might fail when your source directory contains paths that are longer than 260 characters. These file paths can be ignored with the `--skip-long-paths` flag, but with this method these files/directories wont be present in the compressed file. 

#### Decompress directory

    fmm-directory-compressor decompress-directory path/to/file.fsa path/to/dst

You'll be asked to provide a root directory name. The directory structure will be rebuild.

### Python API

The python wrapper yields the same functionality as the CLI application. Just include the library and you're ready to go.

    import fmm_directory_compressor

    ## Compress directory

    fmm_directory_compressor.compress_directory("path/to/src", "yourfilename", "path/to/dst")

    ## Decompress directory

    fmm_directory_compressor.decompress_directory("root-directory-name", "path/to/yourfile.fsa", "path/to/dst")

## Support

If you found a problem with the software, please [create an issue](https://github.com/w-kuipers/fmm-directory-compressor/issues) on GitHub.

## Maintainer

This project is maintained by [Wibo Kuipers](https://github.com/w-kuipers).

The source has been setup to work with Linux and Windows. Mac OS has not been tested yet.