logging-reporter 1.0.0

Description:

loggingreporter 1.0.0

Lightweight logger decorators for python



License:
MIT



What is this repository?
Extends default python logging module to make it easier to log actions before and after running functions and methods.
Usefull when debugging an application and you want to see the time a function takes or when the function was called.


Features

Display when a function was executed
Display the result of a function
Display a value before and after a fucntion was executed
Display the execution time
Display the str and repr method of an object before and after



How do I get set up?
Use pip install git+ssh://[email protected]/2019342a/reporter to install the library. Then you are good to go!


Dependencies
logging-reporter requires colorlog to add colour to the reporter logs.


Example
from reporter.utils import create_reporter
from reporter.decorators import report_execution

# Initialise the logger
create_reporter()

@report_execution
def add(a: int, b: int) -> int:
return a + b


add(1, 2)
You should then see in your terminal something like:
2021-05-15 11:05:53,114 - reporter - DEBUG - add was executed with args 1 2


Contact
If you have any questions, bugs or features please open a github issue.