From 474b20c2e18ccc8884ffdd6f39404995983cd341 Mon Sep 17 00:00:00 2001 From: Jason Ertel Date: Wed, 17 May 2023 08:54:17 -0400 Subject: [PATCH] Update CHANGELOG.md --- CHANGELOG.md | 30 +++++++----------------------- 1 file changed, 7 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 84ea1c7..528efd1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,39 +13,23 @@ ## Breaking changes - Replaced Minute with Hour as normal interval since history is limited to 7 days from Emporia on minute data -- argparse libary was added, must run pip `install -r requirements.txt` again in the src directory (or pip3 based on install) +- argparse libary was added, must run `pip install -r requirements.txt` again in the src directory (or pip3 based on install) ## New features - Hour / Day historic data retrieval: allows for history of up to two years to be pulled. Assists in clean numbers/graphs to see daily monthly usage to compare against utilities reports. - Hour data runs with the get details time, default is 1 hour (3600 seconds). Based on when the program is started, you may be almost 2 hours behind for get hour. -- Moved one-time parameters out of the json config file. Those parameters are now specified as command line arguments (History load days, reset database). - -Example Command Line usage -``` -vuegraf.py [-h] [--version] [-v] [-q] [--historydays HISTORYDAYS] [--resetdatabase] configFilename - -positional arguments: - configFilename json config file - -options: - -h, --help Show this help message and exit - --version Display version number - -v, --verbose Verbose output - summaries - -q, --quiet Do not print anything but errors - --historydays HISTORYDAYS - Starts executing by pulling history of Hours and Day data for specified number of days. - example: --historydays 60 - --resetdatabase Drop database and create a new one -``` +- Moved one-time parameters out of the json config file. Those parameters are now specified as command line arguments (--historydays, --resetdatabase). ## Other changes - Started Changelog for this and future releases -- Added project metadata to main program - vuegraf.py, values can be updated through github automations +- Added project metadata to `vuegraf.py`, values can be updated through github automations - Added command line pairing with help syntax for all values, via argparse lib. -- Updated requirements.txt and setup.py with argparse>= 1.4.0 -- Updated vuegraf.json.sample as history and reset database was moved to command line +- Updated `requirements.txt` and setup.py with `argparse>= 1.4.0` +- Updated `vuegraf.json.sample` as history and reset database was moved to command line - Updated Readme.md with above changes - ran pylint and fixed Quote delimiter consistency to all ' Whitespaces Extra lines + +With sppecial thanks to @gauthig for initiating these 1.6.0 changes!