Metadata-Version: 2.1
Name: email-function-logger
Version: 1.0
Summary: A decorator to log information about a function and send it to your email
Home-page: https://github.com/arthurcerveira/Email-Function-Logger
Author: Arthur Cerveira
Author-email: aacerveira@inf.ufpel.edu.br
License: UNKNOWN
Download-URL: https://github.com/arthurcerveira/Email-Function-Logger/archive/v1.0.tar.gz
Description: # Email Function Logger
        
        A Python decorator to easily log information about a function and send it to your email.
        
        ## Installation
        
        ```bash
        $ pip install email-function-logger
        ```
        
        ## Email setup
        
        You can set the email information as environment variable on your machine. To do this, add the following line to `~/.bashrc` (or `~/.bash_profile` depending on your OS).
        
        ```bash
        export EMAIL_ADDRESS="example@domain.com"
        ```
        
        This step is optional since you can input the information during the function runtime.
        
        ## Example of use
        
        ```python
        from email_function_logger import log_function
        
        @log_function
        def mult(x, y):
            # Function text output
            print(x)
            print(y)
        
            # Value returned by function
            return x * y
        
        mult(9, 7)
        ```
        
        The log sent by email will look like this:
        
        ```
        Subject:
        Function 'mult' execution log
        
        Body:
        Function mult(9, 7) finished its execution.
        
        Start time: Mar 16 18:32:16
        Function text output:
        9
        7
        Function returned: 63
        End time: Mar 16 18:32:16
        
        Total execution time: 00:00:00
        ```
        
        ## How it works
        
        The decorator receives the function information and send a request to a Flask API hosted on Heroku (available [here](https://github.com/arthurcerveira/Email-Bot)). This API then sends the email to the address specified in the `EMAIL_ADDRESS` variable.
        
        ## Supported versions
        
        - Python 3.2 and above
        
        ## Author
        
        - [Arthur Cerveira](https://github.com/arthurcerveira)
        
        ## License
        
        - MIT License
        
        ## Links
        
        - PyPI: https://pypi.org/project/email-function-logger/
        - GitHub: https://github.com/arthurcerveira/Email-Function-Logger
        
Keywords: log,email,function,logger
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.2
Description-Content-Type: text/markdown
