Metadata-Version: 2.1
Name: encrypter-fernet-dr
Version: 0.0.1
Summary: Encrypt file using fernet
Home-page: https://github.com/dav-rs/PythonPackage/tree/main/Encrypter
Author: David Rios
Author-email: hdavidrios@hotmail.com
License: UNKNOWN
Description: # Encrypter
        
        This package contains 2 main functions for Encrypting and Decrypting a file.  encrypt_file() creates an encrypted copy of a file using Fernet (symmetric encryption) in the working directory.
            The function takes a file as main argument and a key_file as optional argument. If no key_file is given, then a key for the encryption is created using Fernet.generate_key()
        
        decrypt_file() is used for decrypting the file generated by the previous function. It requires the encrypted file and the key generated (or used) during the encryption process.
        
        ## Installation
        To install run the following:
        ```python
        pip install encrypter
        ```
        
        ## Usage
        ``` python
        from encrypter_fernet_dr import encrypt_file
        
        # generate key and encrypted copy of my_file in the working directory
        encrypt_file('my_file')
        ```
        ``` python
        from encrypter_fernet_dr import decrypt_file
        
        # decrypt the file passing the key generated or used before
        decrypt_file('my_file_encrypted', 'my_key')
        ```
        
        ## Developing Encrypter
        
        To install encrypter, along with the tools needed to develop and run tests, run the following in your virtualenv:
        
        ```bash
        $ pip install -e .[dev]
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: dev
