ImageCipher is a Python library designed for encrypting and decrypting images, offering a secure way to handle image data through customizable cipher algorithms.
Project description
Image Cipher
ImageCipher is a Python library for encoding and decoding messages in images using steganography and optional encryption.
Installation 🚀
You can install ImageCipher using pip:
pip install imagecipher
Features ✨
- Encode text messages into images
- Decode messages from encoded images
- Optional encryption of messages before encoding
- Support for various image formats
Usage 📝
Here's a quick example of how to use ImageCipher:
from image_cipher import ImageCipher
# Create an instance of ImageCipher
cipher = ImageCipher()
# Encode a message
encoded_image_path = cipher.encode("original_image.png", "Secret message", encrypt=True)
# Decode a message
decoded_message = cipher.decode(encoded_image_path, key=cipher.key)
print(decoded_message) # Output: Secret message
API Reference 📘
ImageCipher
class
encode(image_path, message, encrypt=True)
Encodes a message into an image.
image_path
(str): The path to the input image file.message
(str): The message to be encoded.encrypt
(bool, optional): Whether to encrypt the message. Defaults to True.
Returns:
- str: The path to the output encoded image file.
decode(image_path, key=None)
Decodes a message from an encoded image.
image_path
(str): The path to the input encoded image file.key
(str, optional): The encryption key for decryption. Required if the message was encrypted.
Returns:
- str: The decoded message.
Requirements 🛠️
- Python 3.6+
- Pillow (PIL)
- cryptography
Contributing 🙌
Contributions are welcome! Please feel free to submit a Pull Request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
imagecipher-0.0.2.tar.gz
(3.6 kB
view hashes)
Built Distribution
Close
Hashes for imagecipher-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fa420cd243481c3edb48f1a3ee1ed4f512ec3f244bc3776ebb06f093b7cd6c5 |
|
MD5 | 7bdb6770c8f5150c75835813920fbf4f |
|
BLAKE2b-256 | a756e2cb18853eb30143ac85de47bc62256ae11659e982801cde8c5d53e055a4 |