init

.gitignore

@@ -0,0 +1,3 @@
+/src/py_regex_replace.egg-info/
+/build/
+/dist/

.idea/runConfigurations/main.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="main" type="PythonConfigurationType" factoryName="Python" nameIsGenerated="true">
+    <module name="py-regex-replace" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+    </envs>
+    <option name="SDK_HOME" value="$PROJECT_DIR$/venv/bin/python" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/src/py_regex_replace" />
+    <option name="IS_MODULE_SDK" value="false" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/src/py_regex_replace/main.py" />
+    <option name="PARAMETERS" value="-p ^Hi -r Hello -c 2" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="false" />
+    <option name="REDIRECT_INPUT" value="true" />
+    <option name="INPUT_FILE" value="$PROJECT_DIR$/test/stdin.txt" />
+    <method v="2" />
+  </configuration>
+</component>

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

Makefile

@@ -0,0 +1,7 @@
+.PHONY: all
+all:
+	sudo python3 -m pip install --upgrade --force-reinstall .
+
+.PHONY: clean
+clean:
+	sudo python3 -m pip uninstall -y py-regex-replace

README.md

@@ -0,0 +1,31 @@
+# py-regex-replace
+
+## Installation
+
+```shell
+make install
+```
+
+## Uploading to TestPyPI
+
+More detailed instructions can be found at [https://packaging.python.org/tutorials/packaging-projects/](https://packaging.python.org/tutorials/packaging-projects/)
+
+1) Set up a _venv_
+2) Increase/Adjust `[metadata][version]` in [setup.cfg](setup.cfg)
+3) Install the `build` and `twine` modules to your _venv_.
+4) Next generate a [distribution archive](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives):
+
+```shell
+python3 -m build
+```
+
+5) Upload the distribution packages with twine. For the username, use `__token__`. For the password, use a 
+[test.pypi.org API token](https://test.pypi.org/manage/account/#api-tokens):
+
+```shell
+python3 -m twine upload --repository testpypi dist/*
+```
+
+6) Congratulations! You can view the uploaded module under:
+
+* [https://test.pypi.org/project/py-regex-replace/](https://test.pypi.org/project/py-regex-replace/)

pyproject.toml

@@ -0,0 +1,8 @@
+# https://packaging.python.org/tutorials/packaging-projects/#creating-pyproject-toml
+
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,35 @@
+; setup.cfg is the configuration file for setuptools.
+; https://packaging.python.org/tutorials/packaging-projects/#configuring-metadata
+
+[metadata]
+name = py-regex-replace
+version = 0.0.1
+author = Daniel Langbein
+author_email = daniel@systemli.org
+description = perform regex-replacement on stdin and output result to stdout
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://git.privacy1st.de/langfingaz/py-regex-replace
+project_urls =
+    Bug Tracker = https://git.privacy1st.de/langfingaz/py-regex-replace/issues
+
+; https://pypi.org/classifiers/
+classifiers =
+    Development Status :: 4 - Beta
+    Programming Language :: Python :: 3
+    License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+    Operating System :: Unix
+
+[options]
+package_dir =
+    = src
+packages = find:
+python_requires = >=3.6.9
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+; https://setuptools.readthedocs.io/en/latest/userguide/entry_point.html
+console_scripts=
+    py-regex-replace = py_regex_replace.main:main

src/py_regex_replace/main.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import argparse
+import re
+import sys
+
+
+def main():
+    pattern, repl, string, count = parse_args()
+
+    # https://docs.python.org/3/library/re.html#re.MULTILINE
+    # re.MULTILINE
+    # When specified, the pattern character '^' matches at the beginning of the string
+    # and at the beginning of each line (immediately following each newline);
+    # and the pattern character '$' matches at the end of the string
+    # and at the end of each line (immediately preceding each newline).
+
+    # https://docs.python.org/3/library/re.html#re.findall
+    # Return all non-overlapping matches of pattern in string, as a list of strings or tuples.
+    # The string is scanned left-to-right, and matches are returned in the order found.
+    matches = re.findall(pattern, string, flags=re.MULTILINE)
+    if len(matches) != count:
+        print(f'[ERROR] Expected {count} matches of pattern in string, but got {len(matches)}.')
+        exit(1)
+
+    # https://docs.python.org/3/library/re.html#re.sub
+    # Return the string obtained by replacing the leftmost non-overlapping occurrences of `pattern`
+    # in `string` by the replacement `repl`.
+    string = re.sub(pattern, repl, string, flags=re.MULTILINE)
+
+    print(string, end='')
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(prog='py-regex-replace')
+
+    parser.add_argument('--pattern', '-p',
+                        help='regex search pattern',
+                        required=True, type=str)
+    parser.add_argument('--repl', '-r',
+                        help='replacement',
+                        required=True, type=str)
+    parser.add_argument('--count', '-c',
+                        help='expected count of pattern in string',
+                        default=1, type=int)
+
+    args = parser.parse_args()
+
+    string = sys.stdin.read()
+    if len(string) == 0:
+        print('[WARNING] The given string is empty.', file=sys.stderr)
+
+    return args.pattern, args.repl, string, args.count
+
+
+if __name__ == '__main__':
+    main()

test/stdin.txt

@@ -0,0 +1,3 @@
+Hi, my name is robot.
+Hi robot :)
+Why do you always say "Hi"?

test/test1.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env sh
+
+string='alpha = a
+beta = b
+Exec = foo bar baz
+end = EOF'
+pattern='^Exec = foo .*$'
+repl='Exec = /bin/foo BAR BAZ'
+
+string="$(printf '%s' "${string}" | ./src/main.py -p "${pattern}" -r "${repl}" -c 1)"
+
+printf 'RESULT>>>\n%s\n<<<RESULT\n' "${string}"