{"id":25264331,"url":"https://github.com/samadpls/imagecipher","last_synced_at":"2025-07-01T18:04:19.226Z","repository":{"id":248186988,"uuid":"827991841","full_name":"samadpls/ImageCipher","owner":"samadpls","description":"ImageCipher is a Python library for encoding and decoding messages in images using steganography and optional encryption","archived":false,"fork":false,"pushed_at":"2024-11-06T19:01:01.000Z","size":3012,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-25T05:53:52.213Z","etag":null,"topics":["cryptography","encryption-library","opensource","pil","python-library","steganography-library"],"latest_commit_sha":null,"homepage":"https://huggingface.co/spaces/samadpls/ImageCipher","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samadpls.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-12T20:42:48.000Z","updated_at":"2024-07-28T19:03:20.000Z","dependencies_parsed_at":"2025-02-12T07:43:37.893Z","dependency_job_id":"bcaf7cf2-0dd9-4537-a454-3a835dd4d6c5","html_url":"https://github.com/samadpls/ImageCipher","commit_stats":null,"previous_names":["samadpls/imagecipherlib","samadpls/imagecipher"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/samadpls/ImageCipher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samadpls%2FImageCipher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samadpls%2FImageCipher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samadpls%2FImageCipher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samadpls%2FImageCipher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samadpls","download_url":"https://codeload.github.com/samadpls/ImageCipher/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samadpls%2FImageCipher/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263013703,"owners_count":23399812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cryptography","encryption-library","opensource","pil","python-library","steganography-library"],"created_at":"2025-02-12T07:36:31.707Z","updated_at":"2025-07-01T18:04:19.194Z","avatar_url":"https://github.com/samadpls.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cimg align='right' src=\"https://github.com/user-attachments/assets/65d8da5a-3af5-45a8-b409-09dfd9205bbd\" height=350px\u003e\n\n\n\n# Image Cipher\n\nImageCipher is a Python library for encoding and decoding messages in images using steganography and optional encryption.  \n![Supported python versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)\n[![PEP8](https://img.shields.io/badge/code%20style-pep8-black.svg)](https://www.python.org/dev/peps/pep-0008/)\n[![License](https://img.shields.io/badge/License-MIT%202.0-blue.svg)](LICENSE)\n[![Run Pytest](https://github.com/samadpls/ImageCipher/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/samadpls/ImageCipher/actions/workflows/pytest.yml)\n\u003cimg src='https://img.shields.io/github/stars/samadpls/ImageCipher?color=red\u0026label=stars\u0026logoColor=black\u0026style=social'\u003e\n## Installation 🚀\n\nYou can install ImageCipher using pip:\n\n```\npip install imagecipher\n```\n\n## Features ✨\n\n- Encode text messages into images\n- Decode messages from encoded images\n- Optional encryption of messages before encoding\n- Support for various image formats\n\n## Usage 📝\n\nHere's a quick example of how to use ImageCipher:\n\n```python\nfrom image_cipher import ImageCipher\n\n# Create an instance of ImageCipher\ncipher = ImageCipher()\n\n# Encode a message\nencoded_image_path = cipher.encode(\"original_image.png\", \"Secret message\", encrypt=True)\n\n# Decode a message\ndecoded_message = cipher.decode(encoded_image_path, key=cipher.key)\n\nprint(decoded_message)  # Output: Secret message\n```\n\n## API Reference 📘\n\n### `ImageCipher` class\n\n#### `encode(image_path, message, encrypt=True)`\n\nEncodes a message into an image.\n\n- `image_path` (str): The path to the input image file.\n- `message` (str): The message to be encoded.\n- `encrypt` (bool, optional): Whether to encrypt the message. Defaults to True.\n\nReturns:\n- str: The path to the output encoded image file.\n\n#### `decode(image_path, key=None)`\n\nDecodes a message from an encoded image.\n\n- `image_path` (str): The path to the input encoded image file.\n- `key` (str, optional): The encryption key for decryption. Required if the message was encrypted.\n\nReturns:\n- str: The decoded message.\n\n## Requirements 🛠️\n\n- Python 3.6+\n- Pillow (PIL)\n- cryptography\n\n## Contributing 🙌\n\nContributions are welcome! Please feel free to submit a Pull Request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamadpls%2Fimagecipher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamadpls%2Fimagecipher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamadpls%2Fimagecipher/lists"}