Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.43 KB

README.md

File metadata and controls

60 lines (40 loc) · 2.43 KB
Raw

text-compressor-tira

GitHub Actions codecov

Text compressor developed as a part of Data Structures & Algorithms Project Course at University of Helsinki. Both, Huffman and Lempel-Ziv-Welch algorithms, have been implemented into the compressor.

See the Implementation document for performance results.

Links to documentation

Design document

Testing document

Implementation document

Weekly Reports

Installation

You need to have python3 and poetry installed on your system

  1. Install dependencies:
poetry install
  1. Launch the program:
poetry run invoke start

User Manual

Compression

  1. Move your desired text files into the data folder under /src
  2. Follow the prompts from the program to compress it, using either Huffman or LZW!
  3. Your compressed file should now be a .bin file in the same data folder

Decompression

  1. Follow the prompts from the program to decompress a .bin file
  2. Your decompressed file should now be in the data folder with the name: {file_name}_decompressed

Commands

Check codestyle:

poetry run invoke codestyle