neutrinoceros / apply_subs Goto Github PK

A command line tool to programmatically apply substitutions to a text file

License: GNU General Public License v3.0

Python 100.00%

apply_subs's Introduction

apply-subs

A command line application to apply a dictionnary (json) of substitutions to text file corpus. This program is a find-and-replace tool to perform a arbitrarily large set of substitutions in a reproducible fashion.

Disclaimer, this app is far less powerful than sed and in particular doesn't support regex replacement. What it offers a simpler interface to make simple sweeping changes across a whole project in a reproducible fashion.

Installation

The easiest installation method is

$ pip install apply-subs

In order to install apply-subs in isolation, use pipx instead.

Examples

apply-subs uses a json file as input. This file should specify substitutions as new: old, where old can either be a single str, or a list of strings.

minimal case

echo "bunnies and bongos and bananas" > mytext.txt
echo '{"bunnies": "rabbits", "SECRETS": ["bongos", "bananas"]}' > mysubs.json
apply-subs mytext.txt -s mysubs.json

will print the patched content

bunnies and SECRETS and SECRETS

diff mode

Use diff mode (-d/--diff) to print a diff instead of the end result

--- mytext.txt
+++ mytext.txt (patched)
@@ -1 +1 @@
-Lorem ipsum dolor sit amet, consectetur adipiscing elit
+Hello dolor sit amet, consectetur goodbye

Use -cp/--cdiff/--colored-diff for a colored output (when supported).

inplace substitutions

-i/--inplace

apply-subs --inplace mytext.txt -s mysubs.json

is equivalent to

apply-subs mytext.txt -s mysubs.json > mytext.txt

target several files in one go

The target positional argument can consist of a single file (as illustrated above), or many. This is useful for instance if you need to apply a set of subtitutions to all files in a project whose name match a regexp.

git ls-files | egrep "(.md|.py)$" | xargs apply-subs -s subsubs.json -i

apply_subs's People

Contributors

Watchers

apply_subs's Issues

doc: adress sed

Disclaimer, this app is far less powerful than sed and in particular doesn't support regex replacement, but
It offers a simpler interface to make simple sweeping changes in a reproducible fashion.

typo in readme

apply-subs is misspelled apply-sub at least once

Feature: reverse mode

Add a --reverse flag to swap between old and new in parsing. This will only work for key to key schéma and be invalid for key to list.
This should be dealt with after #13

diff mode prints too much empty lines

the head and foot of the total message printed is polluted with empty lines, at least when applied to more than one file.

missing windows support

patch flag is ill named

diff would make more sense

better test separation

feature: apply subs to multiple targets

This will require changing the order of positional arguments (version 0.3.0)

goal: make this valid

git ls-files | grep ".py" | xargs python -m apply_subs -s subsubs.json -i

{
  "key1": [
    "form1",
    "FORM2",
    "FoRm3"
  ]
}

⚠️ this implies that the default behavior should be to parse {new: old}
which is the opposite of the current implementation.

This also requires some schema validation.