runem 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

runem/run_command.py

@@ -37,7 +37,7 @@ def run_command(  # noqa: C901 # pylint: disable=too-many-branches
         valid_exit_ids = (0,)
 
     # create a new env with overrides
-    run_env = {"LANG_DO_PRINTS": "False"}
+    run_env: typing.Dict[str, str] = {"LANG_DO_PRINTS": "False"}
 
     if verbose:
         run_env = {"LANG_DO_PRINTS": "True"}
@@ -58,28 +58,28 @@ def run_command(  # noqa: C901 # pylint: disable=too-many-branches
     if env_overrides:
         env_overrides_dict = env_overrides
     # merge the overrides into the env
-    run_env = {**run_env, **os.environ.copy(), **env_overrides_dict}
+    run_env = {
+        **run_env,
+        **os.environ.copy(),
+        **env_overrides_dict,
+    }
+
+    run_env_param: typing.Optional[typing.Dict[str, str]] = None
+    if run_env:
+        run_env_param = run_env
 
     if verbose:
         print("lursight: test: " + "=" * TERMINAL_WIDTH)
 
     process: subprocess.CompletedProcess
     try:
-        if run_env:
-            process = subprocess.run(
-                cmd,
-                check=False,  # Do NOT throw on non-zero exit
-                env=run_env,
-                stdout=subprocess.PIPE,
-                stderr=subprocess.STDOUT,
-            )  # raise on non-zero
-        else:
-            process = subprocess.run(
-                cmd,
-                check=False,  # Do NOT throw on non-zero exit
-                stdout=subprocess.PIPE,
-                stderr=subprocess.STDOUT,
-            )  # raise on non-zero
+        process = subprocess.run(
+            cmd,
+            check=False,  # Do NOT throw on non-zero exit
+            env=run_env_param,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+        )  # raise on non-zero
         if process.returncode not in valid_exit_ids:
             valid_exit_strs = ",".join([str(exit_code) for exit_code in valid_exit_ids])
             raise RuntimeError(

runem/runem.py

@@ -910,10 +910,11 @@ def _plot_times(
     overall_run_time: timedelta,
     phase_run_oder: OrderedPhases,
     timing_data: TimingDataPhase,
-):
+) -> timedelta:
     """Prints a report to terminal on how well we performed."""
     labels: typing.List[str] = []
     times: typing.List[float] = []
+    job_time_sum: timedelta = timedelta()  # init to 0
     for phase in phase_run_oder:
         # print(f"Phase '{phase}' jobs took:")
         phase_total_time: float = 0.0
@@ -923,6 +924,7 @@ def _plot_times(
                 continue
             labels.append(f"│├{phase}.{label}")
             times.append(job_time.total_seconds())
+            job_time_sum += job_time
             phase_total_time += job_time.total_seconds()
         labels.insert(phase_start_idx, f"├{phase} (total)")
         times.insert(phase_start_idx, phase_total_time)
@@ -940,6 +942,9 @@ def _plot_times(
         for label, time in zip(labels, times):
             print(f"{label}: {time}s")
 
+    time_saved: timedelta = job_time_sum - overall_run_time
+    return time_saved
+
 
 def _main(  # noqa: C901 # pylint: disable=too-many-branches,too-many-statements
     argv: typing.List[str],
@@ -1004,8 +1009,8 @@ def _main(  # noqa: C901 # pylint: disable=too-many-branches,too-many-statements
             continue
         print(
             (
-                f"Running '{phase}' with {num_concurrent_procs} concurrent "
-                f"processes across {len(jobs)} jobs"
+                f"Running '{phase}' with {num_concurrent_procs} workers "
+                f"processesing {len(jobs)} jobs"
             )
         )
         with multiprocessing.Pool(processes=num_concurrent_procs) as pool:
@@ -1034,12 +1039,17 @@ def timed_main(argv: typing.List[str]) -> None:
     phase_run_oder, job_times = _main(argv)
     end = timer()
     time_taken: timedelta = timedelta(seconds=end - start)
-    _plot_times(
+    time_saved: timedelta = _plot_times(
         overall_run_time=time_taken,
         phase_run_oder=phase_run_oder,
         timing_data=job_times,
     )
-    print(f"DONE: ran in: {time_taken.total_seconds()}s")
+    print(
+        (
+            f"DONE: runem took: {time_taken.total_seconds()}s, "
+            f"saving you {time_saved.total_seconds()}s"
+        )
+    )
 
 
 if __name__ == "__main__":

{runem-0.0.3.dist-info → runem-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.0.3
+Version: 0.0.5
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight
@@ -31,7 +31,7 @@ Requires-Dist: types-setuptools ; extra == 'test'
 
 # Run 'em: Run your developer-local tasks faster
 
-## Overview
+## 1. Overview
 
 `runem` (run 'em) is a utility designed to optimise the process of running developer jobs concurrently.
 
@@ -40,21 +40,26 @@ Job definitions are declarative and simple and the reports show how long each jo
 The name "runem" is derived from the fusion of "run" and "them," encapsulating the essence of executing tasks seamlessly.
 
 - [Run 'em: Run your developer-local tasks faster](#run-em-run-your-developer-local-tasks-faster)
-  - [Overview](#overview)
-  - [Features](#features)
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [1. Basic Usage](#1-basic-usage)
-    - [2. Using Help to get an Overview of Your Jobs](#2-using-help-to-get-an-overview-of-your-jobs)
-    - [3. Configuration](#3-configuration)
-      - [3.1. `config` - Run 'em global config](#31-config---run-em-global-config)
-      - [3.2. `job` - Job config](#32-job---job-config)
+  - [1. Overview](#1-overview)
+  - [2. Features](#2-features)
+  - [3. Installation](#3-installation)
+  - [4. Basic Usage](#4-basic-usage)
+    - [4.1. Tag filters](#41-tag-filters)
+      - [4.1.1. Run jobs only with the 'lint' tag:](#411-run-jobs-only-with-the-lint-tag)
+      - [4.1.2. If you want to lint all code _except_ nodejs code (and you have the apprpriate tags):](#412-if-you-want-to-lint-all-code-except-nodejs-code-and-you-have-the-apprpriate-tags)
+    - [4.2. phase filters](#42-phase-filters)
+      - [4.2.1 Focus on a phase](#421-focus-on-a-phase)
+      - [4.2.2 Exclude slow phases temporarily](#422-exclude-slow-phases-temporarily)
+  - [5. Using Help to get an Overview of Your Jobs](#5-using-help-to-get-an-overview-of-your-jobs)
+  - [6. Configuration](#6-configuration)
+    - [6.1. `config` - Run 'em global config](#61-config---run-em-global-config)
+    - [6.2. `job` - Job config](#62-job---job-config)
 - [Contributing to and supporting runem](#contributing-to-and-supporting-runem)
   - [Development](#development)
   - [Sponsor](#sponsor)
 
 
-## Features
+## 2. Features
 
 - **Tagged Jobs:** Use tagging to define which type of jobs you want to run, be it `pre-commit`, `lint`, `test` or in multi-project codebases to split between running `python`, `node.js` or `c++` jobs, depending on the context you are working in!
 
@@ -62,22 +67,69 @@ The name "runem" is derived from the fusion of "run" and "them," encapsulating t
   
 - **Data-Driven Test Management:** Drive your tests with data, making it easy to adapt and scale your testing suite to various scenarios, allowing you to execute, track, and analyze your dev-ops suite with ease.
 
-## Installation
+## 3. Installation
 
 ```bash
 pip install runem
 ```
-## Usage
 
-### 1. Basic Usage
+## 4. Basic Usage
 
 ```bash
-$ python -m runem
+$ runem [--tags tag1,tag2,tag3] [--not-tags tag1,tag2,tag3] \
+        [--phases phaseX, phaseY] \
+        [--MY-OPTION] [--not-MY-OPTION] 
 #or
-$ runem
+$ python -m runem [--tags tag1,tag2,tag3] [--not-tags tag1,tag2,tag3] \
+                  [--phases phaseX, phaseY] \
+                  [--MY-OPTION] [--not-MY-OPTION] 
 ```
 
-### 2. Using Help to get an Overview of Your Jobs
+### 4.1. Tag filters
+You can control which types of jobs to run via tag. Just tag the job in the config and then from the command-line you can add `--tags` or `--not-tags` to refine exactly which jobs will be run. 
+
+To run only run jobs that have the `python` tag (for example, you define the tags) you would do the following:
+
+```bash
+runem --tags python
+```
+
+#### 4.1.1. Run jobs only with the 'lint' tag:
+
+```bash
+runem --tags lint
+```
+
+#### 4.1.2. If you want to lint all code _except_ nodejs code (and you have the apprpriate tags):
+
+```bash
+runem --tags lint --not-tags deprecated
+```
+
+### 4.2. phase filters
+
+Sometimes you know you just want to run a specific phase to iterate quickly within that phase-context. 
+
+#### 4.2.1 Focus on a phase
+
+For example you might want to run the 'reformat' phase as you're preparing a commit and are just made cosmetic changes e.g. updating the docs.
+
+```bash
+runem --phase reformat
+```
+
+#### 4.2.2 Exclude slow phases temporarily
+
+Or you are tightly iterating on the 'test' phase coverage and do not care about formating as long as you can see your coverage results ASAP, but everything that comes after that stage. So if you have 4 stages `bootstrap`, `pre-run`, `reformat`, `test` and `verify` you can exlude the slower reformat-stage with the following and everything else will run
+
+```bash
+runem --not-phase pre-run reformat
+```
+
+**Note:** The `--tags` and `--not-tags` options can be used in combination to further refine task execution based on your requirements.
+
+
+## 5. Using Help to get an Overview of Your Jobs
 
 The `--help` switch will show you a full list of all the configured job-tasks, the tags and the override options, describing how to configure a specific run.
 ```bash
@@ -166,7 +218,7 @@ job-param overrides:
 ```
 </details>
 
-### 3. Configuration
+## 6. Configuration
 
 `runem` searches for `.runem.yml` and will pre-load the command-line options with
 
@@ -175,7 +227,7 @@ Configuration is Yaml and consists of two main configurations, `config` and `job
 - `config` describes how the jobs should be run.
 - each `job`  entry descibe a job-task, such and running unit-tests, linting or running any other type of command.
 
-#### 3.1. `config` - Run 'em global config
+### 6.1. `config` - Run 'em global config
 
 - **phases:** 
   - *Description:* Specifies the different phases of the testing process, in the order they are to be run. Each job will be run under a specific phase.
@@ -195,7 +247,7 @@ Configuration is Yaml and consists of two main configurations, `config` and `job
   - **desc:** Provides a description of the option.
   - **alias:** (Optional) Provides an alias for the option if specified.
 
-#### 3.2. `job` - Job config
+### 6.2. `job` - Job config
 - **job:**
   - *Description:* Represents a specific job task that is to be run asynchorounsly.
   - *Fields:*
@@ -261,6 +313,7 @@ Configuration is Yaml and consists of two main configurations, `config` and `job
             - subproject4
             - pretty
 
+
 ---
 # Contributing to and supporting runem
 

runem-0.0.5.dist-info/RECORD

@@ -0,0 +1,14 @@
+runem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runem/__main__.py,sha256=dsOiVZegpfK9JOs5n7UmbX5iwwbj7iFkEbLoVeEgAn4,136
+runem/base.py,sha256=EZfR7FIlwEdU9Vfe47Wk2DOO8GQqpKxxLNKp6YHueZ4,316
+runem/cli.py,sha256=YFwon1P7uSpAYNuJxe2f0wo0HpI3OYTQ-UBWx6xU1iY,145
+runem/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runem/run_command.py,sha256=HycJUwalnItL9gVtIjrg2QyxW0lLcnEUdbmCRkbxFS4,3700
+runem/runem.py,sha256=tLhVEZVdmhV6HjMPrBu03-kSB_0A3JWDHothrhW1BWE,33885
+scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runem-0.0.5.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+runem-0.0.5.dist-info/METADATA,sha256=h0sa0E1DWzu6_ij0-PChRm5uZQ03ebGY7MunqI8_K1c,14962
+runem-0.0.5.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+runem-0.0.5.dist-info/entry_points.txt,sha256=nu0g_vBeuPihYtimbtlNusxWovylMppvJ8UxdJlJfvM,46
+runem-0.0.5.dist-info/top_level.txt,sha256=rd8MZEjuPdjwXuLZlbdZEg8_WGxrY1c8M36uHjNjbNk,14
+runem-0.0.5.dist-info/RECORD,,

runem-0.0.3.dist-info/RECORD

@@ -1,13 +0,0 @@
-runem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-runem/__main__.py,sha256=dsOiVZegpfK9JOs5n7UmbX5iwwbj7iFkEbLoVeEgAn4,136
-runem/base.py,sha256=EZfR7FIlwEdU9Vfe47Wk2DOO8GQqpKxxLNKp6YHueZ4,316
-runem/cli.py,sha256=YFwon1P7uSpAYNuJxe2f0wo0HpI3OYTQ-UBWx6xU1iY,145
-runem/run_command.py,sha256=JVQXalGCSmMY6YB5bgHLkKEODCxi5fnE4UyGpoEcImg,3826
-runem/runem.py,sha256=JY216pvzaGEo7FGmuam4dEb9QGmmGGfXbQbLPYNV4f4,33580
-scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-runem-0.0.3.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
-runem-0.0.3.dist-info/METADATA,sha256=0U7X2MmzZO9aDCkj_MsGId7FAYggtvKKXpbHoI1x1Nc,12674
-runem-0.0.3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-runem-0.0.3.dist-info/entry_points.txt,sha256=nu0g_vBeuPihYtimbtlNusxWovylMppvJ8UxdJlJfvM,46
-runem-0.0.3.dist-info/top_level.txt,sha256=rd8MZEjuPdjwXuLZlbdZEg8_WGxrY1c8M36uHjNjbNk,14
-runem-0.0.3.dist-info/RECORD,,