huffman-project

A python package to compress data based on character frequency

This repository contains files for huffman package and test files for it in tests/ directory.

Installation instructions

Clone the repo:

pip3 install huffman-project

Installation instructions (dev)

Clone the repo:

git clone git@github.com:M4verickFr/huffman-project.git

Then install the dependencies and install the package:

pip3 install -r requirements.txt
pip3 install -e . 

Usage

Import huffman package.

from huffman import Huffman 

Then use methods compress or comrpessFile.

h = Huffman()

h.compress("Bonjour!!")
h.compressFile(pathFile)

For examples of use, see the test folder.

Unit Test Case

You can run Unit Test Case with

python3 -m unittest tests/HuffmanTestCase.py
python3 -m unittest tests/TreeTestCase.py

All tests must be passed

License

This project is under the Apache 2.0 License.