Metadata-Version: 2.1
Name: huffman-project
Version: 0.2.0
Summary: huffman-project package to reduce data based on character frequency
Home-page: https://github.com/M4verickFr/huffman-project
Author: Maverick Perrollaz
Author-email: maverick.perrollaz@pm.me
License: Apache 2 License
Description: # 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.
        
        ## Production Installation
        
        Clone the repo:
        
        ```bash
        pip3 install huffman-project
        ```
        
        ## Usage
        
        Import huffman package.
        
        ```python
        from huffman import Huffman 
        ```
        
        Then use methods compress or comrpessFile. 
        
        ```python
        h = Huffman()
        
        h.compress("Bonjour!!")
        h.compressFile(pathFile)
        ```
        
        For examples of use, see the test folder.
        
        ## Development Installation
        
        Clone the repo:
        
        ```bash
        git clone git@github.com:M4verickFr/huffman-project.git
        ```
        
        Then install the dependencies and install the package:
        
        ```bash
        pip3 install -r requirements.txt
        pip3 install -e . 
        ```
        
        ## Unit Test Case
        
        You can run Unit Test Case with
        
        ```bash
        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.
Platform: UNKNOWN
Description-Content-Type: text/markdown
