etlplus 0.4.7__tar.gz → 0.4.8__tar.gz

{etlplus-0.4.7/etlplus.egg-info → etlplus-0.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.4.7
+Version: 0.4.8
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -306,6 +306,19 @@ For YAML-driven pipelines executed end-to-end (extract → validate → transfor
 - Authoring: [`docs/pipeline-guide.md`](docs/pipeline-guide.md)
 - Runner API and internals: [`docs/run-module.md`](docs/run-module.md)
 
+CLI quick reference for pipelines:
+
+```bash
+# List jobs or show a pipeline summary
+etlplus list --config examples/configs/pipeline.yml --jobs
+etlplus list --config examples/configs/pipeline.yml --summary
+
+# Run a job
+etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers
+
+# Deprecated shim (will be removed): etlplus pipeline
+```
+
 ### Complete ETL Pipeline Example
 
 ```bash

{etlplus-0.4.7 → etlplus-0.4.8}/README.md

@@ -264,6 +264,19 @@ For YAML-driven pipelines executed end-to-end (extract → validate → transfor
 - Authoring: [`docs/pipeline-guide.md`](docs/pipeline-guide.md)
 - Runner API and internals: [`docs/run-module.md`](docs/run-module.md)
 
+CLI quick reference for pipelines:
+
+```bash
+# List jobs or show a pipeline summary
+etlplus list --config examples/configs/pipeline.yml --jobs
+etlplus list --config examples/configs/pipeline.yml --summary
+
+# Run a job
+etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers
+
+# Deprecated shim (will be removed): etlplus pipeline
+```
+
 ### Complete ETL Pipeline Example
 
 ```bash

{etlplus-0.4.7 → etlplus-0.4.8}/docs/pipeline-guide.md

@@ -378,31 +378,32 @@ jobs:
 Once you have a pipeline YAML, you can run jobs either from the
 command line or directly from Python.
 
-### CLI: `etlplus pipeline` and `etlplus run`
+### CLI: `etlplus list` (inspect) and `etlplus run` (execute)
 
-List jobs defined in a pipeline file:
+List jobs or show a summary from a pipeline file:
 
 ```bash
-etlplus pipeline --config examples/configs/pipeline.yml --list
+etlplus list --config examples/configs/pipeline.yml --jobs
+etlplus list --config examples/configs/pipeline.yml --summary
 ```
 
 Run a specific job end-to-end (extract → validate → transform → load):
 
 ```bash
-etlplus pipeline --config examples/configs/pipeline.yml --run file_to_file_customers
-
-# Equivalent, using the dedicated run command
 etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers
 ```
 
 Notes:
 
-- Both commands read the same YAML schema described in this guide.
+- These commands read the same YAML schema described in this guide.
 - Environment-variable substitution (e.g. `${GITHUB_TOKEN}`) is applied the same way as when loading
   configs via the Python API.
 - For more details on the orchestration implementation, see
   [Runner internals: etlplus.run](run-module.md).
 
+Deprecated: `etlplus pipeline` is still available as a shim but will be removed in a future release;
+prefer `list` and `run`.
+
 ### Python: `etlplus.run.run`
 
 To trigger a job programmatically, use the high-level runner function exposed by the package:

{etlplus-0.4.7 → etlplus-0.4.8}/etlplus/cli/app.py

@@ -782,8 +782,21 @@ def list_cmd(
         '--pipelines',
         help='List ETL pipelines',
     ),
-    sources: bool = typer.Option(False, '--sources', help='List data sources'),
-    targets: bool = typer.Option(False, '--targets', help='List data targets'),
+    sources: bool = typer.Option(
+        False,
+        '--sources',
+        help='List data sources',
+    ),
+    summary: bool = typer.Option(
+        False,
+        '--summary',
+        help='Show pipeline summary (name, version, sources, targets, jobs)',
+    ),
+    targets: bool = typer.Option(
+        False,
+        '--targets',
+        help='List data targets',
+    ),
     transforms: bool = typer.Option(
         False,
         '--transforms',
@@ -805,6 +818,8 @@ def list_cmd(
         If True, list ETL pipelines.
     sources : bool, optional
         If True, list data sources.
+    summary : bool, optional
+        If True, show pipeline summary (name, version, sources, targets, jobs).
     targets : bool, optional
         If True, list data targets.
     transforms : bool, optional
@@ -820,6 +835,7 @@ def list_cmd(
         state,
         command='list',
         config=config,
+        summary=summary,
         pipelines=pipelines,
         jobs=jobs,
         sources=sources,
@@ -953,7 +969,7 @@ def pipeline_cmd(
     ),
 ) -> int:
     """
-    Inspect or run a pipeline YAML configuration.
+    Deprecated wrapper to inspect or run a pipeline YAML configuration.
 
     Parameters
     ----------

{etlplus-0.4.7 → etlplus-0.4.8}/etlplus/cli/handlers.py

@@ -117,6 +117,8 @@ def _list_sections(
         Metadata output for the list command.
     """
     sections: dict[str, Any] = {}
+    if getattr(args, 'jobs', False):
+        sections['jobs'] = _pipeline_summary(cfg)['jobs']
     if getattr(args, 'pipelines', False):
         sections['pipelines'] = [cfg.name]
     if getattr(args, 'sources', False):
@@ -598,6 +600,12 @@ def cmd_pipeline(
     int
         Zero on success.
     """
+    print(
+        'DEPRECATED: use "etlplus list --summary|--jobs" or '
+        '"etlplus run --job/--pipeline" instead of "etlplus pipeline".',
+        file=sys.stderr,
+    )
+
     cfg = load_pipeline_config(args.config, substitute=True)
 
     list_flag = getattr(args, 'list', False) or getattr(args, 'jobs', False)
@@ -635,6 +643,10 @@ def cmd_list(args: argparse.Namespace) -> int:
         Zero on success.
     """
     cfg = load_pipeline_config(args.config, substitute=True)
+    if getattr(args, 'summary', False):
+        print_json(_pipeline_summary(cfg))
+        return 0
+
     print_json(_list_sections(cfg, args))
     return 0
 

{etlplus-0.4.7 → etlplus-0.4.8}/etlplus/cli/main.py

@@ -422,8 +422,9 @@ def create_parser() -> argparse.ArgumentParser:
     pipe_parser = subparsers.add_parser(
         'pipeline',
         help=(
-            'Inspect or run pipeline YAML (see '
-            f'{PROJECT_URL}/blob/main/docs/pipeline-guide.md)'
+            'DEPRECATED: use "list" (for summary/jobs) or "run" (to execute); '
+            'see '
+            f'{PROJECT_URL}/blob/main/docs/pipeline-guide.md'
         ),
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
@@ -446,6 +447,11 @@ def create_parser() -> argparse.ArgumentParser:
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     _add_config_option(list_parser)
+    _add_boolean_flag(
+        list_parser,
+        name='jobs',
+        help_text='List ETL jobs',
+    )
     _add_boolean_flag(
         list_parser,
         name='pipelines',
@@ -456,6 +462,13 @@ def create_parser() -> argparse.ArgumentParser:
         name='sources',
         help_text='List data sources',
     )
+    _add_boolean_flag(
+        list_parser,
+        name='summary',
+        help_text=(
+            'Show pipeline summary (name, version, sources, targets, jobs)'
+        ),
+    )
     _add_boolean_flag(
         list_parser,
         name='targets',

{etlplus-0.4.7 → etlplus-0.4.8/etlplus.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.4.7
+Version: 0.4.8
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -306,6 +306,19 @@ For YAML-driven pipelines executed end-to-end (extract → validate → transfor
 - Authoring: [`docs/pipeline-guide.md`](docs/pipeline-guide.md)
 - Runner API and internals: [`docs/run-module.md`](docs/run-module.md)
 
+CLI quick reference for pipelines:
+
+```bash
+# List jobs or show a pipeline summary
+etlplus list --config examples/configs/pipeline.yml --jobs
+etlplus list --config examples/configs/pipeline.yml --summary
+
+# Run a job
+etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers
+
+# Deprecated shim (will be removed): etlplus pipeline
+```
+
 ### Complete ETL Pipeline Example
 
 ```bash

{etlplus-0.4.7 → etlplus-0.4.8}/examples/README.md

@@ -44,12 +44,12 @@ CLI examples:
 
 ```bash
 # List jobs defined in a pipeline file
-etlplus pipeline --config examples/configs/pipeline.yml --list
+etlplus list --config examples/configs/pipeline.yml --jobs
 
-# Run a specific job end-to-end
-etlplus pipeline --config examples/configs/pipeline.yml --run file_to_file_customers
+# Show a pipeline summary (name, version, sources, targets, jobs)
+etlplus list --config examples/configs/pipeline.yml --summary
 
-# Equivalent, using the dedicated run command
+# Run a specific job end-to-end
 etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers
 ```
 

{etlplus-0.4.7 → etlplus-0.4.8}/tests/integration/test_i_pipeline_smoke.py

@@ -2,12 +2,13 @@
 :mod:`tests.integration.test_i_pipeline_smoke` module.
 
 Pipeline smoke integration test suite exercising a minimal file→file job via
-the CLI. Parametrized to verify both empty and non-empty inputs.
+the CLI (using the deprecated-free path). Parametrized to verify both empty
+and non-empty inputs.
 
 Notes
 -----
 - Builds a transient pipeline YAML string per test run.
-- Invokes ``etlplus pipeline --run <job>`` end-to-end.
+- Invokes ``etlplus run --job <job>`` end-to-end.
 - Validates output file contents against input data shape.
 """
 
@@ -85,7 +86,7 @@ class TestPipelineSmoke:
 
         code, out, err = cli_invoke(
             (
-                'pipeline',
+                'run',
                 '--config',
                 str(cfg_path),
                 '--job',