ppqs 2.5.1__tar.gz → 2.6.0__tar.gz

ppqs-2.6.0/LICENSES/CC0-1.0.txt

@@ -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.

{ppqs-2.5.1/src/ppqs.egg-info → ppqs-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.5.1
+Version: 2.6.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSES/MIT.txt
+License-File: LICENSES/CC0-1.0.txt
 Requires-Dist: tomli>=1.1.0; python_version < "3.11"
 Dynamic: license-file
 

{ppqs-2.5.1 → ppqs-2.6.0}/pyproject.toml

@@ -14,7 +14,7 @@ dependencies = [
 ]
 readme = "README.md"
 license = "MIT"
-license-files = ["LICENSES/MIT.txt"]
+license-files = ["LICENSES/MIT.txt", "LICENSES/CC0-1.0.txt"]
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",

{ppqs-2.5.1 → ppqs-2.6.0/src/ppqs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.5.1
+Version: 2.6.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSES/MIT.txt
+License-File: LICENSES/CC0-1.0.txt
 Requires-Dist: tomli>=1.1.0; python_version < "3.11"
 Dynamic: license-file
 

{ppqs-2.5.1 → ppqs-2.6.0}/src/ppqs.egg-info/SOURCES.txt

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

{ppqs-2.5.1 → ppqs-2.6.0}/src/py_proj_quick_scripts/__init__.py

@@ -19,14 +19,12 @@ else:  # pragma: no cover
     import tomli as tomllib
 
 __author__ = "Karl Wette"
-__version__ = "2.5.1"
+__version__ = "2.6.0"
 
 
 class MissingPyProjectError(Exception):
     """Raise if 'pyproject.toml' could not be found."""
 
-    pass
-
 
 class InvalidScriptError(Exception):
     """Raise for invalid 'pyproject.toml' script errors."""
@@ -41,6 +39,10 @@ class InvalidScriptError(Exception):
         return f"{self.pyproject_path}: {self.msg}"
 
 
+class InvalidScriptCallError(InvalidScriptError):
+    """Raise for invalid calls of 'pyproject.toml' scripts."""
+
+
 def find_pyproject():
     """Look for pyproject.toml in current/parent directories."""
 
@@ -210,6 +212,13 @@ def print_help(project_name, scripts):
     """Print help."""
     script_names = ",".join(scripts.keys())
     max_script_name_len = max(len(script_name) for script_name in scripts)
+    help_header = textwrap.dedent(f"""\
+        Quick scripts for Python project: {project_name}
+
+        Usage: ppqs {{{script_names}}}
+
+        Scripts:
+        """)
     list_of_scripts = "\n".join(
         "  "
         + script_name.ljust(max_script_name_len, " ")
@@ -218,30 +227,28 @@ def print_help(project_name, scripts):
         + script["description"][1:]
         for script_name, script in scripts.items()
     )
-    print(
-        textwrap.dedent(
-            f"""\
-            Quick scripts for Python project: {project_name}
+    print(help_header + list_of_scripts + f"\n\nppqs version: {__version__}")
 
-            Usage: ppqs {{{script_names}}}
 
-            Scripts:
-            """
-        )
-        + list_of_scripts
-        + f"\n\nppqs version: {__version__}"
-    )
-
-
-def run_script(scripts, script_name, argv, cwd, has_been_run):
+def run_script(pyproject_path, scripts, script_name, argv, cwd, has_been_run):
     """Run a script."""
 
     col_width = shutil.get_terminal_size().columns
 
-    # Mark script has having been run
+    # Mark script as having been run
     has_been_run.add(script_name)
 
+    # Get script
     script = scripts[script_name]
+
+    # Check that script was correctly passed arguments
+    script_takes_argv = any("..." in command for command in script["commands"])
+    if not script_takes_argv and len(argv) > 0:
+        msg = "script '{}' does not take arguments ('{}')".format(
+            script_name, "', '".join(argv)
+        )
+        raise InvalidScriptCallError(pyproject_path, msg)
+
     for command in script["commands"]:
         cmd = []
 
@@ -269,7 +276,9 @@ def run_script(scripts, script_name, argv, cwd, has_been_run):
             # - silently ignore scripts which have already been run
             script_name_r = cmd[1]
             if script_name_r not in has_been_run:
-                run_script(scripts, script_name_r, cmd[2:], cwd, has_been_run)
+                run_script(
+                    pyproject_path, scripts, script_name_r, cmd[2:], cwd, has_been_run
+                )
             continue
 
         elif cmd[0] == "python":
@@ -278,7 +287,7 @@ def run_script(scripts, script_name, argv, cwd, has_been_run):
             cmd[0] = sys.executable
 
             # If virtual environment is present, try to use its Python
-            if "VIRTUAL_ENV" in os.environ:
+            if "VIRTUAL_ENV" in os.environ:  # pragma: no cover
                 venv_python = Path(os.environ["VIRTUAL_ENV"]) / "bin" / "python"
                 if venv_python.exists() and os.access(venv_python, os.X_OK):
                     cmd[0] = str(venv_python)
@@ -381,4 +390,4 @@ def cli(*argv):
         else:
             cwd = pyproject_path.parent
             has_been_run = set()
-            run_script(scripts, argv[0], argv[1:], cwd, has_been_run)
+            run_script(pyproject_path, scripts, argv[0], argv[1:], cwd, has_been_run)

{ppqs-2.5.1 → ppqs-2.6.0}/test/test_cli.py

@@ -8,7 +8,7 @@ import os
 
 import pytest
 
-from py_proj_quick_scripts import InvalidScriptError, cli
+from py_proj_quick_scripts import InvalidScriptCallError, InvalidScriptError, cli
 
 from . import in_dir, write_file
 
@@ -120,5 +120,8 @@ def test_recursion(pyproject_path, capfd):
         assert captured.out == "Hello friend!\nGoodbye\n"
         assert captured.err == ""
 
+        with pytest.raises(InvalidScriptCallError):
+            cli("farewell", "someone")
+
         with pytest.raises(InvalidScriptError):
             cli("no-script")