https://github.com/ciaranomara/blind.jl

File blinder
https://github.com/ciaranomara/blind.jl

julia science

Last synced: about 1 year ago
JSON representation

File blinder

• Host: GitHub
• URL: https://github.com/ciaranomara/blind.jl
• Owner: CiaranOMara
• License: mit
• Created: 2020-02-18T09:54:40.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2023-05-31T14:22:07.000Z (about 3 years ago)
• Last Synced: 2024-10-19T15:20:15.072Z (over 1 year ago)
• Topics: julia, science
• Language: Julia
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Blind.jl

[![Run tests](https://github.com/CiaranOMara/Blind.jl/workflows/Run%20tests/badge.svg)](https://github.com/CiaranOMara/Blind.jl/actions?query=workflow%3A%22Run+tests%22)

> This project follows the [semver](http://semver.org) pro forma and uses the [git-flow branching model](https://nvie.com/posts/a-successful-git-branching-model/ "original

blog post").

## Overview

This script blinds files by copying and renaming them with a random set of characters. The script also saves a record in `key.csv` for the un-blinding of files.

## Installation

    (v1.1) pkg> add https://github.com/CiaranOMara/Blind.jl

## Usage

If the `blind.sh` script is executable and locatable by your `PATH` variable, you can call it by executing `blind.sh` at the prompt.

Otherwise, run the script at the prompt with `sh blind.sh` or `julia blind.sh`.

```

usage: blind.sh [-s SETS] [-n NUMERIC] [-h] input [output] [key]

positional arguments:

  input                 Input directory.

  output                Output directory.

  key                   Key file (.csv).

optional arguments:

  -s, --sets SETS       Number of numeric sets. (type: Int64, default:

                        3)

  -n, --numeric NUMERIC

                        Number of numeric characters. (type: Int64,

                        default: 4)

  -h, --help            show this help message and exit

```

## Optional (Unix like systems)

To make the script executable, grant execution privileges to the bash script.

```console

chmod +x blind.sh

```

To make the script locatable, link the script under a directory like `~/Documents/Scripts`.

```console

ln -s /blind.sh ~/Documents/Scripts/blind

```

Then include the directory in your `PATH` variable.

```console

echo 'export PATH=$PATH:~/Documents/Scripts' >> ~/.profile

```

> ***Note:*** The example shows how to modify the `PATH` variable in a bash environment.