diff options
| author | Alex Schofield <git@ajschof.me> | 2025-02-19 02:28:06 +0000 |
|---|---|---|
| committer | Alex Schofield <git@ajschof.me> | 2025-02-19 02:28:06 +0000 |
| commit | f2ee3e2815d084d92826606dab28fd261ccf1b6f (patch) | |
| tree | 5cdbe095469f07462568a6a38229ec3bdf6980a6 /cli.py | |
| parent | 7a24e4e5526163f1c90b3bd5be173c545bd283cb (diff) | |
| download | gdpr-obfuscator-f2ee3e2815d084d92826606dab28fd261ccf1b6f.tar.gz gdpr-obfuscator-f2ee3e2815d084d92826606dab28fd261ccf1b6f.zip | |
add help information to CLI arguments
Diffstat (limited to 'cli.py')
| -rw-r--r-- | cli.py | 19 |
1 files changed, 16 insertions, 3 deletions
@@ -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() |
