etlplus 0.5.5__tar.gz → 0.8.4__tar.gz

{etlplus-0.5.5/etlplus.egg-info → etlplus-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.5.5
+Version: 0.8.4
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -21,7 +21,10 @@ Requires-Dist: jinja2>=3.1.6
 Requires-Dist: pyodbc>=5.3.0
 Requires-Dist: python-dotenv>=1.2.1
 Requires-Dist: pandas>=2.3.3
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: PyYAML>=6.0.3
 Requires-Dist: requests>=2.32.5
+Requires-Dist: SQLAlchemy>=2.0.45
 Requires-Dist: typer>=0.21.0
 Provides-Extra: dev
 Requires-Dist: black>=25.9.0; extra == "dev"
@@ -61,7 +64,7 @@ package and command-line interface for data extraction, validation, transformati
   - [Quickstart](#quickstart)
   - [Usage](#usage)
     - [Command Line Interface](#command-line-interface)
-      - [Inspect Pipelines](#inspect-pipelines)
+      - [Check Pipelines](#check-pipelines)
       - [Render SQL DDL](#render-sql-ddl)
       - [Extract Data](#extract-data)
       - [Validate Data](#validate-data)
@@ -179,6 +182,9 @@ etlplus --help
 etlplus --version
 ```
 
+The CLI is implemented with Typer (Click-based). There is no argparse compatibility layer, so rely
+on the documented commands/flags and run `etlplus <command> --help` for current options.
+
 #### Check Pipelines
 
 Use `etlplus check` to explore pipeline YAML definitions without running them. The command can print
@@ -363,8 +369,6 @@ etlplus check --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

{etlplus-0.5.5 → etlplus-0.8.4}/README.md

@@ -19,7 +19,7 @@ package and command-line interface for data extraction, validation, transformati
   - [Quickstart](#quickstart)
   - [Usage](#usage)
     - [Command Line Interface](#command-line-interface)
-      - [Inspect Pipelines](#inspect-pipelines)
+      - [Check Pipelines](#check-pipelines)
       - [Render SQL DDL](#render-sql-ddl)
       - [Extract Data](#extract-data)
       - [Validate Data](#validate-data)
@@ -137,6 +137,9 @@ etlplus --help
 etlplus --version
 ```
 
+The CLI is implemented with Typer (Click-based). There is no argparse compatibility layer, so rely
+on the documented commands/flags and run `etlplus <command> --help` for current options.
+
 #### Check Pipelines
 
 Use `etlplus check` to explore pipeline YAML definitions without running them. The command can print
@@ -321,8 +324,6 @@ etlplus check --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

etlplus-0.8.4/docs/README.md

@@ -0,0 +1,18 @@
+# Documentation Notes
+
+## CLI Parser Status
+- The CLI is now Typer/Click-only. The historical `argparse` parser and `create_parser` entrypoint
+  are deprecated and no longer supported for new integrations.
+- Downstream tools should invoke the Typer app exported at `etlplus.cli.commands.app` (e.g., `python
+  -m etlplus` or `etlplus ...`).
+- Handler functions still accept keyword arguments; the legacy namespace shim is temporary and will
+  be removed in a future release. Avoid constructing `argparse.Namespace` objects and instead call
+  handlers with explicit keyword arguments if you integrate programmatically.
+
+## Migration Hints
+- Replace any imports of `etlplus.cli.main.create_parser` with Typer invocations (`etlplus` binary
+  or `app` directly).
+- If you maintained custom subcommands around the old parser, port them to Typer by attaching to
+  `app` or wrapping the `etlplus` executable.
+- Tests and examples now target the Typer surface; expect argparse-focused helpers (e.g., namespace
+  format flags) to be absent.

{etlplus-0.5.5 → etlplus-0.8.4}/docs/pipeline-guide.md

@@ -7,6 +7,28 @@ ETLPlus focuses on simple, JSON-first ETL. The pipeline file is a declarative de
 runner (a script, Makefile, CI job) can parse and execute using ETLPlus primitives: `extract`,
 `validate`, `transform`, and `load`.
 
+CLI note: ETLPlus uses Typer for command parsing and does not ship an argparse shim. Use the
+documented `etlplus` commands and flags (check `etlplus --help`) when wiring your runner.
+
+## Running a pipeline from YAML (CLI)
+
+Use the built-in `etlplus run` command to execute jobs defined in a pipeline YAML. The command reads
+your config, resolves vars and env placeholders, then runs the requested job:
+
+```bash
+# List jobs with the check command
+etlplus check --config examples/configs/pipeline.yml --jobs
+
+# Run a specific job
+etlplus run --config examples/configs/pipeline.yml --job file_to_file_customers
+
+# Run another job from the same config
+etlplus run --config examples/configs/pipeline.yml --job api_to_file_github_repos
+```
+
+For scripted usage inside a larger Python project, prefer importing the Python API directly (e.g.,
+`extract`, `transform`, `validate`, `load`) instead of invoking the CLI subprocess.
+
 ## Top-level structure
 
 A pipeline file typically includes:
@@ -401,9 +423,6 @@ Notes:
 - 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 `check` and `run`.
-
 ### Python: `etlplus.run.run`
 
 To trigger a job programmatically, use the high-level runner function exposed by the package:

{etlplus-0.5.5 → etlplus-0.8.4}/etlplus/api/README.md

@@ -7,8 +7,8 @@ paginated REST endpoints.
 - Supports page-, offset-, and cursor-based pagination via `PaginationConfig`
 - Simple bearer-auth credentials via `EndpointCredentialsBearer`
 - Convenience helpers to extract records from nested JSON payloads
-- Returns the shared `JSONRecords` alias (a list of `JSONDict`) for paginated responses, matching
-  the rest of the library.
+- Returns paginated JSON payloads (lists of record dictionaries) consistent with the rest of the
+  library.
 
 Back to project overview: see the top-level [README](../../README.md).
 
@@ -29,7 +29,6 @@ import requests
 from etlplus.api import (
   EndpointClient,
   EndpointCredentialsBearer,
-  JSONRecords,
 )
 
 auth = EndpointCredentialsBearer(
@@ -54,12 +53,12 @@ client = EndpointClient(
 
 # Page-based pagination
 pg: PaginationConfig = {"type": "page", "page_size": 100}
-rows: JSONRecords = client.paginate("list", pagination=pg)
+rows = client.paginate("list", pagination=pg)
 for row in rows:
   print(row)
 ```
 
-### Overriding rate limits per call
+### Overriding Rate Limits Per Call
 
 When a client is constructed with ``rate_limit`` metadata you can still tweak the pacing for
 individual calls by passing ``rate_limit_overrides`` to ``paginate``/``paginate_iter``. The
@@ -101,10 +100,10 @@ If the API responds like this:
 
 If the response is a list at the top level, you can omit `records_path`.
 
-## Cursor-based pagination example
+## Cursor-Based Pagination Example
 
 ```python
-from etlplus.api import EndpointClient, PaginationConfig, JSONRecords
+from etlplus.api import EndpointClient, PaginationConfig
 
 client = EndpointClient(
     base_url="https://api.example.com/v1",
@@ -125,7 +124,7 @@ pg: PaginationConfig = {
     # "start_cursor": "abc123",
 }
 
-rows: JSONRecords = client.paginate("list", pagination=pg)
+rows = client.paginate("list", pagination=pg)
 for row in rows:
     process(row)
 ```
@@ -192,36 +191,35 @@ client = EndpointClient(
 providers can fall back to their own defaults. If you already possess a static token, attach it to a
 `requests.Session` manually rather than instantiating `EndpointCredentialsBearer`.
 
-## Errors and rate limiting
+## Errors and Rate Limiting
 
 - Errors: `ApiRequestError`, `ApiAuthError`, and `PaginationError` (in `etlplus/api/errors.py`)
   include an `as_dict()` helper for structured logs.
-- Rate limiting: `RateLimiter` and its `resolve_sleep_seconds` helper (in
-  `etlplus/api/rate_limiter.py`) derives fixed sleeps or `max_per_sec` windows. The paginator now
-  builds a `RateLimiter` whenever the effective delay comes from
-  `rate_limit`/`rate_limit_overrides`, so each page fetch sleeps before making another HTTP call.
-  Passing `rate_limit_overrides` to `paginate*` lets you momentarily speed up or slow down a single
-  request without mutating the client-wide defaults.
-
-## Types and transport
-
-- Types: pagination config helpers live in `etlplus/api/paginator.py`; retry helpers (including
-  `RetryPolicy`) live in `etlplus/api/retry_manager.py`; rate-limit helpers live in
-  `etlplus/api/rate_limiter.py`. These are all re-exported from `etlplus.api` for convenience.
+- Rate limiting: `RateLimiter` (in `etlplus/api/rate_limiting/rate_limiter.py`) derives fixed sleeps
+  or `max_per_sec` windows. The paginator now builds a `RateLimiter` whenever the effective delay
+  comes from `rate_limit`/`rate_limit_overrides`, so each page fetch sleeps before making another
+  HTTP call. Passing `rate_limit_overrides` to `paginate*` lets you momentarily speed up or slow
+  down a single request without mutating the client-wide defaults.
+
+## Types and Transport
+
+- Types: pagination config helpers live in `etlplus/api/pagination/paginator.py`; retry helpers
+  (including `RetryPolicy`) live in `etlplus/api/retry_manager.py`; rate-limit helpers live in
+  `etlplus/api/rate_limiting/rate_limiter.py`. These are all re-exported from `etlplus.api` for
+  convenience.
 - Transport/session: `etlplus/api/transport.py` contains the HTTP adapter helpers and
   `etlplus/api/request_manager.py` wraps `requests` sessions plus retry orchestration. Advanced
   users may consult those modules to adapt behavior.
 
-## Supporting modules
+## Supporting Modules
 
 - `etlplus.api.types` collects friendly aliases such as `Headers`, `Params`, `Url`, and
   `RateLimitOverrides` (whose values accept numeric override inputs) so endpoint helpers share the
   same type vocabulary.
-- `etlplus.utils` exposes lightweight helpers used across the project, including CLI-friendly
-  functions like `json_type`/`print_json` plus numeric coercion utilities (`to_float`,
-  `to_positive_int`, etc.).
+- `etlplus.utils` exposes lightweight helpers used across the project, including `print_json` and
+  numeric coercion utilities (`to_float`, `to_positive_int`, etc.).
 
-## Minimal contract
+## Minimal Contract
 
 - Inputs
   - `base_url: str`, `endpoints: dict[str, str]`