lkj 0.1.36__tar.gz → 0.1.37__tar.gz

{lkj-0.1.36 → lkj-0.1.37}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lkj
-Version: 0.1.36
+Version: 0.1.37
 Summary: A dump of homeless useful utils
 Home-page: https://github.com/thorwhalen/lkj
 Author: Thor Whalen
@@ -25,9 +25,38 @@ That is, modules are all self contained (so can easily be copy-paste-vendored
 Further, many functions will contain their own imports: Those functions can even be 
 copy-paste-vendored by just copying the function body.
 
-
 # Examples of utils
 
+## Find and replace
+
+`FindReplaceTool` is a general-purpose find-and-replace tool that can treat the input text as a continuous sequence of characters, 
+even if operations such as viewing context are performed line by line.
+
+The basic usage is 
+
+```python
+FindReplaceTool("apple banana apple").find_and_print_matches(r'apple')
+```
+    
+    Match 0 (around line 1):
+    apple banana apple
+    ^^^^^
+    ----------------------------------------
+    Match 1 (around line 1):
+    apple banana apple
+                 ^^^^^
+    ----------------------------------------
+
+```python
+FindReplaceTool("apple banana apple").find_and_replace(r'apple', "orange")
+```
+
+    'orange banana orange'
+
+[See more examples in documentation](https://i2mint.github.io/lkj/module_docs/lkj/strings.html#lkj.strings.FindReplaceTool)
+
+[See here a example of how I used this to edit my CI yamls](https://github.com/i2mint/lkj/discussions/4#discussioncomment-12104547)
+
 ## loggers
 
 ### clog

{lkj-0.1.36 → lkj-0.1.37}/README.md

@@ -14,9 +14,38 @@ That is, modules are all self contained (so can easily be copy-paste-vendored
 Further, many functions will contain their own imports: Those functions can even be 
 copy-paste-vendored by just copying the function body.
 
-
 # Examples of utils
 
+## Find and replace
+
+`FindReplaceTool` is a general-purpose find-and-replace tool that can treat the input text as a continuous sequence of characters, 
+even if operations such as viewing context are performed line by line.
+
+The basic usage is 
+
+```python
+FindReplaceTool("apple banana apple").find_and_print_matches(r'apple')
+```
+    
+    Match 0 (around line 1):
+    apple banana apple
+    ^^^^^
+    ----------------------------------------
+    Match 1 (around line 1):
+    apple banana apple
+                 ^^^^^
+    ----------------------------------------
+
+```python
+FindReplaceTool("apple banana apple").find_and_replace(r'apple', "orange")
+```
+
+    'orange banana orange'
+
+[See more examples in documentation](https://i2mint.github.io/lkj/module_docs/lkj/strings.html#lkj.strings.FindReplaceTool)
+
+[See here a example of how I used this to edit my CI yamls](https://github.com/i2mint/lkj/discussions/4#discussioncomment-12104547)
+
 ## loggers
 
 ### clog

{lkj-0.1.36 → lkj-0.1.37}/lkj.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lkj
-Version: 0.1.36
+Version: 0.1.37
 Summary: A dump of homeless useful utils
 Home-page: https://github.com/thorwhalen/lkj
 Author: Thor Whalen
@@ -25,9 +25,38 @@ That is, modules are all self contained (so can easily be copy-paste-vendored
 Further, many functions will contain their own imports: Those functions can even be 
 copy-paste-vendored by just copying the function body.
 
-
 # Examples of utils
 
+## Find and replace
+
+`FindReplaceTool` is a general-purpose find-and-replace tool that can treat the input text as a continuous sequence of characters, 
+even if operations such as viewing context are performed line by line.
+
+The basic usage is 
+
+```python
+FindReplaceTool("apple banana apple").find_and_print_matches(r'apple')
+```
+    
+    Match 0 (around line 1):
+    apple banana apple
+    ^^^^^
+    ----------------------------------------
+    Match 1 (around line 1):
+    apple banana apple
+                 ^^^^^
+    ----------------------------------------
+
+```python
+FindReplaceTool("apple banana apple").find_and_replace(r'apple', "orange")
+```
+
+    'orange banana orange'
+
+[See more examples in documentation](https://i2mint.github.io/lkj/module_docs/lkj/strings.html#lkj.strings.FindReplaceTool)
+
+[See here a example of how I used this to edit my CI yamls](https://github.com/i2mint/lkj/discussions/4#discussioncomment-12104547)
+
 ## loggers
 
 ### clog

{lkj-0.1.36 → lkj-0.1.37}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = lkj
-version = 0.1.36
+version = 0.1.37
 url = https://github.com/thorwhalen/lkj
 platforms = any
 description_file = README.md