etlplus 0.5.2__tar.gz → 0.5.4__tar.gz

{etlplus-0.5.2/etlplus.egg-info → etlplus-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.5.2
+Version: 0.5.4
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -90,6 +90,14 @@ package and command-line interface for data extraction, validation, transformati
 
 ## Features
 
+- **Check** data pipeline definitions before running them:
+  - Summarize jobs, sources, targets, and transforms
+  - Confirm configuration changes by printing focused sections on demand
+
+- **Render** SQL DDL from shared table specs:
+  - Generate CREATE TABLE or view statements
+  - Swap templates or direct output to files for database migrations
+
 - **Extract** data from multiple sources:
   - Files (CSV, JSON, XML, YAML)
   - Databases (connection string support)
@@ -171,21 +179,21 @@ etlplus --help
 etlplus --version
 ```
 
-#### Inspect Pipelines
+#### Check Pipelines
 
-Use `etlplus list` to explore pipeline YAML definitions without running them. The command can print
+Use `etlplus check` to explore pipeline YAML definitions without running them. The command can print
 job names, summarize configured sources and targets, or drill into specific sections.
 
 List jobs and show a pipeline summary:
 ```bash
-etlplus list --config examples/configs/pipeline.yml --jobs
-etlplus list --config examples/configs/pipeline.yml --summary
+etlplus check --config examples/configs/pipeline.yml --jobs
+etlplus check --config examples/configs/pipeline.yml --summary
 ```
 
 Show sources or transforms for troubleshooting:
 ```bash
-etlplus list --config examples/configs/pipeline.yml --sources
-etlplus list --config examples/configs/pipeline.yml --transforms
+etlplus check --config examples/configs/pipeline.yml --sources
+etlplus check --config examples/configs/pipeline.yml --transforms
 ```
 
 #### Render SQL DDL
@@ -350,8 +358,8 @@ 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
+etlplus check --config examples/configs/pipeline.yml --jobs
+etlplus check --config examples/configs/pipeline.yml --summary
 
 # Run a job
 etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers

{etlplus-0.5.2 → etlplus-0.5.4}/README.md

@@ -48,6 +48,14 @@ package and command-line interface for data extraction, validation, transformati
 
 ## Features
 
+- **Check** data pipeline definitions before running them:
+  - Summarize jobs, sources, targets, and transforms
+  - Confirm configuration changes by printing focused sections on demand
+
+- **Render** SQL DDL from shared table specs:
+  - Generate CREATE TABLE or view statements
+  - Swap templates or direct output to files for database migrations
+
 - **Extract** data from multiple sources:
   - Files (CSV, JSON, XML, YAML)
   - Databases (connection string support)
@@ -129,21 +137,21 @@ etlplus --help
 etlplus --version
 ```
 
-#### Inspect Pipelines
+#### Check Pipelines
 
-Use `etlplus list` to explore pipeline YAML definitions without running them. The command can print
+Use `etlplus check` to explore pipeline YAML definitions without running them. The command can print
 job names, summarize configured sources and targets, or drill into specific sections.
 
 List jobs and show a pipeline summary:
 ```bash
-etlplus list --config examples/configs/pipeline.yml --jobs
-etlplus list --config examples/configs/pipeline.yml --summary
+etlplus check --config examples/configs/pipeline.yml --jobs
+etlplus check --config examples/configs/pipeline.yml --summary
 ```
 
 Show sources or transforms for troubleshooting:
 ```bash
-etlplus list --config examples/configs/pipeline.yml --sources
-etlplus list --config examples/configs/pipeline.yml --transforms
+etlplus check --config examples/configs/pipeline.yml --sources
+etlplus check --config examples/configs/pipeline.yml --transforms
 ```
 
 #### Render SQL DDL
@@ -308,8 +316,8 @@ 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
+etlplus check --config examples/configs/pipeline.yml --jobs
+etlplus check --config examples/configs/pipeline.yml --summary
 
 # Run a job
 etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers

{etlplus-0.5.2 → etlplus-0.5.4}/docs/pipeline-guide.md

@@ -378,13 +378,13 @@ jobs:
 Once you have a pipeline YAML, you can run jobs either from the
 command line or directly from Python.
 
-### CLI: `etlplus list` (inspect) and `etlplus run` (execute)
+### CLI: `etlplus check` (inspect) and `etlplus run` (execute)
 
 List jobs or show a summary from a pipeline file:
 
 ```bash
-etlplus list --config examples/configs/pipeline.yml --jobs
-etlplus list --config examples/configs/pipeline.yml --summary
+etlplus check --config examples/configs/pipeline.yml --jobs
+etlplus check --config examples/configs/pipeline.yml --summary
 ```
 
 Run a specific job end-to-end (extract → validate → transform → load):
@@ -402,7 +402,7 @@ Notes:
   [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`.
+prefer `check` and `run`.
 
 ### Python: `etlplus.run.run`
 

{etlplus-0.5.2 → etlplus-0.5.4}/etlplus/cli/app.py

@@ -57,8 +57,8 @@ from .. import __version__
 from ..enums import DataConnectorType
 from ..enums import FileFormat
 from ..utils import json_type
+from .handlers import cmd_check
 from .handlers import cmd_extract
-from .handlers import cmd_list
 from .handlers import cmd_load
 from .handlers import cmd_pipeline
 from .handlers import cmd_render
@@ -127,109 +127,82 @@ PROJECT_URL: Final[str] = 'https://github.com/Dagitali/ETLPlus'
 # SECTION: TYPE ALIASES ==================================================== #
 
 
-SourceInputArg = Annotated[
-    str,
-    typer.Argument(
-        ...,
-        metavar='SOURCE',
-        help=(
-            'Extract from SOURCE. Use --from/--source-type to override the '
-            'inferred connector when needed.'
-        ),
-    ),
-]
-
-StreamingSourceArg = Annotated[
+OperationsJSONOption = Annotated[
     str,
-    typer.Argument(
-        ...,
-        metavar='SOURCE',
-        help=(
-            'Data source to transform or validate (path, JSON payload, or '
-            '- for stdin).'
-        ),
+    typer.Option(
+        '--operations',
+        help='Transformation operations as JSON string.',
     ),
 ]
 
-TargetInputArg = Annotated[
+PipelineConfigOption = Annotated[
     str,
-    typer.Argument(
+    typer.Option(
         ...,
-        metavar='TARGET',
-        help=(
-            'Load JSON data from stdin into TARGET. Use --to/--target-type '
-            'to override connector inference when needed. Source data must '
-            'be piped into stdin.'
-        ),
+        '--config',
+        metavar='PATH',
+        help='Path to pipeline YAML configuration file.',
     ),
 ]
 
-SourceOverrideOption = Annotated[
+RenderConfigOption = Annotated[
     str | None,
     typer.Option(
-        '--source-type',
-        metavar='CONNECTOR',
+        '--config',
+        metavar='PATH',
+        help='Pipeline YAML that includes table_schemas for rendering.',
         show_default=False,
-        rich_help_panel='I/O overrides',
-        help='Override the inferred source type (file, database, api).',
     ),
 ]
 
-TargetOverrideOption = Annotated[
+RenderOutputOption = Annotated[
     str | None,
     typer.Option(
-        '--target-type',
-        metavar='CONNECTOR',
-        show_default=False,
-        rich_help_panel='I/O overrides',
-        help='Override the inferred target type (file, database, api).',
+        '--output',
+        '-o',
+        metavar='PATH',
+        help='Write rendered SQL to PATH (default: stdout).',
     ),
 ]
 
-SourceFormatOption = Annotated[
+RenderSpecOption = Annotated[
     str | None,
     typer.Option(
-        '--source-format',
-        metavar='FORMAT',
+        '--spec',
+        metavar='PATH',
+        help='Standalone table spec file (.yml/.yaml/.json).',
         show_default=False,
-        rich_help_panel='Format overrides',
-        help=(
-            'Input payload format when SOURCE is - or an inline payload. '
-            'File sources infer format from the extension.'
-        ),
     ),
 ]
 
-StdinFormatOption = Annotated[
+RenderTableOption = Annotated[
     str | None,
     typer.Option(
-        '--source-format',
-        metavar='FORMAT',
-        show_default=False,
-        rich_help_panel='Format overrides',
-        help='Input payload format when reading from stdin (default: json).',
+        '--table',
+        metavar='NAME',
+        help='Filter to a single table name from table_schemas.',
     ),
 ]
 
-TargetFormatOption = Annotated[
-    str | None,
+RenderTemplateOption = Annotated[
+    str,
     typer.Option(
-        '--target-format',
-        metavar='FORMAT',
-        show_default=False,
-        rich_help_panel='Format overrides',
-        help=(
-            'Payload format when TARGET is - or a non-file connector. File '
-            'targets infer format from the extension.'
-        ),
+        '--template',
+        '-t',
+        metavar='KEY|PATH',
+        help='Template key (ddl/view) or path to a Jinja template file.',
+        show_default=True,
     ),
 ]
 
-OperationsJSONOption = Annotated[
-    str,
+RenderTemplatePathOption = Annotated[
+    str | None,
     typer.Option(
-        '--operations',
-        help='Transformation operations as JSON string.',
+        '--template-path',
+        metavar='PATH',
+        help=(
+            'Explicit path to a Jinja template file (overrides template key).'
+        ),
     ),
 ]
 
@@ -241,83 +214,110 @@ RulesJSONOption = Annotated[
     ),
 ]
 
-TargetPathOption = Annotated[
+SourceFormatOption = Annotated[
     str | None,
     typer.Option(
-        '--target',
-        metavar='PATH',
-        help='Target file for transformed or validated output (- for stdout).',
+        '--source-format',
+        metavar='FORMAT',
+        show_default=False,
+        rich_help_panel='Format overrides',
+        help=(
+            'Input payload format when SOURCE is - or an inline payload. '
+            'File sources infer format from the extension.'
+        ),
     ),
 ]
 
-PipelineConfigOption = Annotated[
+SourceInputArg = Annotated[
     str,
-    typer.Option(
+    typer.Argument(
         ...,
-        '--config',
-        metavar='PATH',
-        help='Path to pipeline YAML configuration file.',
+        metavar='SOURCE',
+        help=(
+            'Extract from SOURCE. Use --from/--source-type to override the '
+            'inferred connector when needed.'
+        ),
     ),
 ]
 
-RenderConfigOption = Annotated[
+SourceOverrideOption = Annotated[
     str | None,
     typer.Option(
-        '--config',
-        metavar='PATH',
-        help='Pipeline YAML that includes table_schemas for rendering.',
+        '--source-type',
+        metavar='CONNECTOR',
         show_default=False,
+        rich_help_panel='I/O overrides',
+        help='Override the inferred source type (file, database, api).',
     ),
 ]
 
-RenderOutputOption = Annotated[
+StdinFormatOption = Annotated[
     str | None,
     typer.Option(
-        '--output',
-        '-o',
-        metavar='PATH',
-        help='Write rendered SQL to PATH (default: stdout).',
+        '--source-format',
+        metavar='FORMAT',
+        show_default=False,
+        rich_help_panel='Format overrides',
+        help='Input payload format when reading from stdin (default: json).',
     ),
 ]
 
-RenderSpecOption = Annotated[
-    str | None,
-    typer.Option(
-        '--spec',
-        metavar='PATH',
-        help='Standalone table spec file (.yml/.yaml/.json).',
-        show_default=False,
+StreamingSourceArg = Annotated[
+    str,
+    typer.Argument(
+        ...,
+        metavar='SOURCE',
+        help=(
+            'Data source to transform or validate (path, JSON payload, or '
+            '- for stdin).'
+        ),
     ),
 ]
 
-RenderTableOption = Annotated[
+TargetFormatOption = Annotated[
     str | None,
     typer.Option(
-        '--table',
-        metavar='NAME',
-        help='Filter to a single table name from table_schemas.',
+        '--target-format',
+        metavar='FORMAT',
+        show_default=False,
+        rich_help_panel='Format overrides',
+        help=(
+            'Payload format when TARGET is - or a non-file connector. File '
+            'targets infer format from the extension.'
+        ),
     ),
 ]
 
-RenderTemplateOption = Annotated[
+TargetInputArg = Annotated[
     str,
+    typer.Argument(
+        ...,
+        metavar='TARGET',
+        help=(
+            'Load JSON data from stdin into TARGET. Use --to/--target-type '
+            'to override connector inference when needed. Source data must '
+            'be piped into stdin.'
+        ),
+    ),
+]
+
+TargetOverrideOption = Annotated[
+    str | None,
     typer.Option(
-        '--template',
-        '-t',
-        metavar='KEY|PATH',
-        help='Template key (ddl/view) or path to a Jinja template file.',
-        show_default=True,
+        '--target-type',
+        metavar='CONNECTOR',
+        show_default=False,
+        rich_help_panel='I/O overrides',
+        help='Override the inferred target type (file, database, api).',
     ),
 ]
 
-RenderTemplatePathOption = Annotated[
+TargetPathOption = Annotated[
     str | None,
     typer.Option(
-        '--template-path',
+        '--target',
         metavar='PATH',
-        help=(
-            'Explicit path to a Jinja template file (overrides template key).'
-        ),
+        help='Target file for transformed or validated output (- for stdout).',
     ),
 ]
 
@@ -745,6 +745,83 @@ def _root(
         raise typer.Exit(0)
 
 
+@app.command('check')
+def check_cmd(
+    ctx: typer.Context,
+    config: PipelineConfigOption,
+    jobs: bool = typer.Option(
+        False,
+        '--jobs',
+        help='List available job names and exit',
+    ),
+    pipelines: bool = typer.Option(
+        False,
+        '--pipelines',
+        help='List ETL pipelines',
+    ),
+    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',
+        help='List data transforms',
+    ),
+) -> int:
+    """
+    Print ETL entities from a pipeline YAML configuration.
+
+    Parameters
+    ----------
+    ctx : typer.Context
+        Typer execution context provided to the command.
+    config : PipelineConfigOption
+        Path to pipeline YAML configuration file.
+    jobs : bool, optional
+        If True, list available job names and exit.
+    pipelines : bool, optional
+        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
+        If True, list data transforms.
+
+    Returns
+    -------
+    int
+        Zero on success.
+    """
+    state = _ensure_state(ctx)
+    ns = _stateful_namespace(
+        state,
+        command='check',
+        config=config,
+        summary=summary,
+        pipelines=pipelines,
+        jobs=jobs,
+        sources=sources,
+        targets=targets,
+        transforms=transforms,
+    )
+    return int(cmd_check(ns))
+
+
 @app.command('extract')
 def extract_cmd(
     ctx: typer.Context,
@@ -831,83 +908,6 @@ def extract_cmd(
     return int(cmd_extract(ns))
 
 
-@app.command('list')
-def list_cmd(
-    ctx: typer.Context,
-    config: PipelineConfigOption,
-    jobs: bool = typer.Option(
-        False,
-        '--jobs',
-        help='List available job names and exit',
-    ),
-    pipelines: bool = typer.Option(
-        False,
-        '--pipelines',
-        help='List ETL pipelines',
-    ),
-    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',
-        help='List data transforms',
-    ),
-) -> int:
-    """
-    Print ETL entities from a pipeline YAML configuration.
-
-    Parameters
-    ----------
-    ctx : typer.Context
-        Typer execution context provided to the command.
-    config : PipelineConfigOption
-        Path to pipeline YAML configuration file.
-    jobs : bool, optional
-        If True, list available job names and exit.
-    pipelines : bool, optional
-        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
-        If True, list data transforms.
-
-    Returns
-    -------
-    int
-        Zero on success.
-    """
-    state = _ensure_state(ctx)
-    ns = _stateful_namespace(
-        state,
-        command='list',
-        config=config,
-        summary=summary,
-        pipelines=pipelines,
-        jobs=jobs,
-        sources=sources,
-        targets=targets,
-        transforms=transforms,
-    )
-    return int(cmd_list(ns))
-
-
 @app.command('load')
 def load_cmd(
     ctx: typer.Context,