Skip to main content

Image Cipher

ImageCipher is a Python library for encoding and decoding messages in images using steganography and optional encryption.
Supported python versions PEP8 License

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.

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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imagecipher-0.0.2-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file imagecipher-0.0.2.tar.gz.

File metadata

  • Download URL: imagecipher-0.0.2.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for imagecipher-0.0.2.tar.gz
Algorithm Hash digest
SHA256 c37f0ea33992d634a5f1f248ef735fdef0ff881a4d141b2621763480ca621f5b
MD5 d80c9f7e8c1ae5d0aacf4ffde5390381
BLAKE2b-256 d68fd0fcb306ad924ec28ee5d01cf8c19901f733d9451b29d7d30c38f088f98d

See more details on using hashes here.

File details

Details for the file imagecipher-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: imagecipher-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for imagecipher-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9fa420cd243481c3edb48f1a3ee1ed4f512ec3f244bc3776ebb06f093b7cd6c5
MD5 7bdb6770c8f5150c75835813920fbf4f
BLAKE2b-256 a756e2cb18853eb30143ac85de47bc62256ae11659e982801cde8c5d53e055a4

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page