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.
Metadata
Release files for imagecipher 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| imagecipher-0.0.2.tar.gz | 3.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| imagecipher-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.1 kB
Release files / imagecipher-0.0.2.tar.gz
| Download URL | imagecipher-0.0.2.tar.gz |
|---|---|
| Size | 3.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c37f0ea33992d634a5f1f248ef735fdef0ff881a4d141b2621763480ca621f5b
|
|
BLAKE2b-256 checksum How to use checksums |
d68fd0fcb306ad924ec28ee5d01cf8c19901f733d9451b29d7d30c38f088f98d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.8.10
|
Release files / imagecipher-0.0.2-py3-none-any.whl
| Download URL | imagecipher-0.0.2-py3-none-any.whl |
|---|---|
| Size | 4.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9fa420cd243481c3edb48f1a3ee1ed4f512ec3f244bc3776ebb06f093b7cd6c5
|
|
BLAKE2b-256 checksum How to use checksums |
a756e2cb18853eb30143ac85de47bc62256ae11659e982801cde8c5d53e055a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.8.10
|