Skip to content

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

License

Notifications You must be signed in to change notification settings

w-kuipers/fmm-directory-compressor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FMM Directory Compressor

License: GPL v3 PyPI release

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.

Windows

Windows installer is provided here. 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 on GitHub.

Maintainer

This project is maintained by Wibo Kuipers.

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