https://github.com/vlebourl/redactor

https://github.com/vlebourl/redactor

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vlebourl/redactor
• Owner: vlebourl
• Created: 2023-04-11T16:03:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-04-12T16:50:58.000Z (over 1 year ago)
• Last Synced: 2024-10-30T17:51:47.408Z (2 months ago)
• Language: Python
• Size: 28.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Redact App

Redact App is a Python package that provides an executable for redacting and unredacting files based on a given configuration file. It replaces case-sensitive occurrences of substrings with random strings, preserving the original case and generating separate random strings for different capitalizations.

## Installation

To install the Redact App, simply clone the repository and install the required dependencies:

```bash

git clone https://github.com/your_username/redact_app.git

cd redact_app

pip install -r requirements.txt

```

## Usage

The general syntax for using the Redact App is:

```bash

redact [-h] [-c CONFIG_FILE] [-d DICT_LOCATION] [-f] {redact,unredact} input_file

```

## Arguments:

```

{redact,unredact}: Specify whether to redact or unredact the file.

input_file: The input file to redact or unredact.

-h, --help: Show help message and exit.

-c CONFIG_FILE, --config_file CONFIG_FILE: The configuration file for redaction (default: config.json).

-d DICT_LOCATION, --dict_location DICT_LOCATION: The location of the encrypted dictionary (default: None).

```

## Examples

To redact a file:

```

redact redact input_file.sh

```

To unredact a file:

```

redact unredact input_file_redacted.sh

```

## Contributing

If you want to contribute to this project, please submit an issue or pull request on the GitHub repository.

## License

This project is licensed under the MIT License. See the LICENSE file for more information.