Metadata-Version: 2.1
Name: photocrypt
Version: 0.0.1
Summary: A package that can encrypt and decrypt images
Home-page: https://github.com/Kullmann/RSAPhotoCryptography
Author: Hosung Lee, Sean Kullman
Author-email: runway3237@gmail.com, seankullmann@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/Kullmann/RSAPhotoCryptography/issues
Project-URL: Source, https://github.com/Kullmann/RSAPhotoCryptography
Description: # RSAPhotoCryptography
        The purpose of this project is to encrypt and decrypt photos using the RSA algorithm.
        
        ## Installation
        
        To install photocrypt package simply run following command on root directory:
        
        ```pip3 install .```
        
        ## Running
        
        ### Run GUI Application
        
        from the root directory, run following command:
        
        ```python3 bin```
        
        ### Run CUI Application
        
        from the root directory, run following command:
        
        ```python3 bin [-h] [-i image path] [-k key path] [--encrypt] [--decrypt]```
        
        #### arguments:
        
          **-h**, **--help**            show this help message and exit
        
          **-i** **[image path]**  image file path to encrypt/decrypt
        
          **-k** **[key path]**       public key path    
        
          **--encrypt**                 encrypt given image using provided key
        
          **--decrypt**                 decrypt given image using provided key
        
        #### example usage:
        
        ```python3 bin -i samples/tuatara.jpg -k public.pem --encrypt```
        
        ```python3 bin -i samples/tuatara_enc -k private.pem --decrypt```
        
        ## Testing
        
        test scripts are available in tests/ directory.
        
        Run following command to run tests.
        ```python3 tests/<test name>.py```
        
        ## Requirements
        
        photocrypt package requires python3.6 or above.
        
        ## Known Bugs
        
        - Double encryption is not supported because crypto header is overwritten on encryption.
        
        ## Contributors
        
        Hosung Lee
        
        Sean Kullmann
        
Keywords: cryptology,cryptograpy,image
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: gui
