etlplus 0.12.5__tar.gz → 0.15.2__tar.gz

{etlplus-0.12.5 → etlplus-0.15.2}/CONTRIBUTING.md

@@ -119,7 +119,7 @@ Use these guidelines to decide whether a test belongs in the unit or integration
   - Can use temporary files/directories, and stub network with fakes/mocks.
   - Examples in this repo: CLI end-to-end, pipeline smoke tests, pagination strategy, runner defaults for pagination/rate limits, target URL composition.
 
-If a test calls `etlplus.cli.main()` or `etlplus.run.run()`, it is integration by default.
+If a test calls `etlplus.cli.main()` or `etlplus.ops.run.run()`, it is integration by default.
 
 ### Where to put tests
 

{etlplus-0.12.5 → etlplus-0.15.2}/DEMO.md

@@ -196,7 +196,7 @@ $ etlplus load transformed.json file final_output.csv
 ## Demo 6: Using Python API
 
 ```python
-from etlplus import extract, validate, transform, load
+from etlplus.ops import extract, validate, transform, load
 
 # Extract
 data = extract("file", "data.csv", format="csv")

{etlplus-0.12.5/etlplus.egg-info → etlplus-0.15.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.12.5
+Version: 0.15.2
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -68,6 +68,21 @@ package and command-line interface for data extraction, validation, transformati
   - [Features](#features)
   - [Installation](#installation)
   - [Quickstart](#quickstart)
+  - [Data Connectors](#data-connectors)
+    - [REST APIs (`api`)](#rest-apis-api)
+    - [Databases (`database`)](#databases-database)
+    - [Files (`file`)](#files-file)
+      - [Stubbed / Placeholder](#stubbed--placeholder)
+      - [Tabular \& Delimited Text](#tabular--delimited-text)
+      - [Semi-Structured Text](#semi-structured-text)
+      - [Columnar / Analytics-Friendly](#columnar--analytics-friendly)
+      - [Binary Serialization and Interchange](#binary-serialization-and-interchange)
+      - [Databases and Embedded Storage](#databases-and-embedded-storage)
+      - [Spreadsheets](#spreadsheets)
+      - [Statistical / Scientific / Numeric Computing](#statistical--scientific--numeric-computing)
+      - [Logs and Event Streams](#logs-and-event-streams)
+      - [Data Archives](#data-archives)
+      - [Templates](#templates)
   - [Usage](#usage)
     - [Command Line Interface](#command-line-interface)
       - [Argument Order and Required Options](#argument-order-and-required-options)
@@ -181,7 +196,7 @@ etlplus extract file examples/data/sample.csv \
 [Python API](#python-api):
 
 ```python
-from etlplus import extract, transform, validate, load
+from etlplus.ops import extract, transform, validate, load
 
 data = extract("file", "input.csv")
 ops = {"filter": {"field": "age", "op": "gt", "value": 25}, "select": ["name", "email"]}
