Metadata-Version: 2.1
Name: Treasure-Image
Version: 1.0.0
Summary: hide data(strings, images, files, scripts etc) into image, make gifs, covert images and files etc
Home-page: https://github.com/FatinShadab/TRREASURE_IMAGE
Author: Fatin Shadab
Author-email: fatinshadab123@gmail.com
License: MIT
Description: 
        # TRREASURE_IMAGE
        > TRREASURE_IMAGE is a python third-party library  with Command-Line Interface[cli] feature.
        
        
        
        ## Table of Contents
        * [General Info](#general-information)
        * [Python library Used](#Python-library-used)
        * [Usage](#usage)
        * [Cli commands ](#cli-commands)
        * [Project Status](#project-status)
        * [To do](#to-do)
        * [Contact](#contact)
        * [License](#license)
         
        
        
        ## General Information
        >You can do some awesome things like hide anything in a .jpg image or
        >even make a gif from normal images with two lines of code or covert text files and images.
        
        What can you do with it?
        - can hide secret messages or executable file or images and share by another image.
        - can easily make gifs using photos for free
        - can convert images and text files also
        
        
        ## Python library Used
        - language info: python - version 3+
        - python standard libraries - [ logging, io, os, pathlib, argparse]
        - python third-party libraries - Pillow(version 8.3.2)
        
        
        
        ## Usage
        - To hide someting in a jpg file you have to user the PIRATE module like below, 
        ``` 
        from treasure_image import PIRATE
        
        #if want to hide a string in example.jpg(host image)
        PIRATE.hide_str_treasure(image="example.jpg", treasure="This is a hidden message!")
        
        #if want to hide a image in example.jpg(host image)
        PIRATE.hide_img_treasure(image="example.jpg", treasure="hidden_image.png")
        
        #if want to hide a file(.exe, .py, .cpp, .txt etc) in example.jpg(host image)
        PIRATE.hide_file_treasure(image="example.jpg", treasure="hidden_file.exe")
        ```
        - To hide extract something from a jpg file you have to user the EXPLORER module like below,
        ``` 
        from treasure_image import EXPLORER
        
        #if want to extract a string from example.jpg(host image)
        EXPLORER.seek_str_treasure(image="example.jpg")
        
        #if want to extract a image from example.jpg(host image)
        EXPLORER.seek_img_treasure(image="example.jpg")
        # it has two more default parameters which are 'save' and 'treasure_format',
        #
        # save=True(default) it saves the image in local machine
        # if save=False than it only shows the image.
        # treasure_format='jpg'(default) if save=True it saves the file in provided treasure_format.
        
        #if want to extract a .exe file from example.jpg(host image)
        EXPLORER.seek_exe_treasure(image="example.jpg")
        # there is a default perameter 'treasure_name'
        # treasure_name='treasure.exe'(default) saves the exe file in the provided name and format.
        
        #if want to extract a script/files from example.jpg(host image)
        EXPLORER.seek_file_treasure(image="example.jpg")
        # it has two more default parameters which are 'treasure_name' and 'treasure_format',
        #
        # treasure_name="treasure"(default) it saves the file with provided name
        # treasure_format='text'(default) if save=True it the file/script in provided format/type.
        ```
        - For creating GIF you have to use the GifMaker module like below,
        ```
        from treasure_image import GifMaker
        
        GifMaker(imgs_folder="E:\picture",
                 image_formate="png",
                 title="example", 
                 duration="120", 
                 loop="5",
        ).make_gif()
        
        # it has two default parameters which are 'output_folder' and 'optimize'
        # output_folder=current working dir.(default)
        # optimize=False(default)
        ```
        - To convert images in order to use this lib and conver outputed .text files to script use CONVERTER module like below,
        ```
        from treasure_image import CONVERTER
        
        # if want to convert 'example.png' to 'example.jpg'
        CONVERTER.convert_image(target_image="example.png", format_to='jpg')
        
        # if want to convert outputed 'treasure.text' file to script like 'treasure.py'
        CONVERTER.convert_to_script(text_file="treasure.text", convert_to="treasure.py")
        ```
        
        ## Cli commands
        - To use CONVERTER module do,
        >to convert 'example.jfif' to 'example.jpg'
        ```
        python -m treasure_image CONVERTER -img download.jfif -ft jpg
        ```
        >to convert 'example.txt' to 'example.py'
        ```
        python -m treasure_image CONVERTER -file example.txt -ct example.py
        ```
        - To use GifMaker module do,
        >to create example.gif from png images stored in E:\picture with a duration of 120ms and 5 loops,
        ```
        python -m treasure_image GifMaker -imgs E:\picture -if PNG -title example -d 120 -l 5
        ```
        - To use PIRATE module do,
        >to hide a message in 'example.jpg',
        ```
        python -m treasure_image PIRATE -hm .\example.jpg -tt str -t 'This is massege'
        ```
        >to hide 'to_be_hide.png' in 'example.jpg',
        ```
        python -m treasure_image PIRATE -hm .\example.jpg -tt img -t .\to_be_hide.png
        ```
        >to hide 'to_be_hide.exe' in 'example.jpg',
        ```
        python -m treasure_image PIRATE -hm .\example.jpg -tt exe -t .\to_be_hide.exe
        ```
        >to hide 'to_hide_files.py' in 'example.jpg',
        ```
        python -m treasure_image PIRATE -hm .\example.jpg -tt file -t .\to_hide_files.py
        ```
        - To use EXPLORER module do,
        >to extract a message from 'example.jpg',
        ```
        python -m treasure_image EXPLORER -hm .\example.jpg -tt str
        ```
        >to extract image from 'example.jpg',
        ```
        python -m treasure_image EXPLORER -hm .\example.jpg -tt img
        ```
        >to extract exe from 'example.jpg',
        ```
        python -m treasure_image EXPLORER -hm .\example.jpg -tt exe
        ```
        >to hide files/scripts from 'example.jpg',
        ```
        python -m treasure_image EXPLORER -hm .\example.jpg -tt file
        ```
        
        
        ## Project Status
        Project is: _in progress_
        >Any kind of Support will be appreciate.
        
        
        ## To do
        
        - Support for image formats as host image (currently jpg is allowed)
        - Support for vector graphics (.svg, .ai etc)
        
        
        ## Contact
        Created by [@FatinShadab](https://github.com/FatinShadab) - feel free to contact me!
        
        <!-- Optional -->
        ## License
         This project is open source and available under the [MIT License](https://github.com/FatinShadab/TRREASURE_IMAGE/blob/main/LICENSE).
        
Keywords: python,image,hide image,hide exe,image hack,converter,image converter,gifs
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
