runem 0.4.0__tar.gz → 0.5.0__tar.gz

{runem-0.4.0 → runem-0.5.0}/HISTORY.md

@@ -4,6 +4,47 @@ Changelog
 
 (unreleased)
 ------------
+- Merge pull request #71 from lursight/feat/pyproject. [Frank Harrison]
+
+  Feat/pyproject
+- Feat(pyproject): changes how we chose to install deps during a runem
+  deps-install. [Frank Harrison]
+- Feat(pyproject): tests the build works in ci/cd. [Frank Harrison]
+
+  I'd rather find out that this has failed before we get to the deploy-phase.
+- Feat(pyproject): makes the version dynamic again, reading from the
+  VERSION file. [Frank Harrison]
+- Feat(pyproject): ports setup.py to pyproject.toml, more future proof.
+  [Frank Harrison]
+
+  Makes the project more future-proof by moving to pyproject.
+- Merge pull request #70 from lursight/chore/typo. [Frank Harrison]
+
+  chore(docs): improves the help comments for --tags options
+- Chore(docs): improves the help comments for --tags options. [Frank
+  Harrison]
+- Merge pull request #69 from lursight/feat/silent. [Frank Harrison]
+
+  Feat/silent
+- Chore(pre-push): adds '--silent' option ahead of improving pre-push.
+  [Frank Harrison]
+- Chore(pre-push): fixes typo in error. [Frank Harrison]
+- Chore(help-test): updates the help text, I think after updating the
+  width in the test-render. [Frank Harrison]
+- Merge pull request #68 from lursight/chore/yarn_update. [Frank
+  Harrison]
+
+  Chore/yarn update
+- Chore(nodejs): try and enable corepack in ci/cd. [Frank Harrison]
+- Chore(nodejs): refreshes the yarn deps lock file. [Frank Harrison]
+- Chore(nodejs): removes the immutable options. [Frank Harrison]
+- Chore(nodejs): updates the yarn tool version we prefer. [Frank
+  Harrison]
+
+
+0.4.0 (2024-12-03)
+------------------
+- Release: version 0.4.0 🚀 [Frank Harrison]
 - Merge pull request #67 from lursight/feat/prettier_logging. [Frank
   Harrison]
 

{runem-0.4.0 → runem-0.5.0}/PKG-INFO

@@ -1,15 +1,23 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.4.0
+Version: 0.5.0
 Summary: Awesome runem created by lursight
-Home-page: https://github.com/lursight/runem/
 Author: lursight
+License: Specify your license here
+Project-URL: Homepage, https://github.com/lursight/runem/
+Keywords: example,runem
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: packaging
-Requires-Dist: PyYAML
-Requires-Dist: rich
-Requires-Dist: typing_extensions
+Requires-Dist: packaging>=22.0
+Requires-Dist: PyYAML>=5.0.0
+Requires-Dist: rich>10.0.0
+Requires-Dist: typing_extensions>3.0.0
 Provides-Extra: tests
 Requires-Dist: black==24.10.0; extra == "tests"
 Requires-Dist: coverage==7.5; extra == "tests"