@@ -191,6 +206,140 @@ assert validate(filtered, rules)["valid"]
 load(filtered, "file", "temp/sample_output.json", file_format="json")
 ```
 
+## Data Connectors
+
+Data connectors abstract sources from which to extract data and targets to which to load data. They
+are differentiated by their types, each of which is represented in the subsections below.
+
+### REST APIs (`api`)
+
+ETLPlus can extract from REST APIs and load results via common HTTP methods. Supported operations
+include GET for extract and PATCH/POST/PUT for load.
+
+### Databases (`database`)
+
+Database connectors use connection strings for extraction and loading, and
+DDL can be rendered from table specs for migrations or schema checks.
+
+### Files (`file`)
+
+Recognized file formats are listed in the tables below. Support for reading to or writing from a recognized file format is marked as:
+
+- **Y**: implemented (may require optional dependencies)
+- **N**: stubbed or not yet implemented
+
+#### Stubbed / Placeholder
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `stub` | N | Placeholder format for tests and future connectors. |
+
+#### Tabular & Delimited Text
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `csv` | Y | Y | Comma-Separated Values |
+| `dat` | N | N | Generic data file, often delimited or fixed-width |
+| `fwf` | N | N | Fixed-Width Fields |
+| `psv` | N | N | Pipe-Separated Values |
+| `tab` | N | N | Often synonymous with TSV |
+| `tsv` | Y | Y | Tab-Separated Values |
+| `txt` | Y | Y | Plain text, often delimited or fixed-width |
+
+#### Semi-Structured Text
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `cfg` | N | N | Config-style key-value pairs |
+| `conf` | N | N | Config-style key-value pairs |
+| `ini` | N | N | Config-style key-value pairs |
+| `json` | Y | Y | JavaScript Object Notation |
+| `ndjson` | Y | Y | Newline-Delimited JSON |
+| `properties` | N | N | Java-style key-value pairs |
+| `toml` | N | N | Tom's Obvious Minimal Language |
+| `xml` | Y | Y | Extensible Markup Language |
+| `yaml` | Y | Y | YAML Ain't Markup Language |
+
+#### Columnar / Analytics-Friendly
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `arrow` | N | N | Apache Arrow IPC |
+| `feather` | Y | Y | Apache Arrow Feather |
+| `orc` | Y | Y | Optimized Row Columnar; common in Hadoop |
+| `parquet` | Y | Y | Apache Parquet; common in Big Data |
+
+#### Binary Serialization and Interchange
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `avro` | Y | Y | Apache Avro |
+| `bson` | N | N | Binary JSON; common with MongoDB exports/dumps |
+| `cbor` | N | N | Concise Binary Object Representation |
+| `ion` | N | N | Amazon Ion |
+| `msgpack` | N | N | MessagePack |
+| `pb` | N | N | Protocol Buffers (Google Protobuf) |
+| `pbf` | N | N | Protocolbuffer Binary Format; often for GIS data |
+| `proto` | N | N | Protocol Buffers schema; often in .pb / .bin |
+
+#### Databases and Embedded Storage
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `accdb` | N | N | Microsoft Access (newer format) |
+| `duckdb` | N | N | DuckDB |
+| `mdb` | N | N | Microsoft Access (older format) |
+| `sqlite` | N | N | SQLite |
+
+#### Spreadsheets
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `numbers` | N | N | Apple Numbers |
+| `ods` | N | N | OpenDocument |
+| `wks` | N | N | Lotus 1-2-3  |
+| `xls` | Y | Y | Microsoft Excel (BIFF) |
+| `xlsm` | N | N | Microsoft Excel Macro-Enabled (Open XML) |
+| `xlsx` | Y | Y | Microsoft Excel (Open XML) |
+
+#### Statistical / Scientific / Numeric Computing
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `dta` | N | N | Stata |
+| `hdf5` | N | N | Hierarchical Data Format |
+| `mat` | N | N | MATLAB |
+| `nc` | N | N | NetCDF |
+| `rda` | N | N | RData workspace/object |
+| `rds` | N | N | R data |
+| `sas7bdat` | N | N | SAS data |
+| `sav` | N | N | SPSS data |
+| `sylk` | N | N | Symbolic Link |
+| `xpt` | N | N | SAS Transport |
+| `zsav` | N | N | Compressed SPSS data |
+
+#### Logs and Event Streams
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `log` | N | N | Generic log file |
+
+#### Data Archives
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `gz` | Y | Y | Gzip-compressed file |
+| `zip` | Y | Y | ZIP archive |
+
+#### Templates
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `hbs` | N | N | Handlebars |
+| `jinja2` | N | N | Jinja2 |
+| `mustache` | N | N | Mustache |
+| `vm` | N | N | Apache Velocity |
+
 ## Usage
 
 ### Command Line Interface
@@ -382,7 +531,7 @@ cat examples/data/sample.json \
 Use ETLPlus as a Python library:
 
 ```python
-from etlplus import extract, validate, transform, load
+from etlplus.ops import extract, validate, transform, load
 
 # Extract data
 data = extract("file", "data.json")
@@ -577,7 +726,7 @@ We split tests into two layers:
   pagination + rate limit defaults, file/API connector interactions) may touch temp files and use
   fake clients.
 
