etlplus 0.9.2__py3-none-any.whl → 0.10.2__py3-none-any.whl

{etlplus-0.9.2.dist-info → etlplus-0.10.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.9.2
+Version: 0.10.2
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -17,11 +17,8 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.13,<3.15
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastavro>=1.12.1
 Requires-Dist: jinja2>=3.1.6
-Requires-Dist: openpyxl>=3.1.5
 Requires-Dist: pyodbc>=5.3.0
-Requires-Dist: pyarrow>=22.0.0
 Requires-Dist: python-dotenv>=1.2.1
 Requires-Dist: pandas>=2.3.3
 Requires-Dist: pydantic>=2.12.5
@@ -29,8 +26,6 @@ Requires-Dist: PyYAML>=6.0.3
 Requires-Dist: requests>=2.32.5
 Requires-Dist: SQLAlchemy>=2.0.45
 Requires-Dist: typer>=0.21.0
-Requires-Dist: xlrd>=2.0.2
-Requires-Dist: xlwt>=1.3.0
 Provides-Extra: dev
 Requires-Dist: black>=25.9.0; extra == "dev"
 Requires-Dist: build>=1.2.2; extra == "dev"
@@ -64,25 +59,9 @@ ETLPlus is a veritable Swiss Army knife for enabling simple ETL operations, offe
 package and command-line interface for data extraction, validation, transformation, and loading.
 
 - [ETLPlus](#etlplus)
-  - [Getting Started](#getting-started)
   - [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)
@@ -108,27 +87,11 @@ package and command-line interface for data extraction, validation, transformati
     - [Linting](#linting)
     - [Updating Demo Snippets](#updating-demo-snippets)
     - [Releasing to PyPI](#releasing-to-pypi)
+  - [Links](#links)
   - [License](#license)
   - [Contributing](#contributing)
-  - [Documentation](#documentation)
-    - [Python Packages/Subpackage](#python-packagessubpackage)
-    - [Community Health](#community-health)
-    - [Other](#other)
   - [Acknowledgments](#acknowledgments)
 
-## Getting Started
-
-ETLPlus helps you extract, validate, transform, and load data from files, databases, and APIs, either
-as a Python library or from the command line.
-
-To get started:
-
-- See [Installation](#installation) for setup instructions.
-- Try the [Quickstart](#quickstart) for a minimal working example (CLI and Python).
-- Explore [Usage](#usage) for more detailed options and workflows.
-
-ETLPlus supports Python 3.13 and above.
-
 ## Features
 
 - **Check** data pipeline definitions before running them:
@@ -196,7 +159,7 @@ etlplus extract file examples/data/sample.csv \
 [Python API](#python-api):
 
 ```python
-from etlplus.ops import extract, transform, validate, load
+from etlplus import extract, transform, validate, load
 
 data = extract("file", "input.csv")
 ops = {"filter": {"field": "age", "op": "gt", "value": 25}, "select": ["name", "email"]}
@@ -206,140 +169,6 @@ 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
@@ -531,7 +360,7 @@ cat examples/data/sample.json \
 Use ETLPlus as a Python library:
 
 ```python
-from etlplus.ops import extract, validate, transform, load
+from etlplus import extract, validate, transform, load
 
 # Extract data
 data = extract("file", "data.json")
@@ -587,7 +416,7 @@ etlplus transform \
 # 3. Validate transformed data
 etlplus validate \
   --rules '{"name": {"type": "string", "required": true}, "email": {"type": "string", "required": true}}' \
-  temp/sample_transformed.json
+  temo/sample_transformed.json
 
 # 4. Load to CSV
 cat temp/sample_transformed.json \
@@ -726,7 +555,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.ops.run.run()` it’s integration by default. Full
+If a test calls `etlplus.cli.main()` or `etlplus.run.run()` it’s integration by default.  Full
 criteria: [`CONTRIBUTING.md#testing`](CONTRIBUTING.md#testing).
 
 ### Code Coverage
@@ -774,6 +603,17 @@ git push origin v1.4.0
 If you want an extra smoke-test before tagging, run `make dist && pip install dist/*.whl` locally;
 this exercises the same build path the workflow uses.
 
+## Links
+
+- API client docs: [`etlplus/api/README.md`](etlplus/api/README.md)
+- Examples: [`examples/README.md`](examples/README.md)
+- Pipeline authoring guide: [`docs/pipeline-guide.md`](docs/pipeline-guide.md)
+- Runner internals: [`docs/run-module.md`](docs/run-module.md)
+- Design notes (Mapping inputs, dict outputs): [`docs/pipeline-guide.md#design-notes-mapping-inputs-dict-outputs`](docs/pipeline-guide.md#design-notes-mapping-inputs-dict-outputs)
+- Typing philosophy: [`CONTRIBUTING.md#typing-philosophy`](CONTRIBUTING.md#typing-philosophy)
+- Demo and walkthrough: [`DEMO.md`](DEMO.md)
+- Additional references: [`REFERENCES.md`](`REFERENCES.md)
+
 ## License
 
 This project is licensed under the [MIT License](LICENSE).
@@ -797,39 +637,6 @@ If you choose to be a code contributor, please first refer these documents:
 - Typing philosophy (TypedDicts as editor hints, permissive runtime):
   [`CONTRIBUTING.md#typing-philosophy`](CONTRIBUTING.md#typing-philosophy)
 
-## Documentation
-
-### Python Packages/Subpackage
-
-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.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
-
-- [Contributing Guidelines](CONTRIBUTING.md): How to contribute, report issues, and submit PRs
-- [Code of Conduct](CODE_OF_CONDUCT.md): Community standards and expectations
-- [Security Policy](SECURITY.md): Responsible disclosure and vulnerability reporting
-- [Support](SUPPORT.md): Where to get help
-
-### Other
-
-- API client docs: [`etlplus/api/README.md`](etlplus/api/README.md)
-- Examples: [`examples/README.md`](examples/README.md)
-- Pipeline authoring guide: [`docs/pipeline-guide.md`](docs/pipeline-guide.md)
-- Runner internals: [`docs/run-module.md`](docs/run-module.md)
-- Design notes (Mapping inputs, dict outputs): [`docs/pipeline-guide.md#design-notes-mapping-inputs-dict-outputs`](docs/pipeline-guide.md#design-notes-mapping-inputs-dict-outputs)
-- Typing philosophy: [`CONTRIBUTING.md#typing-philosophy`](CONTRIBUTING.md#typing-philosophy)
-- Demo and walkthrough: [`DEMO.md`](DEMO.md)
-- Additional references: [`REFERENCES.md`](REFERENCES.md)
-
 ## Acknowledgments
 
 ETLPlus is inspired by common work patterns in data engineering and software engineering patterns in

etlplus-0.10.2.dist-info/RECORD

@@ -0,0 +1,65 @@
+etlplus/__init__.py,sha256=M2gScnyir6WOMAh_EuoQIiAzdcTls0_5hbd_Q6of8I0,1021
+etlplus/__main__.py,sha256=btoROneNiigyfBU7BSzPKZ1R9gzBMpxcpsbPwmuHwTM,479
+etlplus/__version__.py,sha256=1E0GMK_yUWCMQFKxXjTvyMwofi0qT2k4CDNiHWiymWE,327
+etlplus/enums.py,sha256=JvXdX_x_U3LNnGZdX3Uo9dqipoDdqnLtZBmZE4DSei8,15426
+etlplus/extract.py,sha256=f44JdHhNTACxgn44USx05paKTwq7LQY-V4wANCW9hVM,6173
+etlplus/file.py,sha256=B-zebTrIFDKaaKzA9Fq5-L0JwDNYa2T--_6veR3N03s,17939
+etlplus/load.py,sha256=R_y0_vtsEo1bwxWVQu2bfhB5ZIJoIoWu2ycCdvY4RnE,8737
+etlplus/mixins.py,sha256=ifGpHwWv7U00yqGf-kN93vJax2IiK4jaGtTsPsO3Oak,1350
+etlplus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+etlplus/run.py,sha256=X4kp5FQlIWVf1_d9oSrchKau7BFDCE1Zkscvu7WPaWw,12340
+etlplus/run_helpers.py,sha256=bj6MkaeFxjl3CeKG1HoXKx5DwAlXNERVW-GX-z1P_qQ,24373
+etlplus/transform.py,sha256=uAUVDDHYCgx7GpVez9IK3OAZM-CnCuMa9iox3vwGGJA,25296
+etlplus/types.py,sha256=1hsDlnF6r76zAwaUYay-i6pCM-Y0IU5nP7Crj8PLCQ4,6157
+etlplus/utils.py,sha256=BMLTWAvCJj3zLEcffBgURYnu0UGhhXsfH2WWpAt7fV8,13363
+etlplus/validate.py,sha256=7rJoEI_SIILdPpoBqqh2UJqg9oeReDz34mYSlc3t7Qg,12989
+etlplus/api/README.md,sha256=ZiyjxLz0LfFCzeYKXwtH8yY1OJ4hXCju7t2ICroFoU8,7215
+etlplus/api/__init__.py,sha256=P2JUYFy6Ep4t6xnsBiCBfQCkQLHYYhA-yXPXCobS8Y0,4295
+etlplus/api/auth.py,sha256=GOO5on-LoMS1GXTAhtK9rFcfpjbBcNeA6NE5UZwIq0g,12158
+etlplus/api/config.py,sha256=wRpOaZ31sPReVzEMme0jKl_37nqgraESwuYSNxP_xDo,17397
+etlplus/api/endpoint_client.py,sha256=PxCvBsvFhTIjEbY6drIIvciynHXQEvKu47Pi63Gxwqs,30693
+etlplus/api/errors.py,sha256=XjI2xW-sypMUNUbqfc2S57-IGyWnH3oCDFhCmKYYI_Q,4648
+etlplus/api/request_manager.py,sha256=YkDz803HM3BBzamsEZdSdE9fbVT0avMbTaLAgar9Wzo,18481
+etlplus/api/retry_manager.py,sha256=0GDhJVyIlb1Ww35JUWlYoa8QYUPjKLBtxQeZj3TdLbY,11306
+etlplus/api/transport.py,sha256=LRsQEPxIYrvXQQMvgPPkIl_57YCmanzsWNEnSYdP_d8,9164
+etlplus/api/types.py,sha256=687JigIf3qfYxgGTNBaMNsQsrza5Pja6DcK5llM9oRU,4591
+etlplus/api/pagination/__init__.py,sha256=a4UX2J0AG8RMvmHt_CCofUm5vSmFo6GAfkb8XnSXypM,1395
+etlplus/api/pagination/client.py,sha256=42cG442od3mQkw_JsvGvxT_w7y9J4HPM5PB4tFFU6EQ,5383
+etlplus/api/pagination/config.py,sha256=3dXDJ-nMbO9Zk6i344n4roBFbUlHsa294D1_plPmm6E,13579
+etlplus/api/pagination/paginator.py,sha256=wtdY_er4yfjx5yTUQJ1gPq-IuWmpLAHeG5buBQZJm54,24453
+etlplus/api/rate_limiting/__init__.py,sha256=ZySB1dZettEDnWvI1EHf_TZ9L08M_kKsNR-Y_lbU6kI,1070
+etlplus/api/rate_limiting/config.py,sha256=2b4wIynblN-1EyMqI4aXa71SljzSjXYh5N1Nngr3jOg,9406
+etlplus/api/rate_limiting/rate_limiter.py,sha256=Uxozqd_Ej5Lsj-M-mLT2WexChgWh7x35_YP10yqYPQA,7159
+etlplus/cli/__init__.py,sha256=J97-Rv931IL1_b4AXnB7Fbbd7HKnHBpx18NQfC_kE6c,299
+etlplus/cli/commands.py,sha256=BK2qmFsser6AXOgEvpiadrYMIiwviAzqkSxMlBhRXRw,24670
+etlplus/cli/constants.py,sha256=KIZj7J2tNf5mJbkqAdZmu5FXYW2FQmxwgeOKWc3-3Hg,1944
+etlplus/cli/handlers.py,sha256=K0GazvrPgocJ-63HZqF0xhyJk8TB1Gcj-eIbWltXKRU,17759
+etlplus/cli/io.py,sha256=7sldiZz4-Geomge5IO_XYykXPa6UiORfUWzLCdQePG8,7846
+etlplus/cli/main.py,sha256=IgeqxypixfwLHR-QcpgVMQ7vMZ865bXOh2oO9v-BWeM,5234
+etlplus/cli/options.py,sha256=vfXT3YLh7wG1iC-aTdSg6ItMC8l6n0Lozmy53XjqLbA,1199
+etlplus/cli/state.py,sha256=Pfd8ru0wYIN7eGp1_A0tioqs1LiCDZCuJ6AnjZb6yYQ,8027
+etlplus/cli/types.py,sha256=tclhKVJXDqHzlTQBYKARfqMgDOcuBJ-Zej2pvFy96WM,652
+etlplus/config/__init__.py,sha256=VZWzOg7d2YR9NT6UwKTv44yf2FRUMjTHynkm1Dl5Qzo,1486
+etlplus/config/connector.py,sha256=0-TIwevHbKRHVmucvyGpPd-3tB1dKHB-dj0yJ6kq5eY,9809
+etlplus/config/jobs.py,sha256=hmzRCqt0OvCEZZR4ONKrd3lvSv0OmayjLc4yOBk3ug8,7399
+etlplus/config/pipeline.py,sha256=Va4MQY6KEyKqHGMKPmh09ZcGpx95br-iNUjpkqtzVbw,9500
+etlplus/config/profile.py,sha256=Ss2zedQGjkaGSpvBLTD4SZaWViMJ7TJPLB8Q2_BTpPg,1898
+etlplus/config/types.py,sha256=a0epJ3z16HQ5bY3Ctf8s_cQPa3f0HHcwdOcjCP2xoG4,4954
+etlplus/config/utils.py,sha256=4SUHMkt5bKBhMhiJm-DrnmE2Q4TfOgdNCKz8PJDS27o,3443
+etlplus/database/__init__.py,sha256=AKJsDl2RHuRGPS-eXgNJeh4aSncJP5Y0yLApBF6i7i8,1052
+etlplus/database/ddl.py,sha256=z9KvHi1MPhPBLHxMDdqJgLTp3A2-lcz0gqhZ7HIE6kU,7916
+etlplus/database/engine.py,sha256=7rr7YndA8LwyWJL8k1YhQbqxxmW4gWEUQjp0NwQcYtc,4061
+etlplus/database/orm.py,sha256=gCSqH-CjQz6tV9133-VqgiwokK5ylun0BwXaIWfImAo,10008
+etlplus/database/schema.py,sha256=HNTgglI8qvQLInr7gq--2lLmLKHzAZTL2MJUOIw9DlY,7025
+etlplus/database/types.py,sha256=_pkQyC14TzAlgyeIqZG4F5LWYknZbHw3TW68Auk7Ya0,795
+etlplus/templates/__init__.py,sha256=tsniN7XJYs3NwYxJ6c2HD5upHP3CDkLx-bQCMt97UOM,106
+etlplus/templates/ddl.sql.j2,sha256=s8fMWvcb4eaJVXkifuib1aQPljtZ8buuyB_uA-ZdU3Q,4734
+etlplus/templates/view.sql.j2,sha256=Iy8DHfhq5yyvrUKDxqp_aHIEXY4Tm6j4wT7YDEFWAhk,2180
+etlplus/validation/__init__.py,sha256=Pe5Xg1_EA4uiNZGYu5WTF3j7odjmyxnAJ8rcioaplSQ,1254
+etlplus/validation/utils.py,sha256=Mtqg449VIke0ziy_wd2r6yrwJzQkA1iulZC87FzXMjo,10201
+etlplus-0.10.2.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
+etlplus-0.10.2.dist-info/METADATA,sha256=rz0pmbVOfFoJ4HWJuSiNm-oMVbZ8Uf44bcgFRlXxBxU,21036
+etlplus-0.10.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+etlplus-0.10.2.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
+etlplus-0.10.2.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
+etlplus-0.10.2.dist-info/RECORD,,

{etlplus-0.9.2.dist-info → etlplus-0.10.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

etlplus/README.md

@@ -1,37 +0,0 @@
-# `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.
-
-- Top-level entry points for extract, validate, transform, and load
-- Utilities for pipeline orchestration and helpers
-- Exposes all subpackages for advanced usage
-
-Back to project overview: see the top-level [README](../README.md).
-
-## Subpackages
-
-- [etlplus.api](api/README.md): Lightweight HTTP client and paginated REST helpers
-- [etlplus.file](file/README.md): Unified file format support and helpers
-- [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.ops import extract, validate, transform, load
-
-data = extract("file", "input.csv")
-filtered = transform(data, {"filter": {"field": "age", "op": "gt", "value": 25}})
-assert validate(filtered, {"age": {"type": "number", "min": 0}})["valid"]
-load(filtered, "file", "output.json", file_format="json")
-```
-
-## See Also
-
-- [Top-level project README](../README.md)
-- [API reference](../docs/README.md)

etlplus/api/enums.py

@@ -1,51 +0,0 @@
-"""
-:mod:`etlplus.api.enums` module.
-
-File-specific REST API-aligned enums and helpers.
-"""
-
-from __future__ import annotations
-
-from ..enums import CoercibleStrEnum
-
-# SECTION: EXPORTS ========================================================= #
-
-
-__all__ = [
-    # Enums
-    'HttpMethod',
-]
-
-
-# SECTION: ENUMS ============================================================ #
-
-
-class HttpMethod(CoercibleStrEnum):
-    """Supported HTTP verbs that accept JSON payloads."""
-
-    # -- Constants -- #
-
-    CONNECT = 'connect'
-    DELETE = 'delete'
-    GET = 'get'
-    HEAD = 'head'
-    OPTIONS = 'options'
-    PATCH = 'patch'
-    POST = 'post'
-    PUT = 'put'
-    TRACE = 'trace'
-
-    # -- Getters -- #
-
-    @property
-    def allows_body(self) -> bool:
-        """
-        Whether the method typically allows a request body.
-
-        Notes
-        -----
-        - RFCs do not strictly forbid bodies on some other methods (e.g.,
-            ``DELETE``), but many servers/clients do not expect them. We mark
-            ``POST``, ``PUT``, and ``PATCH`` as True.
-        """
-        return self in {HttpMethod.POST, HttpMethod.PUT, HttpMethod.PATCH}

etlplus/cli/README.md

@@ -1,40 +0,0 @@
-# `etlplus.cli` Subpackage
-
-Documentation for the `etlplus.cli` subpackage: command-line interface for ETLPlus workflows.
-
-- Provides a CLI for running ETL pipelines, jobs, and utilities
-- Supports commands for running, validating, and inspecting pipelines
-- Includes options for configuration, state, and output control
-- Exposes handlers for custom command integration
-
-Back to project overview: see the top-level [README](../../README.md).
-
-- [`etlplus.cli` Subpackage](#etlpluscli-subpackage)
-  - [Available Commands](#available-commands)
-  - [Command Options](#command-options)
-  - [Example: Running a Pipeline](#example-running-a-pipeline)
-  - [See Also](#see-also)
-
-## Available Commands
-
-- **run**: Execute a pipeline or job
-- **validate**: Validate pipeline or config files
-- **inspect**: Show pipeline/job details
-
-## Command Options
-
-- `--config`: Path to config file
-- `--state`: Path to state file
-- `--output`: Output file or format
-
-## Example: Running a Pipeline
-
-```bash
-etlplus run --config configs/pipeline.yml --output results.json
-```
-
-## See Also
-
-- Top-level CLI and library usage in the main [README](../../README.md)
-- Command handlers in [handlers.py](handlers.py)
-- Command options in [options.py](options.py)

etlplus/database/README.md

@@ -1,48 +0,0 @@
-# `etlplus.database` Subpackage
-
-Documentation for the `etlplus.database` subpackage: database engine, schema, and ORM helpers.
-
-- Provides database engine and connection management
-- Supports schema definition and DDL generation
-- Includes lightweight ORM utilities for tabular data
-- Exposes type definitions for database objects
-
-Back to project overview: see the top-level [README](../../README.md).
-
-- [`etlplus.database` Subpackage](#etlplusdatabase-subpackage)
-  - [Database Engine and Connections](#database-engine-and-connections)
-  - [Schema and DDL Helpers](#schema-and-ddl-helpers)
-  - [ORM Utilities](#orm-utilities)
-  - [Example: Creating a Table](#example-creating-a-table)
-  - [See Also](#see-also)
-
-## Database Engine and Connections
-
-- Manage connections to supported databases
-- Configure engines for different backends
-
-## Schema and DDL Helpers
-
-- Define table schemas and columns
-- Generate DDL statements for supported databases
-
-## ORM Utilities
-
-- Map rows to Python objects
-- Simple CRUD helpers for tabular data
-
-## Example: Creating a Table
-
-```python
-from etlplus.database import Schema, Engine
-
-engine = Engine.connect("sqlite:///example.db")
-schema = Schema.from_dict({"name": "users", "columns": [ ... ]})
-engine.create_table(schema)
-```
-
-## See Also
-
-- Top-level CLI and library usage in the main [README](../../README.md)
-- Schema helpers in [schema.py](schema.py)
-- ORM utilities in [orm.py](orm.py)

etlplus/file/README.md

@@ -1,105 +0,0 @@
-# `etlplus.file` Subpackage
-
-Documentation for the `etlplus.file` subpackage: unified file format support and helpers for reading
-and writing data files.
-
-- Provides a consistent interface for reading and writing files in various formats
-- Supports all formats defined in `FileFormat` (see below)
-- Includes helpers for inferring file format and compression from filenames, extensions, or MIME
-  types
-- Exposes a `File` class with instance methods for reading and writing data
-
-Back to project overview: see the top-level [README](../../README.md).
-
-- [`etlplus.file` Subpackage](#etlplusfile-subpackage)
-  - [Supported File Formats](#supported-file-formats)
-  - [Inferring File Format and Compression](#inferring-file-format-and-compression)
-  - [Reading and Writing Files](#reading-and-writing-files)
-    - [Reading a File](#reading-a-file)
-    - [Writing a File](#writing-a-file)
-  - [File Instance Methods](#file-instance-methods)
-  - [Example: Reading and Writing](#example-reading-and-writing)
-  - [See Also](#see-also)
-
-## Supported File Formats
-
-The following formats are defined in `FileFormat` and supported for reading and writing:
-
-| Format    | Description                                 |
-|-----------|---------------------------------------------|
-| avro      | Apache Avro binary serialization            |
-| csv       | Comma-separated values text files           |
-| feather   | Apache Arrow Feather columnar format        |
-| gz        | Gzip-compressed files (see Compression)     |
-| json      | Standard JSON files                         |
-| ndjson    | Newline-delimited JSON (JSON Lines)         |
-| orc       | Apache ORC columnar format                  |
-| parquet   | Apache Parquet columnar format              |
-| tsv       | Tab-separated values text files             |
-| txt       | Plain text files                            |
-| xls       | Microsoft Excel (legacy .xls)               |
-| xlsx      | Microsoft Excel (modern .xlsx)              |
-| zip       | ZIP-compressed files (see Compression)      |
-| xml       | XML files                                   |
-| yaml      | YAML files                                  |
-
-Compression formats (gz, zip) are also supported as wrappers for other formats.
-
-## Inferring File Format and Compression
-
-Use `infer_file_format_and_compression(value, filename=None)` to infer the file format and
-compression from a filename, extension, or MIME type. Returns a tuple `(file_format,
-compression_format)`.
-
-## Reading and Writing Files
-
-The main entry point for file operations is the `File` class. To read or write files:
-
-### Reading a File
-
-```python
-from etlplus.file import File
-
-f = File("data/sample.csv")
-data = f.read()
-```
-
-- The `read()` method automatically detects the format and compression.
-- Returns parsed data (e.g., list of dicts for tabular formats).
-
-### Writing a File
-
-```python
-from etlplus.file import File
-
-f = File("output.json")
-f.write(data)
-```
-
-- The `write()` method serializes and writes data in the appropriate format.
-- Supports all formats listed above.
-
-## File Instance Methods
-
-- `read()`: Reads and parses the file, returning structured data.
-- `write(data)`: Writes structured data to the file in the detected format.
-
-## Example: Reading and Writing
-
-```python
-from etlplus.file import File
-
-# Read CSV
-csv_file = File("data.csv")
-rows = csv_file.read()
-
-# Write JSON
-json_file = File("output.json")
-json_file.write(rows)
-```
-
-## See Also
-
-- Top-level CLI and library usage in the main [README](../../README.md)
-- File format enums in [enums.py](enums.py)
-- Compression format enums in [enums.py](enums.py)