huffman-algorithm 1.0.0

Python Huffman Algorithm Implementation

huffman-algorithm

Huffman algorithm is a python implementation of the huffman algorithm it's an efficient encoding algorithm for text.

✨ Key features

• Count letters

• Tree generation

• Dictionary generation

• Letter frequency calculation

• String encoding

• String decoding

• Tree visualisation

It works with python 3.12 or later

---

🔧 Installation

It should work on any python3 version after the 1.10 but it's always good to have the latest version since it will be the one I'm sure it works on :)

⚙ Using PyPi

$ pip install huffman-algorithm

📚 Usage

📕 Dictionary generation

from huffman import Huffman

dictionary = Huffman.generate_dictionary("Hello World")

# How to see the dictionary ?
print(dictionary)    # Output: {'W': '000', 'd': '001', 'e': '010', 'r': '011', 'l': '10', 'o': '110', ' ': '1110', 'H': '1111'}

🌳 Tree generation

from huffman import Huffman

tree = Huffman.generate_tree("Hello World")

# How to see the tree ?
print(tree)    # Output: Node(character=None, frequency=11, children=[Node(character=None, frequency=4, children=[...]])

🔢 Letter frequency calculation

from huffman import Huffman

frequencies = Huffman.get_letters_frequency("Hello World")

# How to see the encoded string ?
print(frequencies)    # Output: {' ': 1, 'H': 1, 'W': 1, 'd': 1, 'e': 1, 'r': 1, 'o': 2, 'l': 3}

⚙️ String encoding

from huffman import Huffman

encoded = Huffman.encode("Hello World")

# How to see the encoded string ?
print(encoded)    # Output: '11110101010110111000011001110001'

⚙️ String decoding

from huffman import Huffman

encoded = Huffman.encode("Hello World")
dictionary = Huffman.generate_dictionary("Hello World")

decoded = Huffman.decode(encoded, dictionary)

# How to see the decoded string ?
print(decoded)    # Output: 'Hello World'

🍕 Contributing

All contribution are welcomed so consider looking at the source code on GitHub

🛡 License

This project is licensed under the MIT License