A basic text file compression algorithm using binary trees in Python3. This is an individual assignment. Write your solution and do not work in a pair/group on this program. I'll be using Source Code Plagiarism Checker.

# To compress a file
huffman.py -e story.txt -o story.huff
# To extract a file
huffman.py -d story.huff -o story_.txt

• Options
  • -e : followed by the text file to compress.
  • -d : followed by the compressed file to extract.
  • -o : followed by the filename to write the content.

• Encode the input file with the algorithm and write the encoded data to the file along with all the information, to decompress a file. Possibly one can maintain a header section to save all the encoding information. The encoded file can have an extension *.huff.

• Read the encoding section to get the information required to decode the file and write the decoded data to the file. The decoded file should be the same as the input file.

• Make use of the script diff.sh which gives the detailed differences between the input and the decoded file, which can be helpful in the long run (one can avoid manual inspections) and gives the idea about loss of data.

  ./diff.sh <INPUT_FILE> <DECODED_FILE>

• Create at least 3 tests (covering basic/edge cases) inside the test script to test all functions or modules.

The code will be evaluated based on the design, readability, performance, accuracy, and much more. The best code will be merged into the master after evaluation. Submit Pull Request. I'll evaluate the code as soon as possible. If you have got any doubts, create an issue in the repo, so that others can also refer to it. Watch the recorded session in case if you have missed it.

Before submitting PR, make sure you run the below scripts. These scripts run all the test and evaluate your code.

# run all the tests in test.py
./run_test.sh
# evaluate your code
./run.sh

Follow the below references completely.

• Standford assignment on Huffman
• How to send PR
• How to write perfect PR