Skip to content

Commit

Permalink
Updating readme to add additional command flag
Browse files Browse the repository at this point in the history
  • Loading branch information
cehune committed Jul 20, 2024
1 parent d0b568b commit f9babb6
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ sudo $(which python3) /path_to_directory/infra_file_auto_expiry/infra_file_auto
Required flags:
folder_path : STRING | Path to folder to check expiry of
Optional flags:
--save-file="" : SRING | A path to a jsonl file to save the collected information to. If this is undefined, then the program will just generate a filename and save it to the working directory.
--days-for-expiry=x : INT | The amount of days of non-usage that indicates any file is expired.

This will return a jsonl file of the following form. After the first two dictionary type objects, each dictionary contains the information of ONE top level folder inside of the folder_path flag. AKA. This program reports information by iterating through the top level folders, but checks expiry by entering recursively through each of those folders. Essentially, each dictionary is associated with a PATH, and all creators who are associated with said path.
Expand Down

0 comments on commit f9babb6

Please sign in to comment.