From f2ee3e2815d084d92826606dab28fd261ccf1b6f Mon Sep 17 00:00:00 2001 From: Alex Schofield Date: Wed, 19 Feb 2025 02:28:06 +0000 Subject: add help information to CLI arguments --- cli.py | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'cli.py') diff --git a/cli.py b/cli.py index 12fd40a..e92148f 100644 --- a/cli.py +++ b/cli.py @@ -15,17 +15,30 @@ def main(): prog="GDPR-Obfuscator", description="Obfuscate sensitive data stored locally or in an AWS environment", ) + + parser.add_argument( + "-v", "--verbose", action="store_true", help="Enable verbose logging" + ) + # Require user to either choose a local file or an S3 object # The user can only choose one of these options or the program will exit # If not provided, the program will exit loc = parser.add_mutually_exclusive_group(required=True) - loc.add_argument("-l", "--local") - loc.add_argument("-s", "--s3") + loc.add_argument("-l", "--local", help="Path to local CSV file") + loc.add_argument( + "-s", "--s3", help="S3 object path (example: s3://bucket-name/file)" + ) # Require user to provide a list of PII fields to obfuscate # e.g. --pii name email_address # If not provided, the program will exit - parser.add_argument("-p", "--pii", nargs="+", required=True) + parser.add_argument( + "-p", + "--pii", + nargs="+", + required=True, + help="List of PII fields to obfuscate, separated by spaces", + ) # Parse the arguments args = parser.parse_args() -- cgit v1.2.3