Skip to content

Akashtyagi/Hencoder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hencoder

forthebadge made-with-python

Python GitHub release Build Status Contributions welcome


Hencoder is a simple encoder based on greedy algorithim Huffman encoding.

pip install Hencoder

This package can be used to:

  • Encode/Decode any given text
  • Encode/Decode any given file.

This file can be

  • Any plain text file.
  • Source code along with indentations.
  • Any other text that is readable by python.

Hencoder

What's Great about Hencoder ? 🌟

Hencoder makes sure that nobody else can decode your text other than you. 🦸

Hencoder provides a feature to encode your input using a secret key.

This secret key ensures that no-one else can decode your encoded text until they know the key used for encoding the text.

This secret key gets added to your original text, therefore correct decoding is only possible when the user enters the same key that was used while encoding.

This key can be any value in range of key = 1-100 .

Geek fact:

You can super encode your already encoded file with another key to make it even more difficult for someone to crack it.

Key

How to Use Hencoder ? 📖

It's as smooth as butter.

  • Encoding/Decoding can be done in 2 ways:
    1. Encoding/Decoding a text
    2. Encoding/Decoding a file
Hencoder.encode(text="", key=0, path=None, inplace=False)
Hencoder.decode(text="", key=0, path=None, inplace=False)

* text: Text that needs to be encoded.
		{Default=''} {Optional}

* key: Encoding: Secure your data by adding a secret value.
	   Decoding: When decoding, you need to enter same key.
	    {Default=0}  {Optional}

* path: If want to convert any file, enter its complete path.
		{Default=None} (Optional)

* inplace: When coverting file, modify file inplace. 
		{Default= False} (Optional)

File Encoding