etlplus 0.3.23__py3-none-any.whl → 0.4.0__py3-none-any.whl

etlplus/cli.py

@@ -26,6 +26,8 @@ from typing import Any
 from typing import Literal
 from typing import cast
 
+import typer
+
 from . import __version__
 from .config import PipelineConfig
 from .config import load_pipeline_config
@@ -90,6 +92,9 @@ PROJECT_URL = 'https://github.com/Dagitali/ETLPlus'
 _FORMAT_ERROR_STATES = {'error', 'fail', 'strict'}
 _FORMAT_SILENT_STATES = {'ignore', 'silent'}
 
+_SOURCE_CHOICES = set(DataConnectorType.choices())
+_FORMAT_CHOICES = set(FileFormat.choices())
+
 
 # SECTION: TYPE ALIASES ===================================================== #
 
@@ -292,6 +297,12 @@ def _materialize_csv_payload(
     return _read_csv_rows(path)
 
 
+def _ns(**kwargs: object) -> argparse.Namespace:
+    """Create an :class:`argparse.Namespace` for legacy command handlers."""
+
+    return argparse.Namespace(**kwargs)
+
+
 def _pipeline_summary(
     cfg: PipelineConfig,
 ) -> dict[str, Any]:
@@ -341,6 +352,18 @@ def _read_csv_rows(
         return [dict(row) for row in reader]
 
 
+def _validate_choice(value: str, choices: set[str], *, label: str) -> str:
+    """Validate a string against allowed choices for nice CLI errors."""
+
+    v = (value or '').strip()
+    if v in choices:
+        return v
+    allowed = ', '.join(sorted(choices))
+    raise typer.BadParameter(
+        f"Invalid {label} '{value}'. Choose from: {allowed}",
+    )
+
+
 def _write_json_output(
     data: Any,
     output_path: str | None,
@@ -838,31 +861,326 @@ def main(
     int
         Zero on success, non-zero on error.
 
+    Raises
+    ------
+    SystemExit
+        Re-raises SystemExit exceptions to preserve exit codes.
+
     Notes
     -----
-    This function prints results to stdout and errors to stderr.
+    This function uses Typer (Click) for parsing/dispatch, but preserves the
+    existing `cmd_*` handlers by adapting parsed arguments into an
+    :class:`argparse.Namespace`.
     """
-    parser = create_parser()
-    args = parser.parse_args(argv)
-
-    if not args.command:
-        parser.print_help()
-        return 0
+    argv = sys.argv[1:] if argv is None else argv
+    command = typer.main.get_command(app)
 
     try:
-        # Prefer argparse's dispatch to avoid duplicating logic.
-        func = getattr(args, 'func', None)
-        if callable(func):
-            return int(func(args))
+        result = command.main(
+            args=list(argv),
+            prog_name='etlplus',
+            standalone_mode=False,
+        )
+        return int(result or 0)
 
-        # Fallback: no subcommand function bound.
-        parser.print_help()
-        return 0
+    except typer.Exit as exc:
+        return int(exc.exit_code)
+
+    except typer.Abort:
+        return 1
 
     except KeyboardInterrupt:
         # Conventional exit code for SIGINT
         return 130
 
+    except SystemExit as e:
+        print(f'Error: {e}', file=sys.stderr)
+        raise e
+
     except (OSError, TypeError, ValueError) as e:
         print(f'Error: {e}', file=sys.stderr)
         return 1
+
+
+# SECTION: TYPER APP ======================================================== #
+
+
+app = typer.Typer(
+    name='etlplus',
+    help='ETLPlus - A Swiss Army knife for simple ETL operations.',
+    add_completion=True,
+)
+
+
+@app.callback(invoke_without_command=True)
+def _root(
+    ctx: typer.Context,
+    version: bool = typer.Option(
+        False,
+        '-V',
+        '--version',
+        is_eager=True,
+        help='Show the version and exit.',
+    ),
+) -> None:
+    """Root command callback to show help or version."""
+
+    if version:
+        typer.echo(f'etlplus {__version__}')
+        raise typer.Exit(0)
+
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+        raise typer.Exit(0)
+
+
+@app.command('extract')
+def extract_cmd(
+    source_type: str = typer.Argument(
+        ...,
+        help='Type of source to extract from',
+    ),
+    source: str = typer.Argument(
+        ...,
+        help=(
+            'Source location '
+            '(file path, database connection string, or API URL)'
+        ),
+    ),
+    output: str | None = typer.Option(
+        None,
+        '-o',
+        '--output',
+        help='Output file to save extracted data (JSON format)',
+    ),
+    strict_format: bool = typer.Option(
+        False,
+        '--strict-format',
+        help=(
+            'Treat providing --format for file sources as an error '
+            '(overrides environment behavior)'
+        ),
+    ),
+    source_format: str | None = typer.Option(
+        None,
+        '--format',
+        help=(
+            'Format of the source when not a file. For file sources this '
+            'option is ignored and the format is inferred from the filename '
+            'extension.'
+        ),
+    ),
+) -> int:
+    """Typer front-end for :func:`cmd_extract`."""
+
+    source_type = _validate_choice(
+        source_type,
+        _SOURCE_CHOICES,
+        label='source_type',
+    )
+    if source_format is not None:
+        source_format = _validate_choice(
+            source_format,
+            _FORMAT_CHOICES,
+            label='format',
+        )
+
+    ns = _ns(
+        command='extract',
+        source_type=source_type,
+        source=source,
+        output=output,
+        strict_format=strict_format,
+        format=(source_format or 'json'),
+        _format_explicit=(source_format is not None),
+    )
+    return int(cmd_extract(ns))
+
+
+@app.command('validate')
+def validate_cmd(
+    source: str = typer.Argument(
+        ...,
+        help='Data source to validate (file path or JSON string)',
+    ),
+    rules: str = typer.Option(
+        '{}',
+        '--rules',
+        help='Validation rules as JSON string',
+    ),
+) -> int:
+    """Typer front-end for :func:`cmd_validate`."""
+
+    ns = _ns(command='validate', source=source, rules=json_type(rules))
+    return int(cmd_validate(ns))
+
+
+@app.command('transform')
+def transform_cmd(
+    source: str = typer.Argument(
+        ...,
+        help='Data source to transform (file path or JSON string)',
+    ),
+    operations: str = typer.Option(
+        '{}',
+        '--operations',
+        help='Transformation operations as JSON string',
+    ),
+    output: str | None = typer.Option(
+        None,
+        '-o',
+        '--output',
+        help='Output file to save transformed data',
+    ),
+) -> int:
+    """Typer front-end for :func:`cmd_transform`."""
+
+    ns = _ns(
+        command='transform',
+        source=source,
+        operations=json_type(operations),
+        output=output,
+    )
+    return int(cmd_transform(ns))
+
+
+@app.command('load')
+def load_cmd(
+    source: str = typer.Argument(
+        ...,
+        help='Data source to load (file path or JSON string)',
+    ),
+    target_type: str = typer.Argument(..., help='Type of target to load to'),
+    target: str = typer.Argument(
+        ...,
+        help=(
+            'Target location '
+            '(file path, database connection string, or API URL)'
+        ),
+    ),
+    strict_format: bool = typer.Option(
+        False,
+        '--strict-format',
+        help=(
+            'Treat providing --format for file targets as an error '
+            '(overrides environment behavior)'
+        ),
+    ),
+    target_format: str | None = typer.Option(
+        None,
+        '--format',
+        help=(
+            'Format of the target when not a file. For file targets this '
+            'option is ignored and the format is inferred from the filename '
+            'extension.'
+        ),
+    ),
+) -> int:
+    """Typer front-end for :func:`cmd_load`."""
+
+    target_type = _validate_choice(
+        target_type,
+        _SOURCE_CHOICES,
+        label='target_type',
+    )
+    if target_format is not None:
+        target_format = _validate_choice(
+            target_format,
+            _FORMAT_CHOICES,
+            label='format',
+        )
+
+    ns = _ns(
+        command='load',
+        source=source,
+        target_type=target_type,
+        target=target,
+        strict_format=strict_format,
+        format=(target_format or 'json'),
+        _format_explicit=(target_format is not None),
+    )
+    return int(cmd_load(ns))
+
+
+@app.command('pipeline')
+def pipeline_cmd(
+    config: str = typer.Option(
+        ...,
+        '--config',
+        help='Path to pipeline YAML configuration file',
+    ),
+    list_: bool = typer.Option(
+        False,
+        '--list',
+        help='List available job names and exit',
+    ),
+    run_job: str | None = typer.Option(
+        None,
+        '--run',
+        metavar='JOB',
+        help='Run a specific job by name',
+    ),
+) -> int:
+    """Typer front-end for :func:`cmd_pipeline`."""
+
+    ns = _ns(command='pipeline', config=config, list=list_, run=run_job)
+    return int(cmd_pipeline(ns))
+
+
+@app.command('list')
+def list_cmd(
+    config: str = typer.Option(
+        ...,
+        '--config',
+        help='Path to pipeline YAML configuration file',
+    ),
+    pipelines: bool = typer.Option(
+        False,
+        '--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'),
+    transforms: bool = typer.Option(
+        False,
+        '--transforms',
+        help='List data transforms',
+    ),
+) -> int:
+    """Typer front-end for :func:`cmd_list`."""
+
+    ns = _ns(
+        command='list',
+        config=config,
+        pipelines=pipelines,
+        sources=sources,
+        targets=targets,
+        transforms=transforms,
+    )
+    return int(cmd_list(ns))
+
+
+@app.command('run')
+def run_cmd(
+    config: str = typer.Option(
+        ...,
+        '--config',
+        help='Path to pipeline YAML configuration file',
+    ),
+    job: str | None = typer.Option(
+        None,
+        '-j',
+        '--job',
+        help='Name of the job to run',
+    ),
+    pipeline: str | None = typer.Option(
+        None,
+        '-p',
+        '--pipeline',
+        help='Name of the pipeline to run',
+    ),
+) -> int:
+    """Typer front-end for :func:`cmd_run`."""
+
+    ns = _ns(command='run', config=config, job=job, pipeline=pipeline)
+    return int(cmd_run(ns))

{etlplus-0.3.23.dist-info → etlplus-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.3.23
+Version: 0.4.0
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -22,6 +22,7 @@ Requires-Dist: pyodbc>=5.3.0
 Requires-Dist: python-dotenv>=1.2.1
 Requires-Dist: pandas>=2.3.3
 Requires-Dist: requests>=2.32.5
+Requires-Dist: typer>=0.21.0
 Provides-Extra: dev
 Requires-Dist: black>=25.9.0; extra == "dev"
 Requires-Dist: build>=1.2.2; extra == "dev"

{etlplus-0.3.23.dist-info → etlplus-0.4.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 etlplus/__init__.py,sha256=M2gScnyir6WOMAh_EuoQIiAzdcTls0_5hbd_Q6of8I0,1021
 etlplus/__main__.py,sha256=lSbVOF5Mnd_ljmCqK7nTuF_MRDYTkL73eZEFeUQ_vnI,510
 etlplus/__version__.py,sha256=1E0GMK_yUWCMQFKxXjTvyMwofi0qT2k4CDNiHWiymWE,327
-etlplus/cli.py,sha256=dmMW5dLbFiDRGne97qDsqr3YuU30g_Ekl_vo7bgDLig,21752
+etlplus/cli.py,sha256=4Iiuh9YmfrG585GwSD2kgjLKhXfi4RsA1Lvcg5jFnu4,29757
 etlplus/enums.py,sha256=V_j18Ud2BCXpFsBk2pZGrvCVrvAMJ7uja1z9fppFGso,10175
 etlplus/extract.py,sha256=f44JdHhNTACxgn44USx05paKTwq7LQY-V4wANCW9hVM,6173
 etlplus/file.py,sha256=RxIAsGDN4f_vNA2B5-ct88JNd_ISAyYbooIRE5DstS8,17972
@@ -40,9 +40,9 @@ etlplus/config/types.py,sha256=a0epJ3z16HQ5bY3Ctf8s_cQPa3f0HHcwdOcjCP2xoG4,4954
 etlplus/config/utils.py,sha256=4SUHMkt5bKBhMhiJm-DrnmE2Q4TfOgdNCKz8PJDS27o,3443
 etlplus/validation/__init__.py,sha256=Pe5Xg1_EA4uiNZGYu5WTF3j7odjmyxnAJ8rcioaplSQ,1254
 etlplus/validation/utils.py,sha256=Mtqg449VIke0ziy_wd2r6yrwJzQkA1iulZC87FzXMjo,10201
-etlplus-0.3.23.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
-etlplus-0.3.23.dist-info/METADATA,sha256=MtgwbMsm2n3gypehX_zpP1Hb8VaKxHxwXUIwKXCkLw4,16730
-etlplus-0.3.23.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-etlplus-0.3.23.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
-etlplus-0.3.23.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
-etlplus-0.3.23.dist-info/RECORD,,
+etlplus-0.4.0.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
+etlplus-0.4.0.dist-info/METADATA,sha256=A3KilfgxjvCPCktoZ0TMh8ygvF_UmKWXlZJzd_ItDqs,16758
+etlplus-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+etlplus-0.4.0.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
+etlplus-0.4.0.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
+etlplus-0.4.0.dist-info/RECORD,,