ppqs 2.1.0__tar.gz → 2.2.0__tar.gz

ppqs-2.2.0/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2025 Karl Wette
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

{ppqs-2.1.0/src/ppqs.egg-info → ppqs-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.1.0
+Version: 2.2.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -10,7 +10,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-License-File: LICENSE
+License-File: LICENSES/MIT.txt
 Requires-Dist: tomli>=1.1.0; python_version < "3.11"
 Dynamic: license-file
 
@@ -100,6 +100,36 @@ $ ppqs print-something Hi
 Hi
 ```
 
+`ppqs` can recursively run its own scripts, however it will only run any script
+once. For example, given the following script:
+
+```toml
+[tool.ppqs.scripts]
+task-init = """
+echo task init
+"""
+task-a = """
+ppqs task-init
+echo task 1
+"""
+task-b = """
+ppqs task-init
+echo task 2
+"""
+all-tasks = """
+ppqs task-a
+ppqs task-b
+"""
+```
+
+running `ppqs all-tasks` will only run `ppqs task-init` once:
+```
+$ ppqs all-tasks
+task init
+task 1
+task 2
+```
+
 The following only applies to scripts defined as lists of lists:
 
 * If a command argument is itself a list, it is concatenated into a path

{ppqs-2.1.0 → ppqs-2.2.0}/README.md

@@ -84,6 +84,36 @@ $ ppqs print-something Hi
 Hi
 ```
 
+`ppqs` can recursively run its own scripts, however it will only run any script
+once. For example, given the following script:
+
+```toml
+[tool.ppqs.scripts]
+task-init = """
+echo task init
+"""
+task-a = """
+ppqs task-init
+echo task 1
+"""
+task-b = """
+ppqs task-init
+echo task 2
+"""
+all-tasks = """
+ppqs task-a
+ppqs task-b
+"""
+```
+
+running `ppqs all-tasks` will only run `ppqs task-init` once:
+```
+$ ppqs all-tasks
+task init
+task 1
+task 2
+```
+
 The following only applies to scripts defined as lists of lists:
 
 * If a command argument is itself a list, it is concatenated into a path

{ppqs-2.1.0 → ppqs-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ppqs"
-version = "2.1.0"
+version = "2.2.0"
 description = "Python project quick scripts"
 authors = [
     { name = "Karl Wette", email = "karl.wette@anu.edu.au" },
@@ -15,7 +15,7 @@ dependencies = [
 ]
 readme = "README.md"
 license = "MIT"
-license-files = ["LICENSE"]
+license-files = ["LICENSES/MIT.txt"]
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
@@ -28,6 +28,15 @@ Issues = "https://github.com/kwwette/ppqs/issues"
 [project.scripts]
 ppqs = "py_proj_quick_scripts:cli"
 
+[tool.ruff.lint]
+select = [
+    "E4",
+    "E7",
+    "E9",
+    "EM",
+    "F",
+]
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "--cov=py_proj_quick_scripts --cov-report=term-missing --cov-fail-under=100"
@@ -53,14 +62,14 @@ pre-commit run -a
 [tool.ppqs.scripts.build]
 description = "Build project"
 script = """
-git clean -Xdf
+ppqs clean
 python -m build
 """
 
 [tool.ppqs.scripts.test]
 description = "Run tests"
 script = """
-pytest ...
+python -m pytest ...
 """
 
 [tool.ppqs.scripts.clean]

{ppqs-2.1.0 → ppqs-2.2.0/src/ppqs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.1.0
+Version: 2.2.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -10,7 +10,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-License-File: LICENSE
+License-File: LICENSES/MIT.txt
 Requires-Dist: tomli>=1.1.0; python_version < "3.11"
 Dynamic: license-file
 
@@ -100,6 +100,36 @@ $ ppqs print-something Hi
 Hi
 ```
 
+`ppqs` can recursively run its own scripts, however it will only run any script
+once. For example, given the following script:
+
+```toml
+[tool.ppqs.scripts]
+task-init = """
+echo task init
+"""
+task-a = """
+ppqs task-init
+echo task 1
+"""
+task-b = """
+ppqs task-init
+echo task 2
+"""
+all-tasks = """
+ppqs task-a
+ppqs task-b
+"""
+```
+
+running `ppqs all-tasks` will only run `ppqs task-init` once:
+```
+$ ppqs all-tasks
+task init
+task 1
+task 2
+```
+
 The following only applies to scripts defined as lists of lists:
 
 * If a command argument is itself a list, it is concatenated into a path

{ppqs-2.1.0 → ppqs-2.2.0}/src/ppqs.egg-info/SOURCES.txt

@@ -1,6 +1,6 @@
-LICENSE
 README.md
 pyproject.toml
+LICENSES/MIT.txt
 src/ppqs.egg-info/PKG-INFO
 src/ppqs.egg-info/SOURCES.txt
 src/ppqs.egg-info/dependency_links.txt

{ppqs-2.1.0 → ppqs-2.2.0}/src/py_proj_quick_scripts/__init__.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Karl Wette
+#
+# SPDX-License-Identifier: MIT
+
 import glob
 import os
 import re
@@ -13,7 +17,6 @@ else:  # pragma: no cover
     import tomli as tomllib
 
 __author__ = "Karl Wette"
-__version__ = "2.1.0"
 
 
 class MissingPyProjectError(Exception):
@@ -175,6 +178,16 @@ def parse_scripts(pyproject_path):
             "commands": script_commands,
         }
 
+    # Check that recursively run scripts exist
+    for script in scripts.values():
+        for command in script["commands"]:
+            cmd_exec = command[0]
+            if cmd_exec == "ppqs":
+                script_name_r = command[1]
+                if script_name_r not in scripts:
+                    msg = f"script {script_name_r}' does not exist"
+                    raise InvalidScriptError(pyproject_path, msg)
+
     return project_name, scripts
 
 
@@ -206,14 +219,38 @@ def print_help(project_name, scripts):
     )
 
 
-def run_script(script_name, script, argv, cwd):
+def run_script(scripts, script_name, argv, cwd, has_been_run):
     """
     Run a script.
     """
+
     col_width = shutil.get_terminal_size().columns
+
+    # Mark script has having been run
+    has_been_run.add(script_name)
+
+    script = scripts[script_name]
     for command in script["commands"]:
         cmd = []
 
+        cmd_exec = command.pop(0)
+        if cmd_exec == "ppqs":
+
+            # Recursively run script
+            # - silently ignore scripts which have already been run
+            script_name_r = command.pop(0)
+            if script_name_r not in has_been_run:
+                run_script(scripts, script_name_r, argv, cwd, has_been_run)
+            continue
+
+        elif cmd_exec == "python":
+
+            # Use same Python as ppqs to run Python scripts
+            cmd.append(sys.executable)
+
+        else:
+            cmd.append(cmd_exec)
+
         for arg in command:
             if isinstance(arg, Path):
                 if "*" in arg.parts[-1]:
@@ -244,25 +281,35 @@ def run_script(script_name, script, argv, cwd):
             raise SystemExit(retn.returncode)
 
 
-def regular_cli(argv):
+def bash_completion():  # pragma: no cover
     """
-    Parse regular command line.
+    Perform Bash command-line completion.
     """
 
     # Parse scripts
     pyproject_path = find_pyproject()
-    project_name, scripts = parse_scripts(pyproject_path)
-
-    # Parse command line
-    if argv[0] in ("-h", "-help", "--help"):
-        print_help(project_name, scripts)
-        raise SystemExit(1)
-    elif argv[0] not in scripts:
-        msg = f"unknown script '{argv[0]}'"
-        raise InvalidScriptError(pyproject_path, msg)
-    else:
-        cwd = pyproject_path.parent
-        run_script(argv[0], scripts[argv[0]], argv[1:], cwd)
+    _, scripts = parse_scripts(pyproject_path)
+
+    # Get current command line
+    line = os.environ["COMP_LINE"]
+    words = line.split()
+
+    if line.endswith(" ") and len(words) == 1:
+
+        # Complete full script name, e.g.:
+        # $ ppqs <TAB><TAB>
+        for script_name in scripts:
+            print(script_name)
+        return
+
+    if not line.endswith(" ") and len(words) == 2:
+
+        # Complete partial script name, e.g.:
+        # $ ppqs nam<TAB>
+        for script_name in scripts:
+            if script_name.startswith(words[-1]):
+                print(script_name)
+        return
 
 
 def cli(*argv):
@@ -274,32 +321,26 @@ def cli(*argv):
 
     if argv[0] == "--bash-completion":  # pragma: no cover
 
-        # Perform Bash completion
-        # - suppress any error output
+        # Perform Bash command-line completion, suppress any errors
         try:
-            pyproject_path = find_pyproject()
-            _, scripts = parse_scripts(pyproject_path)
-            line = os.environ["COMP_LINE"]
-            words = line.split()
-            if line.endswith(" ") and len(words) == 1:
-
-                # Complete full script name, e.g.:
-                # $ ppqs <TAB><TAB>
-                for script_name in scripts:
-                    print(script_name)
-
-            if not line.endswith(" ") and len(words) == 2:
-
-                # Complete partial script name, e.g.:
-                # $ ppqs nam<TAB>
-                for script_name in scripts:
-                    if script_name.startswith(words[-1]):
-                        print(script_name)
-
+            bash_completion()
         except Exception:
             pass
 
     else:
 
-        # Parse regular command line
-        regular_cli(argv)
+        # Parse scripts
+        pyproject_path = find_pyproject()
+        project_name, scripts = parse_scripts(pyproject_path)
+
+        # Parse command line
+        if argv[0] in ("-h", "-help", "--help"):
+            print_help(project_name, scripts)
+            raise SystemExit(1)
+        elif argv[0] not in scripts:
+            msg = f"unknown script '{argv[0]}'"
+            raise InvalidScriptError(pyproject_path, msg)
+        else:
+            cwd = pyproject_path.parent
+            has_been_run = set()
+            run_script(scripts, argv[0], argv[1:], cwd, has_been_run)

{ppqs-2.1.0 → ppqs-2.2.0}/test/test_cli.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Karl Wette
+#
+# SPDX-License-Identifier: MIT
+
 import os
 
 import pytest
@@ -34,6 +38,14 @@ def pyproject_path(tmp_path):
     script = [
         ["python", "-c", "import sys; print(*sys.argv[1:])", ["subdir", "*.txt"]],
     ]
+    [tool.ppqs.scripts.greeting]
+    script = "echo Hello"
+    [tool.ppqs.scripts.farewell]
+    script = '''
+    ppqs greeting
+    ppqs greeting
+    echo Goodbye
+    '''
     """
 
     write_file(pyproject_path, pyproject_toml)
@@ -109,3 +121,18 @@ def test_echo_wildcard(pyproject_path, capfd):
         captured = capfd.readouterr()
         assert captured.out == "subdir/a.txt subdir/b.txt\n".replace("/", os.sep)
         assert captured.err == ""
+
+
+def test_recursion(pyproject_path, capfd):
+    """
+    Test recursive script running.
+    """
+
+    with in_dir(pyproject_path.parent):
+        cli("farewell")
+        captured = capfd.readouterr()
+        assert captured.out == "Hello\nGoodbye\n"
+        assert captured.err == ""
+
+        with pytest.raises(InvalidScriptError):
+            cli("no-script")

{ppqs-2.1.0 → ppqs-2.2.0}/test/test_find_pyproject.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Karl Wette
+#
+# SPDX-License-Identifier: MIT
+
 import pytest
 
 from py_proj_quick_scripts import (

{ppqs-2.1.0 → ppqs-2.2.0}/test/test_parse_scripts.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Karl Wette
+#
+# SPDX-License-Identifier: MIT
+
 from contextlib import nullcontext
 from pathlib import Path
 
@@ -240,21 +244,14 @@ from . import in_dir, write_file
         ),
         pytest.param(
             """
-            [tool.ppqs.scripts]
-            paths = [
-                ["echo", ["a", "*.txt"]],
-            ]
+            [tool.ppqs.scripts.no-script]
+            script = "ppqs script-does-not-exist"
             """,
-            nullcontext(
-                {
-                    "paths": {
-                        "description": "Run paths script",
-                        "print-header": False,
-                        "commands": [["echo", Path("a", "*.txt")]],
-                    }
-                }
+            pytest.raises(
+                InvalidScriptError,
+                match="does not exist",
             ),
-            id="list script with path and valid wildcard",
+            id="recursive script does not exist",
         ),
     ],
 )

ppqs-2.1.0/LICENSE

@@ -1,18 +0,0 @@
-Copyright 2025 Karl Wette
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the “Software”), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.