Metadata-Version: 2.1
Name: fcryptor
Version: 1.0.6
Summary: python package that encrypt/decrypt files by key.
Home-page: https://github.com/omidekz/fcryptor
Author: Omid Karimzade
Author-email: omidekz@gmail.com
License: MIT
Description: # File Cryptor
        ### Pages
         - [PYPI](https://pypi.org/project/fcryptor/)
         - [GitHub](https://github.com/omidekz/fcryptor)
        
        ## Install
        
            pip install fcryptor
        
        ## CLI Usage
        ```fcryptor [-h] (-c | -d) [-si] -i INPUT [-o OUTPUT] [-k KEY] [-gk]```
        
        ```
        optional arguments:
            [ -h  | --help    ]               show help message and exit
        
            [ -c  | --crypt   ]               crypting flag
            [ -d  | --decrypt ]               decrypting flag
        
            [ -si | --stdin   ]               when stdin is true, default=false
        
            [ -i  | --input   ]    INPUT      Input File/stdin [for stdin pass -si | --stdin]
            [ -o  | --output  ]    OUTPUT     Output crypt/decrypt result to File
        
            [ -k  | --key     ]    KEY        key of/for file
            [ -gk | --genkey  ]               generate a key and exit
        ```
        
        # CLI - Examples
        
        	fcryptor -c -si -i Hi
        
            # output
            Key is: szTaqno8sG4K8Gi0z1t4iTzlYb7RIebzhjPFpGPlstg=
            encrypt:
            gAAAAABfqVhMM5dk5HhO7Am3FyFk1qXpobq-JWyF5DbG1PFsRHWH3VzTzhyn8NrcBVfI10_lmqHSm3-YVC4BRYkLTK7T0ldu-Q==
        --------------------------------
            fcryptor -d -si -i gAAAAABfqVhMM5dk5HhO7Am3FyFk1qXpobq-JWyF5DbG1PFsRHWH3VzTzhyn8NrcBVfI10_lmqHSm3-YVC4BRYkLTK7T0ldu-Q== -k szTaqno8sG4K8Gi0z1t4iTzlYb7RIebzhjPFpGPlstg=
        
            # output
            decrypt:
            Hi
        ---------------------------------
            fcryptor -c -i test.txt -o test.enc
            # output
            Key is: dOmxLC4uEka9vGj8vfwECMHu9MbWo6RCYKDR1hXKGvU=
        ---------------------------------
            fcryptor -d -i test.enc -o test.txt
            # output
            when pass -d, you have to pass -k [the Key] argument
        
            #again
            fcryptor -d -i test.enc -o test_d.txt -k dOmxLC4uEka9vGj8vfwECMHu9MbWo6RCYKDR1hXKGvU=
            #output
            [nothing, just create test_d.txt file]
        ---------------------------------
        
        ## Code Usage
        ```py
        from fcryptor import FCryptor
        
        fc = FCryptor() # can pass key here, no support custom key yet
        out = fc.crypt(
            "HI", # or file path
            None, # or output path
            from_stdin=True # or False if pass path
        )
        
        fc.decrypt(
            out,
            "./test.enc",
            from_stdin=True
        )
        
        ```
Keywords: file encryptor,file cryptography,file crypt,decrypt,fcryptor,file-cryptor
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Security :: Cryptography
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
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.9
Description-Content-Type: text/markdown
