Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.14 KB

README.md

File metadata and controls

25 lines (19 loc) · 1.14 KB

SetupVariableTracker Build Status

Very simple library to track and log the declaration of new (setup) variables.

Usage example

from SetupVariableTracker import SetupVariableTracker
vtrack = SetupVariableTracker(locals())

##################################################
# Define parameters for this script
setup_variable_1 = "Hello"
setup_variable_2 = "World!"
foo = 1
bar = None
##################################################
# Create a summary of all newly defined variables
summary_content = vtrack.save(locals(), sort=True)
print(summary_content)

This will print an overview of the declared variables (setup_variable_1, setup_variable_2, foo, and bar) as well as save them in a timestamped .log file.

I know there are more elegant ways to achieve this, but I found this an elegant way to add this functionality to legacy code with very little effort. Hope it'll be useful to others.

Installation

pip install git+https://github.com/Aypac/SetupVariableTracker