Skip to content

Commit b6b9746

Browse files
authored
Merge pull request #68 from brootware/dev
Dev
2 parents 729d9f6 + fee19cd commit b6b9746

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,33 +42,33 @@ Demo:
4242
Quick install
4343

4444
```bash
45-
python -m pip install pyredactkit
45+
python -m pip install --upgrade pyredactkit
4646
```
4747

4848
**For more elaborate usage, please [refer to the docs](https://github.com/brootware/PyRedactKit/wiki/Usage).**
4949

5050
Redact from terminal
5151

5252
```bash
53-
pyredactkit 'this is my ip:127.0.0.1. my email is [email protected]. secret link is github.com'
53+
prk 'this is my ip:127.0.0.1. my email is [email protected]. secret link is github.com'
5454
```
5555

56-
Redact a single file
56+
Redact a single file.
5757

5858
```bash
59-
pyredactkit -f test.txt
59+
prk test.txt
6060
```
6161

62-
Unredact the file
62+
Un-redact the file with redacted data
6363

6464
```bash
65-
pyredactkit -f redacted_test.txt -u .hashshadow_test.txt.json
65+
prk redacted_test.txt -u .hashshadow_test.txt.json
6666
```
6767

6868
Redact using custom regex pattern
6969

7070
```bash
71-
pyredactkit -f file -c custom.json
71+
prk file -c custom.json
7272
```
7373

7474
### Use from github source

pyredactkit/runner.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,10 @@
33
Utility to redact sensitive data
44
"""
55

6-
import argparse
7-
from genericpath import isdir
8-
9-
from numpy import full
10-
116
from pyredactkit.core_redactor import CoreRedactorEngine
127
from pyredactkit.custom_redactor import CustomRedactorEngine
138
from pyredactkit.unredact import Unredactor
9+
import argparse
1410
import os
1511
import glob
1612
import sys

0 commit comments

Comments
 (0)