Skip to content

Commit 0b09ec7

Browse files
author
rootware
committed
Changed help menu to properly reflect latest features
1 parent b1454e9 commit 0b09ec7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

pyredactkit/runner.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,20 @@
4141
PyRedactKit - Redact and Un-redact any sensitive data from your text files!
4242
Example usage:\n
4343
prk 'This is my ip: 127.0.0.1. My email is [email protected]. My favorite secret link is github.com'\n
44-
prk --file [file/filestoredact]\n
45-
prk --file redacted_file --unredact .hashshadow.json\n
46-
prk --file file --customfile custom.json\n
44+
prk [file/directory_with_files]\n
45+
prk redacted_file --unredact .hashshadow.json\n
46+
prk file --customfile custom.json\n
4747
"""
4848

4949

5050
def arg_helper() -> argparse.Namespace:
5151
parser = argparse.ArgumentParser(
52-
description="Supply a sentence or paragraph to redact sensitive data from it. Or read in a file or set of files with -f to redact",
52+
description="Supply either a text chunk or file name path to redact sensitive data from it.",
5353
formatter_class=argparse.ArgumentDefaultsHelpFormatter
5454
)
5555
parser.add_argument(
5656
"text",
57-
help="""Redact sensitive data of a sentence from command prompt.""",
57+
help="""Supply either a text chunk or file name path to redact sensitive data from command prompt.""",
5858
nargs="*"
5959
)
6060
if len(sys.argv) == 1:
@@ -66,23 +66,23 @@ def arg_helper() -> argparse.Namespace:
6666
"--unredact",
6767
help="""
6868
Option to unredact masked data.
69-
Usage: pyredactkit -f [redacted_file] -u [.hashshadow.json]
69+
Usage: pyredactkit [redacted_file] -u [.hashshadow.json]
7070
"""
7171
)
7272
parser.add_argument(
7373
"-d",
7474
"--dirout",
7575
help="""
7676
Output directory of the file.
77-
Usage: pyredactkit -f [file/filestoredact] -d [redacted_dir]
77+
Usage: pyredactkit [file/filestoredact] -d [redacted_dir]
7878
"""
7979
)
8080
parser.add_argument(
8181
"-c",
8282
"--customfile",
8383
help="""
8484
User defined custom regex pattern for redaction.
85-
Usage: pyredactkit -f [file/filestoredact] -c [customfile.json]
85+
Usage: pyredactkit [file/filestoredact] -c [customfile.json]
8686
"""
8787
)
8888
parser.add_argument(

0 commit comments

Comments
 (0)