@@ -153,3 +161,4 @@ Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
 The runem mission is to improve developer velocity at
 [Lursight Ltd.](https://lursight.com), read more about the runem
 [mission](https://lursight.github.io/runem/docs/mission.html).
+

runem-0.5.0/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "runem"
+description = "Awesome runem created by lursight"
+readme = "README.md"
+requires-python = ">=3.7"
+authors = [
+    { name = "lursight" }
+]
+license = { text = "Specify your license here" }
+keywords = ["example", "runem"]
+classifiers = [
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+dependencies = [
+  # `packaging` is probably not needed after moving to pyproject.toml
+  "packaging>=22.0",
+  "PyYAML>=5.0.0",
+
+  # For UI Elements
+  "rich>10.0.0",
+
+  # For pre python3.12 Unpack features we need the `typing_extensions` module to
+  # be installed.
+  "typing_extensions>3.0.0",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/lursight/runem/"
+
+[tool.setuptools.packages.find]
+exclude = ["tests", ".github"]
+
+[project.scripts]
+runem = "runem.__main__:main"
+
+[tool.setuptools.package-data]
+runem = ["VERSION"]
+
+[project.optional-dependencies]
+tests = [
+  # This requirements are for development and testing only, not for production.
+  "black==24.10.0",
+  "coverage==7.5",
+  "docformatter==1.7.5",
+  "flake8-bugbear==24.2.6",
+  "flake8==7.0.0",
+  "gitchangelog==3.0.4",
+  "isort==5.13.2",
+  "mkdocs==1.5.3",
+  "mypy==1.9.0",
+  "pydocstyle==6.3.0",
+  "pylint==3.1.0",
+  "pylama==8.4.1",
+  "pytest-cov==6.0.0",
+  "pytest-profiling==1.7.0",
+  "pytest-xdist==3.6.1",
+  "pytest==8.3.3",
+  "setuptools",
+  "termplotlib==0.3.9",
+  "tox",
+  "types-PyYAML==6.0.12.20240311",
+  "requests-mock==1.11.0",
+  "types-setuptools",
+]

runem-0.5.0/runem/VERSION

@@ -0,0 +1 @@
+0.5.0

{runem-0.4.0 → runem-0.5.0}/runem/command_line.py

@@ -53,6 +53,14 @@ def _get_argparse_help_formatter() -> typing.Any:
     return argparse.HelpFormatter
 
 
+def error_on_log_logic(verbose: bool, silent: bool) -> None:
+    """Simply errors if we get logical inconsistencies in the logging-logic."""
+    if verbose and silent:
+        log("cannot parse '--verbose' and '--silent'")
+        # error exit
+        sys.exit(1)
+
+
 def parse_args(
     config_metadata: ConfigMetadata, argv: typing.List[str]
 ) -> ConfigMetadata:
@@ -130,7 +138,9 @@ def parse_args(
         nargs="+",
         default=config_metadata.all_job_tags,
         help=(
-            "Only jobs with the given tags. "
+            # TODO: clarify the logic by which we add/remove jobs based on tags
+            #       e.g. exclusive-in, union, x-or etc.
+            "Only run jobs with the given tags. "
             f"Defaults to '{sorted(config_metadata.all_job_tags)}'."
         ),
         required=False,
@@ -238,6 +248,16 @@ def parse_args(
         required=False,
     )
 
+    parser.add_argument(
+        "--silent",
+        "-s",
+        dest="silent",
+        action=argparse.BooleanOptionalAction,
+        default=False,
+        help=("Whether to show warning messages or not. "),
+        required=False,
+    )
+
     parser.add_argument(
         "--spinner",
         dest="show_spinner",
@@ -271,6 +291,8 @@ def parse_args(
 
     args = parser.parse_args(argv[1:])
 
+    error_on_log_logic(args.verbose, args.silent)
+
     if args.show_root_path_and_exit:
         log(str(config_metadata.cfg_filepath.parent), decorate=False)
         # cleanly exit

{runem-0.4.0 → runem-0.5.0}/runem/config_parse.py

@@ -149,6 +149,7 @@ def parse_job_config(
     in_out_job_names: JobNames,
     in_out_phases: JobPhases,
     phase_order: OrderedPhases,
+    silent: bool = False,
 ) -> None:
     """Parses and validates a job-entry read in from disk.
 
@@ -208,6 +209,7 @@ def parse_job_config(
                 in_out_job_names,
                 in_out_phases,
                 phase_order,
+                warn_missing_phase=(not silent),
             )
     except KeyError as err:
         raise ValueError(
@@ -215,8 +217,11 @@ def parse_job_config(
         ) from err
 
 
-def parse_config(
-    config: Config, cfg_filepath: pathlib.Path, hooks_only: bool = False
+def parse_config(  # noqa: C901
+    config: Config,
+    cfg_filepath: pathlib.Path,
+    silent: bool = False,
+    hooks_only: bool = False,
 ) -> typing.Tuple[
     Hooks,  # hooks:
     OrderedPhases,  # phase_order:
@@ -282,7 +287,10 @@ def parse_config(
 
     if not phase_order:
         if not hooks_only:
-            warn("phase ordering not configured! Runs will be non-deterministic!")
+            if silent:  # pragma: no cover
+                pass
+            else:
+                warn("phase ordering not configured! Runs will be non-deterministic!")
             phase_order = tuple(job_phases)
 
     # now parse out the job_configs
@@ -301,6 +309,7 @@ def parse_config(
             in_out_job_names=job_names,
             in_out_phases=job_phases,
             phase_order=phase_order,
+            silent=silent,
         )
     return (
         hooks,
@@ -341,7 +350,9 @@ def generate_config(
 
 
 def _load_user_hooks_from_config(
-    user_config: Config, cfg_filepath: pathlib.Path
+    user_config: Config,
+    cfg_filepath: pathlib.Path,
+    silent: bool,
 ) -> Hooks:
     hooks: Hooks
     (
@@ -353,7 +364,7 @@ def _load_user_hooks_from_config(
         _,
         _,
         _,
-    ) = parse_config(user_config, cfg_filepath, hooks_only=True)
+    ) = parse_config(user_config, cfg_filepath, silent, hooks_only=True)
     return hooks
 
 
@@ -361,6 +372,7 @@ def load_config_metadata(
     config: Config,
     cfg_filepath: pathlib.Path,
     user_configs: typing.List[typing.Tuple[Config, pathlib.Path]],
+    silent: bool = False,
     verbose: bool = False,
 ) -> ConfigMetadata:
     hooks: Hooks
@@ -380,12 +392,14 @@ def load_config_metadata(
         job_names,
         job_phases,
         tags,
-    ) = parse_config(config, cfg_filepath)
+    ) = parse_config(config, cfg_filepath, silent)
 
     user_config: Config
     user_config_path: pathlib.Path
     for user_config, user_config_path in user_configs:
-        user_hooks: Hooks = _load_user_hooks_from_config(user_config, user_config_path)
+        user_hooks: Hooks = _load_user_hooks_from_config(
+            user_config, user_config_path, silent
+        )
         if user_hooks:
             if verbose:
                 log(f"hooks: loading user hooks from '{str(user_config_path)}'")

{runem-0.4.0 → runem-0.5.0}/runem/job_execute.py

@@ -11,7 +11,7 @@ from runem.config_metadata import ConfigMetadata
 from runem.informative_dict import ReadOnlyInformativeDict
 from runem.job import Job
 from runem.job_wrapper import get_job_wrapper
-from runem.log import error, log
+from runem.log import error, log, warn
 from runem.types.common import FilePathList, JobTags
 from runem.types.filters import FilePathListLookup
 from runem.types.runem_config import JobConfig
@@ -50,7 +50,8 @@ def job_execute_inner(
 
     if not file_list:
         # no files to work on
-        log(f"WARNING: skipping job '{label}', no files for job")
+        if not config_metadata.args.silent:
+            warn(f"skipping job '{label}', no files for job")
         return {
             "job": (f"{label}: no files!", timedelta(0)),
             "commands": [],

{runem-0.4.0 → runem-0.5.0}/runem/runem.py

@@ -37,7 +37,7 @@ from rich.spinner import Spinner
 from rich.text import Text
 
 from runem.blocking_print import RICH_CONSOLE
-from runem.command_line import parse_args
+from runem.command_line import error_on_log_logic, parse_args
 from runem.config import load_project_config, load_user_configs
 from runem.config_metadata import ConfigMetadata
 from runem.config_parse import load_config_metadata
@@ -67,12 +67,19 @@ def _determine_run_parameters(argv: typing.List[str]) -> ConfigMetadata:
 
     Return a ConfigMetadata object with all the required information.
     """
+
+    # Because we want to be able to show logging whilst parsing .runem.yml config, we
+    # need to check the state of the logging-verbosity switches here, manually, as well.
+    verbose = "--verbose" in argv
+    silent = ("--silent" in argv) or ("-s" in argv)
+    error_on_log_logic(verbose, silent)
+
     config: Config
     cfg_filepath: pathlib.Path
     config, cfg_filepath = load_project_config()
     user_configs: typing.List[typing.Tuple[Config, pathlib.Path]] = load_user_configs()
     config_metadata: ConfigMetadata = load_config_metadata(
-        config, cfg_filepath, user_configs, verbose=("--verbose" in argv)
+        config, cfg_filepath, user_configs, silent, verbose=("--verbose" in argv)
     )
 
     # Now we parse the cli arguments extending them with information from the

{runem-0.4.0 → runem-0.5.0}/runem.egg-info/PKG-INFO

@@ -1,15 +1,23 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.4.0
+Version: 0.5.0
 Summary: Awesome runem created by lursight
-Home-page: https://github.com/lursight/runem/
 Author: lursight
+License: Specify your license here
+Project-URL: Homepage, https://github.com/lursight/runem/
+Keywords: example,runem
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: packaging
-Requires-Dist: PyYAML
-Requires-Dist: rich
-Requires-Dist: typing_extensions
+Requires-Dist: packaging>=22.0
+Requires-Dist: PyYAML>=5.0.0
+Requires-Dist: rich>10.0.0
+Requires-Dist: typing_extensions>3.0.0
 Provides-Extra: tests
 Requires-Dist: black==24.10.0; extra == "tests"
 Requires-Dist: coverage==7.5; extra == "tests"
@@ -153,3 +161,4 @@ Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
 The runem mission is to improve developer velocity at
 [Lursight Ltd.](https://lursight.com), read more about the runem
 [mission](https://lursight.github.io/runem/docs/mission.html).
+

{runem-0.4.0 → runem-0.5.0}/runem.egg-info/SOURCES.txt

@@ -3,9 +3,8 @@ HISTORY.md
 LICENSE
 MANIFEST.in
 README.md
-requirements-test.txt
-requirements.txt
-setup.py
+pyproject.toml
+setup.cfg
 runem/VERSION
 runem/__init__.py
 runem/__main__.py
@@ -47,6 +46,12 @@ runem/types/hooks.py
 runem/types/options.py
 runem/types/runem_config.py
 runem/types/types_jobs.py
+scripts/test_hooks/__init__.py
+scripts/test_hooks/json_validators.py
+scripts/test_hooks/py.py
+scripts/test_hooks/py.typed
+scripts/test_hooks/runem_hooks.py
+scripts/test_hooks/yarn.py
 tests/__init__.py
 tests/conftest.py
 tests/intentional_test_error.py

{runem-0.4.0 → runem-0.5.0}/runem.egg-info/requires.txt

@@ -1,7 +1,7 @@
-packaging
-PyYAML
-rich
-typing_extensions
+packaging>=22.0
+PyYAML>=5.0.0
+rich>10.0.0
+typing_extensions>3.0.0
 
 [tests]
 black==24.10.0

runem-0.5.0/runem.egg-info/top_level.txt

@@ -0,0 +1,5 @@
+dist
+docs
+runem
+scripts
+tests

runem-0.5.0/scripts/test_hooks/json_validators.py

@@ -0,0 +1,32 @@
+import pathlib
+
+from typing_extensions import Unpack
+
+from runem.run_command import run_command
+from runem.types import FilePathList, JobKwargs
+
+
+def _json_validate(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    label = kwargs["label"]
+    json_files: FilePathList = kwargs["file_list"]
+    json_with_comments = (
+        "cspell.json",
+        "tsconfig.spec.json",
+        "launch.json",
+        "settings.json",
+    )
+    for json_file in json_files:
+        json_path = pathlib.Path(json_file)
+        if not json_path.exists():
+            raise RuntimeError(
+                f"could not find '{str(json_path)}, in {pathlib.Path('.').absolute()}"
+            )
+        if json_path.name in json_with_comments:
+            # until we use a validator that allows comments in json, skip these
+            continue
+
+        cmd = ["python", "-m", "json.tool", f"{json_file}"]
+        kwargs["label"] = f"{label} {json_file}"
+        run_command(cmd=cmd, **kwargs)