-If a test calls `etlplus.cli.main()` or `etlplus.run.run()` it’s integration by default.  Full
+If a test calls `etlplus.cli.main()` or `etlplus.ops.run.run()` it’s integration by default. Full
 criteria: [`CONTRIBUTING.md#testing`](CONTRIBUTING.md#testing).
 
 ### Code Coverage
@@ -656,12 +805,12 @@ Navigate to detailed documentation for each subpackage:
 
 - [etlplus.api](etlplus/api/README.md): Lightweight HTTP client and paginated REST helpers
 - [etlplus.file](etlplus/file/README.md): Unified file format support and helpers
-- [etlplus.config](etlplus/config/README.md): Configuration helpers for connectors, pipelines, jobs,
-  and profiles
-- [etlplus.cli](etlplus/cli/README.md): Command-line interface for ETLPlus workflows
+- [etlplus.cli](etlplus/cli/README.md): Command-line interface definitions for `etlplus`
 - [etlplus.database](etlplus/database/README.md): Database engine, schema, and ORM helpers
 - [etlplus.templates](etlplus/templates/README.md): SQL and DDL template helpers
 - [etlplus.validation](etlplus/validation/README.md): Data validation utilities and helpers
+- [etlplus.workflow](etlplus/workflow/README.md): Helpers for data connectors, pipelines, jobs, and
+  profiles
 
 ### Community Health
 

{etlplus-0.12.5 → etlplus-0.15.2}/README.md

@@ -18,6 +18,21 @@ package and command-line interface for data extraction, validation, transformati
   - [Features](#features)
   - [Installation](#installation)
   - [Quickstart](#quickstart)
+  - [Data Connectors](#data-connectors)
+    - [REST APIs (`api`)](#rest-apis-api)
+    - [Databases (`database`)](#databases-database)
+    - [Files (`file`)](#files-file)
+      - [Stubbed / Placeholder](#stubbed--placeholder)
+      - [Tabular \& Delimited Text](#tabular--delimited-text)
+      - [Semi-Structured Text](#semi-structured-text)
+      - [Columnar / Analytics-Friendly](#columnar--analytics-friendly)
+      - [Binary Serialization and Interchange](#binary-serialization-and-interchange)
+      - [Databases and Embedded Storage](#databases-and-embedded-storage)
+      - [Spreadsheets](#spreadsheets)
+      - [Statistical / Scientific / Numeric Computing](#statistical--scientific--numeric-computing)
+      - [Logs and Event Streams](#logs-and-event-streams)
+      - [Data Archives](#data-archives)
+      - [Templates](#templates)
   - [Usage](#usage)
     - [Command Line Interface](#command-line-interface)
       - [Argument Order and Required Options](#argument-order-and-required-options)
@@ -131,7 +146,7 @@ etlplus extract file examples/data/sample.csv \
 [Python API](#python-api):
 
 ```python
-from etlplus import extract, transform, validate, load
+from etlplus.ops import extract, transform, validate, load
 
 data = extract("file", "input.csv")
 ops = {"filter": {"field": "age", "op": "gt", "value": 25}, "select": ["name", "email"]}
@@ -141,6 +156,140 @@ assert validate(filtered, rules)["valid"]
 load(filtered, "file", "temp/sample_output.json", file_format="json")
 ```
 
+## Data Connectors
+
+Data connectors abstract sources from which to extract data and targets to which to load data. They
+are differentiated by their types, each of which is represented in the subsections below.
+
+### REST APIs (`api`)
+
+ETLPlus can extract from REST APIs and load results via common HTTP methods. Supported operations
+include GET for extract and PATCH/POST/PUT for load.
+
+### Databases (`database`)
+
+Database connectors use connection strings for extraction and loading, and
+DDL can be rendered from table specs for migrations or schema checks.
+
+### Files (`file`)
+
+Recognized file formats are listed in the tables below. Support for reading to or writing from a recognized file format is marked as:
+
+- **Y**: implemented (may require optional dependencies)
+- **N**: stubbed or not yet implemented
+
+#### Stubbed / Placeholder
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `stub` | N | Placeholder format for tests and future connectors. |
+
+#### Tabular & Delimited Text
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `csv` | Y | Y | Comma-Separated Values |
+| `dat` | N | N | Generic data file, often delimited or fixed-width |
+| `fwf` | N | N | Fixed-Width Fields |
+| `psv` | N | N | Pipe-Separated Values |
+| `tab` | N | N | Often synonymous with TSV |
+| `tsv` | Y | Y | Tab-Separated Values |
+| `txt` | Y | Y | Plain text, often delimited or fixed-width |
+
+#### Semi-Structured Text
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `cfg` | N | N | Config-style key-value pairs |
+| `conf` | N | N | Config-style key-value pairs |
+| `ini` | N | N | Config-style key-value pairs |
+| `json` | Y | Y | JavaScript Object Notation |
+| `ndjson` | Y | Y | Newline-Delimited JSON |
+| `properties` | N | N | Java-style key-value pairs |
+| `toml` | N | N | Tom's Obvious Minimal Language |
+| `xml` | Y | Y | Extensible Markup Language |
+| `yaml` | Y | Y | YAML Ain't Markup Language |
+
+#### Columnar / Analytics-Friendly
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `arrow` | N | N | Apache Arrow IPC |
+| `feather` | Y | Y | Apache Arrow Feather |
+| `orc` | Y | Y | Optimized Row Columnar; common in Hadoop |
+| `parquet` | Y | Y | Apache Parquet; common in Big Data |
+
+#### Binary Serialization and Interchange
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `avro` | Y | Y | Apache Avro |
+| `bson` | N | N | Binary JSON; common with MongoDB exports/dumps |
+| `cbor` | N | N | Concise Binary Object Representation |
+| `ion` | N | N | Amazon Ion |
+| `msgpack` | N | N | MessagePack |
+| `pb` | N | N | Protocol Buffers (Google Protobuf) |
+| `pbf` | N | N | Protocolbuffer Binary Format; often for GIS data |
+| `proto` | N | N | Protocol Buffers schema; often in .pb / .bin |
+
+#### Databases and Embedded Storage
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `accdb` | N | N | Microsoft Access (newer format) |
+| `duckdb` | N | N | DuckDB |
+| `mdb` | N | N | Microsoft Access (older format) |
+| `sqlite` | N | N | SQLite |
+
+#### Spreadsheets
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `numbers` | N | N | Apple Numbers |
+| `ods` | N | N | OpenDocument |
+| `wks` | N | N | Lotus 1-2-3  |
+| `xls` | Y | Y | Microsoft Excel (BIFF) |
+| `xlsm` | N | N | Microsoft Excel Macro-Enabled (Open XML) |
+| `xlsx` | Y | Y | Microsoft Excel (Open XML) |
+
+#### Statistical / Scientific / Numeric Computing
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `dta` | N | N | Stata |
+| `hdf5` | N | N | Hierarchical Data Format |
+| `mat` | N | N | MATLAB |
+| `nc` | N | N | NetCDF |
+| `rda` | N | N | RData workspace/object |
+| `rds` | N | N | R data |
+| `sas7bdat` | N | N | SAS data |
+| `sav` | N | N | SPSS data |
+| `sylk` | N | N | Symbolic Link |
+| `xpt` | N | N | SAS Transport |
+| `zsav` | N | N | Compressed SPSS data |
+
+#### Logs and Event Streams
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `log` | N | N | Generic log file |
+
+#### Data Archives
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `gz` | Y | Y | Gzip-compressed file |
+| `zip` | Y | Y | ZIP archive |
+
+#### Templates
+
+| Format | Read | Write | Description |
+| --- | --- | --- | --- |
+| `hbs` | N | N | Handlebars |
+| `jinja2` | N | N | Jinja2 |
+| `mustache` | N | N | Mustache |
+| `vm` | N | N | Apache Velocity |
+
 ## Usage
 
 ### Command Line Interface
@@ -332,7 +481,7 @@ cat examples/data/sample.json \
 Use ETLPlus as a Python library:
 
 ```python
-from etlplus import extract, validate, transform, load
+from etlplus.ops import extract, validate, transform, load
 
 # Extract data
 data = extract("file", "data.json")
@@ -527,7 +676,7 @@ We split tests into two layers:
   pagination + rate limit defaults, file/API connector interactions) may touch temp files and use
   fake clients.
 
-If a test calls `etlplus.cli.main()` or `etlplus.run.run()` it’s integration by default.  Full
+If a test calls `etlplus.cli.main()` or `etlplus.ops.run.run()` it’s integration by default. Full
 criteria: [`CONTRIBUTING.md#testing`](CONTRIBUTING.md#testing).
 
 ### Code Coverage
@@ -606,12 +755,12 @@ Navigate to detailed documentation for each subpackage:
 
 - [etlplus.api](etlplus/api/README.md): Lightweight HTTP client and paginated REST helpers
 - [etlplus.file](etlplus/file/README.md): Unified file format support and helpers
-- [etlplus.config](etlplus/config/README.md): Configuration helpers for connectors, pipelines, jobs,
-  and profiles
-- [etlplus.cli](etlplus/cli/README.md): Command-line interface for ETLPlus workflows
+- [etlplus.cli](etlplus/cli/README.md): Command-line interface definitions for `etlplus`
 - [etlplus.database](etlplus/database/README.md): Database engine, schema, and ORM helpers
 - [etlplus.templates](etlplus/templates/README.md): SQL and DDL template helpers
 - [etlplus.validation](etlplus/validation/README.md): Data validation utilities and helpers
+- [etlplus.workflow](etlplus/workflow/README.md): Helpers for data connectors, pipelines, jobs, and
+  profiles
 
 ### Community Health
 

{etlplus-0.12.5 → etlplus-0.15.2}/docs/pipeline-guide.md

@@ -281,7 +281,7 @@ section.
 
 ## Validations
 
-Validation rule sets map field names to rules, mirroring `etlplus.validate.FieldRules`:
+Validation rule sets map field names to rules, mirroring `etlplus.ops.validate.FieldRules`:
 
 ```yaml
 validations:
@@ -297,7 +297,7 @@ validations:
 
 ## Transforms
 
-Transformation pipelines follow `etlplus.transform` shapes exactly:
+Transformation pipelines follow `etlplus.ops.transform` shapes exactly:
 
 ```yaml
 transforms:
@@ -377,9 +377,9 @@ Details:
 - Unknown or malformed entries are skipped rather than failing the whole load (keeping pipeline
   authoring permissive).
 - The connector kind is also available as a type-safe literal in code as
-  `etlplus.config.ConnectorType` (values: `"file" | "database" | "api"`).
+  `etlplus.workflow.ConnectorType` (values: `"file" | "database" | "api"`).
 
-To add new connector kinds in the future, implement a new dataclass in `etlplus.config.connector`
+To add new connector kinds in the future, implement a new dataclass in `etlplus.workflow.connector`
 and extend the internal parser to handle its `type` value.
 
 ## Jobs
@@ -390,10 +390,20 @@ target:
 ```yaml
 jobs:
   - name: file_to_file_customers
+    depends_on: [seed_customers]
     extract: { source: customers_csv }
     validate: { ruleset: customers_basic }
     transform: { pipeline: clean_customers }
     load: { target: customers_json_out }
+  - name: seed_customers
+    extract: { source: seed_customers_csv }
+    load: { target: customers_db_out }
+```
+
+Notes:
+
+- `depends_on` is optional and can be a string or list of job names.
+- Jobs without dependencies run first when ordered as a DAG.
 
 ## Running pipelines (CLI and Python)
 
@@ -421,14 +431,14 @@ Notes:
 - 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).
+  [Runner internals: etlplus.ops.run](run-module.md).
 
-### Python: `etlplus.run.run`
+### Python: `etlplus.ops.run.run`
 
 To trigger a job programmatically, use the high-level runner function exposed by the package:
 
 ```python
-from etlplus.run import run as run_job
+from etlplus.ops.run import run as run_job
 
 result = run_job(
     job="file_to_file_customers",

{etlplus-0.12.5 → etlplus-0.15.2}/etlplus/README.md

@@ -1,4 +1,4 @@
-# etlplus package
+# `etlplus` Package
 
 The `etlplus` package provides a unified Python API and CLI for ETL operations: extraction,
 validation, transformation, and loading of data from files, APIs, and databases.
@@ -13,17 +13,17 @@ Back to project overview: see the top-level [README](../README.md).
 
 - [etlplus.api](api/README.md): Lightweight HTTP client and paginated REST helpers
 - [etlplus.file](file/README.md): Unified file format support and helpers
-- [etlplus.config](config/README.md): Configuration helpers for connectors, pipelines, jobs, and
-  profiles
-- [etlplus.cli](cli/README.md): Command-line interface for ETLPlus workflows
+- [etlplus.cli](cli/README.md): Command-line interface definitions for `etlplus`
 - [etlplus.database](database/README.md): Database engine, schema, and ORM helpers
 - [etlplus.templates](templates/README.md): SQL and DDL template helpers
 - [etlplus.validation](validation/README.md): Data validation utilities and helpers
+- [etlplus.workflow](etlplus/workflow/README.md): Helpers for data connectors, pipelines, jobs, and
+  profiles
 
 ## Quickstart
 
 ```python
-from etlplus import extract, validate, transform, load
+from etlplus.ops import extract, validate, transform, load
 
 data = extract("file", "input.csv")
 filtered = transform(data, {"filter": {"field": "age", "op": "gt", "value": 25}})

etlplus-0.15.2/etlplus/__init__.py

@@ -0,0 +1,18 @@
+"""
+:mod:`etlplus` package.
+
+Top-level facade for the ETLPlus toolkit.
+"""
+
+from .__version__ import __version__
+
+__author__ = 'ETLPlus Team'
+
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    '__author__',
+    '__version__',
+]

{etlplus-0.12.5 → etlplus-0.15.2}/etlplus/api/README.md

@@ -1,4 +1,4 @@
-# etlplus.api subpackage
+# `etlplus.api` Subpackage
 
 Documentation for the `etlplus.api` subpackage: a lightweight HTTP client and helpers for paginated
 REST endpoints.
@@ -12,7 +12,7 @@ REST endpoints.
 
 Back to project overview: see the top-level [README](../../README.md).
 
-- [etlplus.api subpackage](#etlplusapi-subpackage)
+- [`etlplus.api` Subpackage](#etlplusapi-subpackage)
   - [Installation](#installation)
   - [Quickstart](#quickstart)
     - [Overriding Rate Limits Per Call](#overriding-rate-limits-per-call)
@@ -22,6 +22,7 @@ Back to project overview: see the top-level [README](../../README.md).
   - [Authentication](#authentication)
   - [Errors and Rate Limiting](#errors-and-rate-limiting)
   - [Types and Transport](#types-and-transport)
+  - [Config Schemas](#config-schemas)
   - [Supporting Modules](#supporting-modules)
   - [Minimal Contract](#minimal-contract)
   - [See also](#see-also)
@@ -225,6 +226,36 @@ providers can fall back to their own defaults. If you already possess a static t
   `etlplus/api/request_manager.py` wraps `requests` sessions plus retry orchestration. Advanced
   users may consult those modules to adapt behavior.
 
+## Config Schemas
+
+`etlplus.api.types` defines TypedDict-based configuration shapes for API profiles and endpoints.
+Runtime parsing remains permissive in `etlplus.api.config`, but these types improve IDE
+autocomplete and static analysis.
+
+Exported types:
+
+- `ApiConfigMap`: top-level API config shape
+- `ApiProfileConfigMap`: per-profile API config shape
+- `ApiProfileDefaultsMap`: defaults block within a profile
+- `EndpointMap`: endpoint config shape
+
+Example:
+
+```python
+from etlplus.api import ApiConfigMap
+
+api_cfg: ApiConfigMap = {
+    "base_url": "https://example.test",
+    "headers": {"Authorization": "Bearer token"},
+    "endpoints": {
+        "users": {
+            "path": "/users",
+            "method": "GET",
+        },
+    },
+}
+```
+
 ## Supporting Modules
 
 - `etlplus.api.types` collects friendly aliases such as `Headers`, `Params`, `Url`, and

{etlplus-0.12.5 → etlplus-0.15.2}/etlplus/api/__init__.py

@@ -78,6 +78,7 @@ from .config import ApiConfig
 from .config import ApiProfileConfig
 from .config import EndpointConfig
 from .endpoint_client import EndpointClient
+from .enums import HttpMethod
 from .pagination import CursorPaginationConfigMap
 from .pagination import PagePaginationConfigMap
 from .pagination import PaginationClient
@@ -98,6 +99,10 @@ from .types import Headers
 from .types import Params
 from .types import RequestOptions
 from .types import Url
+from .utils import compose_api_request_env
+from .utils import compose_api_target_env
+from .utils import paginate_with_client
+from .utils import resolve_request
 
 # SECTION: EXPORTS ========================================================== #
 
@@ -119,9 +124,14 @@ __all__ = [
     'RequestOptions',
     'RetryStrategy',
     # Enums
+    'HttpMethod',
     'PaginationType',
     # Functions
     'build_http_adapter',
+    'compose_api_request_env',
+    'compose_api_target_env',
+    'paginate_with_client',
+    'resolve_request',
     # Type Aliases
     'CursorPaginationConfigMap',
     'Headers',