Skip to content

Commit 9f66aa3

Browse files
author
rootware
committed
fixed readme
1 parent f8f2bfc commit 9f66aa3

File tree

1 file changed

+7
-32
lines changed

1 file changed

+7
-32
lines changed

README.md

Lines changed: 7 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ $ poetry run pyredactkit ip_test.txt
155155
[ + ] Redacted results saved to ./redacted_ip_test.txt
156156
```
157157
158-
Sample Result (Note that name is not redacted by default):
158+
Sample Result:
159159
160160
```txt
161161
John, please get that article on b8bd54d3-34ee-4f31-8b2b-0d729929e8aa to me by 5:00PM on Jan 9th 2012. 4:00 would be ideal, actually. If you have any questions, You can reach me at(519)-236-2723 or get in touch with my associate at 7b3c7641-4b09-4e00-8e02-0e68e47b0ded.
@@ -201,51 +201,26 @@ e0b66cbd-6174-4491-b938-408a47d38fb9,Platinum,142000,CC90518
201201
24f31233-cba6-4f6a-a2d6-0ce49952b2cb,Premium,781000,CC66746
202202
```
203203
204-
Sample result:
205-
206-
```txt
207-
███████████████, please get that article on www.linkedin.com to me by 5:00PM on Jan 9th 2012. 4:00 would be ideal, actually. If you have any questions, You can reach me at(519)-236-2723 or get in touch with my associate at [email protected].
208-
All rights reserved. Printed in the United States of America. No part of this book may be used or reproduced in any manner whatsoever without written permission except in the case of brief quotations embodied in critical articles and reviews. For information address HarperCollins Publishers, 10 East 53rd Street, New York, NY 10022. His name is ███████████████. I met him and ███████████████ last week. ███████████████ is a good student. I was born on Oct 4, 1995. My Indian mobile number is +91-7761975545. After coming to USA I got a new number +1-405-413-5255. I live on 1003 E ███████████████, Norman, Ok, 73071. I met a child, who is playing with josh.
209-
this is my IP: 102.23.5.1
210-
My router is : 10.10.10.1
211-
71.159.188.33
212-
81.141.167.45
213-
165.65.59.139
214-
64.248.67.225
215-
216-
https://tech.gov.sg
217-
218-
My email is [email protected]
219-
220-
this is my IP: 102.23.5.1
221-
My router is: 10.10.10.1
222-
71.159.188.33
223-
```
224-
225-
To redact multiple files from a directory and place them in a new directory
226-
227-
```bash
228-
poetry run pyredactkit dir_test -d redacted_dir
229-
```
230-
231204
## Optional Help Menu as below
232205
233206
```bash
234-
usage: pyredactkit [-h] [-f FILE [FILE ...]] [-u UNREDACT] [-d DIROUT] [-r] [-e EXTENSION] [text ...]
207+
usage: pyredactkit [-h] [-f FILE [FILE ...]] [-u UNREDACT] [-d DIROUT] [-c CUSTOMFILE] [-r] [-e EXTENSION] [text ...]
235208

236-
Supply a sentence or paragraph to redact sensitive data from it. Or read in a file or set of files with -f , and return the result.
209+
Supply a sentence or paragraph to redact sensitive data from it. Or read in a file or set of files with -f to redact
237210

238211
positional arguments:
239212
text Redact sensitive data of a sentence from command prompt. (default: None)
240213

241214
optional arguments:
242215
-h, --help show this help message and exit
243216
-f FILE [FILE ...], --file FILE [FILE ...]
244-
Path of a file or a directory of files. Usage: pyredactkit [file/filestoredact] (default: None)
217+
Path of a file or a directory of files. (default: None)
245218
-u UNREDACT, --unredact UNREDACT
246219
Option to unredact masked data. Usage: pyredactkit -f [redacted_file] -u [.hashshadow.json] (default: None)
247220
-d DIROUT, --dirout DIROUT
248221
Output directory of the file. Usage: pyredactkit -f [file/filestoredact] -d [redacted_dir] (default: None)
222+
-c CUSTOMFILE, --customfile CUSTOMFILE
223+
User defined custom regex pattern for redaction. Usage: pyredactkit -f [file/filestoredact] -c [customfile.json] (default: None)
249224
-r, --recursive Search through subfolders (default: True)
250225
-e EXTENSION, --extension EXTENSION
251226
File extension to filter by. (default: )
@@ -254,5 +229,5 @@ optional arguments:
254229
## Sample files
255230
256231
- [All types of data](./logdata/test.txt)
257-
- [Differnt log file types](./logdata/)
232+
- [Different log file types](./logdata/)
258233
- [test_sample2.txt - 10002 lines of IP addresses](https://sanitizationbq.s3.ap-southeast-1.amazonaws.com/test_sample2.txt)

0 commit comments

Comments
 (0)