dtex 0.1.0__tar.gz

dtex-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+# Python
+__pycache__/
+*.pyc
+
+# Virtual environments
+.venv/
+
+# Build artifacts
+dist/
+build/
+*.egg-info/
+
+# Test & type-check caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# dtex local state
+.duckdb
+.dtex/

dtex-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,152 @@
+# Contributing to dtex
+
+Thanks for your interest in dtex. The governing principle is the
+[design handbook](./docs/00-vision-and-naming.md): **keep it as simple as
+possible.** This file covers dev setup, the PR process, and how to add a
+new connector or secret-manager resolver.
+
+By participating in this project you agree to abide by the
+[Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## Dev setup
+
+dtex targets Python 3.11+. Clone the repo, then create a virtual environment
+and install the package in editable mode with the `dev` extras:
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Run the tests
+
+```sh
+pytest -q
+```
+
+## Run the linter and type checker
+
+```sh
+ruff check .
+mypy dtex
+```
+
+Please make sure `pytest`, `ruff check`, and `mypy` all pass before opening a
+pull request.
+
+## Spec precedence: code is the source of truth
+
+The [design handbook](./docs/) (`docs/00`–`docs/12`) was written before the
+implementation and remains the canonical *intent*. But once a contract is
+implemented in code, **the code is the source of truth** — if the handbook and
+the code diverge, fix the handbook to match the code, not the other way around.
+This avoids re-litigating handbook ambiguities at every stage.
+
+Worked examples already in the tree:
+
+- `dtex/types.py::StateRecord` defines the canonical `_dtex_state` schema
+  (docs/03 §3.5 and docs/05 §5.1 follow it).
+- **Configs are the runtime unit.** The CLI's `-p / --conf` arg and
+  `dtex.run(config=...)` library entry point both take a *config name* —
+  there is no source-alone selector. Documents `06`, `07`, and `12` follow
+  this.
+
+## PR process
+
+1. Branch off `main`.
+2. Make one logical change per PR — small PRs review faster and revert cleaner.
+3. Run the local checks before pushing:
+   ```sh
+   pytest -q && ruff check . && mypy dtex
+   ```
+4. Add or update tests for any new code path. Bug-fix PRs should land a
+   regression test alongside the fix.
+5. If you touch the public surface (a contract type, a CLI flag, a baked
+   connector's `register.yaml`, the secret-resolver protocol), update the
+   relevant chapter under `docs/` in the same PR.
+6. Add an entry under the `## [Unreleased]` section of
+   [`CHANGELOG.md`](./CHANGELOG.md). Group it under **Added** / **Changed** /
+   **Fixed** / **Removed** / **Deprecated** / **Security**.
+7. Write a descriptive commit message and link any related issue in the PR
+   description. Reviewers may request changes — that is the point of review,
+   not a verdict on your work.
+
+### Commit message style
+
+Conventional-commit prefixes are **recommended but not enforced**:
+
+- `feat:` — a user-visible new capability
+- `fix:` — a bug fix
+- `docs:` — documentation only
+- `test:` — tests only
+- `refactor:` — internal restructuring with no behavior change
+- `chore:` — build, tooling, dependencies
+
+Consistency helps readers skim the log; we will not bounce a PR for
+deviating.
+
+## Adding a new source connector
+
+A source connector is a folder under `dtex/sources/<name>/` (for a baked
+one) or `connectors/sources/<name>/` (in a user project) containing:
+
+1. **`register.yaml`** — the manifest. Declares connector name, capabilities,
+   config keys (with `secret: true` for any sensitive field), and the streams
+   it exposes. See [docs/03 — The Connector Contract](./docs/03-connector-contract.md).
+2. **`source.py`** — the connector body. Generator functions decorated with
+   `@stream` or `@resource` that yield records. See
+   [docs/04 — Connector Body](./docs/04-connector-body.md).
+3. **Tests** under `tests/sources/<name>/` — at minimum, a smoke test that
+   exercises the happy path with a recorded fixture or a mocked HTTP layer.
+   Live-service tests should be gated by an env var and marked with the
+   `integration` pytest marker (see `pyproject.toml`).
+4. **`README.md`** in the connector folder — what it extracts, how to
+   authenticate, any operational notes.
+
+The fastest scaffold is `dtex new source <name>` — it writes a skeletal
+`register.yaml` plus a `source.py` you fill in.
+
+## Adding a new destination connector
+
+Destinations follow the same folder + `register.yaml` + decorator shape, but
+they accept records instead of yielding them. The folder lives under
+`dtex/destinations/<name>/`, and the body uses `@destination`-hooked
+functions. The destination contract — capabilities, the state-table shape,
+the transactional-load expectation, schema evolution — is in
+[docs/05 — Destinations and State](./docs/05-destinations-and-state.md).
+
+Scaffold: `dtex new destination <name>`.
+
+## Adding a new secret-manager resolver
+
+A secret-manager resolver is any object whose class declares
+`scheme: ClassVar[str]` and implements `resolve(path, field) -> str`. It is
+distributed either as a third-party package via the
+`dtex.secret_resolvers` entry-point, or as a project-local
+`dtex_plugins.py`. The protocol, registration mechanics, and the URL form
+(`secret://<scheme>/<path>[#<field>]`) are in
+[docs/08 §3 — Secret references and pluggable secret managers](./docs/08-security.md).
+
+## Releases
+
+See [`docs/_internal/release.md`](./docs/_internal/release.md) for the
+maintainer's release runbook.
+
+## Issue templates
+
+Use the templates under
+[`.github/ISSUE_TEMPLATE/`](./.github/ISSUE_TEMPLATE) to file a bug
+report, feature request, or connector request. Security issues go through
+the private channel described in [`SECURITY.md`](./SECURITY.md), **not**
+the issue tracker.
+
+## License and contribution sign-off
+
+By submitting a pull request you agree that your contribution is licensed
+under the [Apache License 2.0](./LICENSE), the same license as the rest of
+the project.
+
+A Developer Certificate of Origin sign-off (`git commit -s`) is
+**recommended** in v0.1 and will become **required** for v1.0. Adopting it
+now is the lowest-friction way to ramp up.

dtex-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Albinas Plesnys
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dtex-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: dtex
+Version: 0.1.0
+Summary: dtex (data extraction tool) — an open-source Python EL tool: pipelines as configs, connectors as folders, CLI-first.
+Project-URL: Homepage, https://github.com/vej-ai/dtex
+Project-URL: Documentation, https://github.com/vej-ai/dtex/tree/main/docs
+Project-URL: Source, https://github.com/vej-ai/dtex
+Project-URL: Bug Tracker, https://github.com/vej-ai/dtex/issues
+Project-URL: Changelog, https://github.com/vej-ai/dtex/blob/main/CHANGELOG.md
+Author: Albinas Plesnys
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: connectors,data-engineering,dbt,el,elt,extract-load
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: click
+Requires-Dist: duckdb
+Requires-Dist: google-cloud-bigquery>=3.20
+Requires-Dist: google-cloud-storage>=2.10
+Requires-Dist: psycopg[binary]>=3.1
+Requires-Dist: pyarrow>=15
+Requires-Dist: pyyaml
+Requires-Dist: requests>=2.31
+Provides-Extra: aws-secrets
+Requires-Dist: boto3>=1.28; extra == 'aws-secrets'
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Provides-Extra: gcp-secrets
+Requires-Dist: google-cloud-secret-manager>=2.20; extra == 'gcp-secrets'
+Provides-Extra: gcs
+Requires-Dist: google-cloud-storage>=2.10; extra == 'gcs'
+Provides-Extra: s3
+Requires-Dist: boto3>=1.28; extra == 's3'
+Provides-Extra: vault
+Requires-Dist: hvac>=2.0; extra == 'vault'
+Description-Content-Type: text/markdown
+
+# dtex
+
+[![PyPI version](https://img.shields.io/pypi/v/dtex.svg)](https://pypi.org/project/dtex/)
+[![Python versions](https://img.shields.io/pypi/pyversions/dtex.svg)](https://pypi.org/project/dtex/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![CI](https://github.com/vej-ai/dtex/actions/workflows/ci.yml/badge.svg)](https://github.com/vej-ai/dtex/actions/workflows/ci.yml)
+
+**dtex** ("data extraction tool") is an open-source, self-hosted Python
+**extract-load (EL)** tool. It moves data from a **source** (an API, a
+database, a file drop) into a **destination** (a warehouse, a database, an
+object store) — and nothing more. Transformation is dbt's job.
+
+The pitch in one line: **a CLI-first, dbt-shaped extract-load tool —
+pipelines are configs, connectors are folders, no UI blackbox.** The #1
+principle is to keep it as simple as possible.
+
+## Install
+
+```sh
+pip install dtex                          # every baked connector, ready
+pip install 'dtex[gcs,s3]'                # add gs:// / s3:// filesystem reads
+pip install 'dtex[gcp-secrets]'           # add the GCP Secret Manager resolver
+pip install 'dtex[aws-secrets]'           # add the AWS Secrets Manager resolver
+pip install 'dtex[vault]'                 # add the HashiCorp Vault resolver
+```
+
+`pip install dtex` ships every baked source and destination — DuckDB,
+BigQuery, the filesystem source's local + Parquet path, the REST / Postgres
+/ ShipHero / Stripe sources, the engine, the CLI. Extras stay opt-in for the
+cloud-storage paths of the filesystem source (`gs://` / `s3://`) and for
+secret managers (only relevant if your `profiles.yml` uses `secret://` URLs).
+
+dtex requires Python 3.11+. It installs both a CLI (`dtex`) and an importable
+library (`import dtex`).
+
+## Usage
+
+```sh
+dtex init my_project                      # scaffold a project
+cd my_project
+dtex new source my_api                    # scaffold a source connector
+dtex new config my_pipeline               # scaffold a pipeline config
+dtex validate                             # check everything
+dtex run -p my_pipeline                   # run the pipeline
+dtex runs list -p my_pipeline             # show recent run history
+```
+
+A *pipeline* is one config file binding a source + a destination + a target +
+params. Run it with `dtex run -p <config>`. The library equivalent is
+`dtex.run(config="my_pipeline")` and returns a structured `RunResult`.
+
+## Pre-baked connectors
+
+**Sources:** `filesystem` (CSV/JSONL/Parquet from local, GCS, or S3),
+`rest` (paginated REST APIs — 4 pagination strategies, 4 auth modes),
+`postgres` (keyset pagination, no `OFFSET`), `shiphero` (GraphQL),
+`stripe` (resource-as-stream over the REST API).
+
+**Destinations:** `duckdb` (zero-config dev default, all 5 capabilities) and
+`bigquery` (production warehouse — Parquet-staged via GCS + LOAD jobs,
+MERGE upserts, cursor-based partitioning).
+
+**Engine:** per-stream commit + atomic transactions (rollback on failure),
+state in the destination's `_dtex_state` table, run records in `_dtex_runs`,
+structured JSON-lines logs per run, secret redaction, schema evolution
+(`evolve` default, `strict` opt-in), pipeline-level parallelism with
+per-destination caps.
+
+**Secret managers:** GCP Secret Manager, AWS Secrets Manager, HashiCorp
+Vault — each as an opt-in extra.
+
+## Documentation
+
+The full design handbook lives in [`docs/`](./docs/README.md). Start with
+[00 — Vision & Naming](./docs/00-vision-and-naming.md),
+[02 — Architecture](./docs/02-architecture.md),
+[06 — Project Anatomy](./docs/06-project-anatomy.md),
+[12 — Configs](./docs/12-configs.md), and
+[10 — Roadmap and Scope](./docs/10-roadmap-and-scope.md).
+
+## Security · Contributing · Code of Conduct
+
+- [Security policy](./SECURITY.md) — how to report a vulnerability.
+- [Contributing](./CONTRIBUTING.md) — dev setup, PR process, how to add a connector.
+- [Code of Conduct](./CODE_OF_CONDUCT.md).
+- [Changelog](./CHANGELOG.md).
+
+## License
+
+Apache License 2.0 — see [LICENSE](./LICENSE).

dtex-0.1.0/README.md

@@ -0,0 +1,90 @@
+# dtex
+
+[![PyPI version](https://img.shields.io/pypi/v/dtex.svg)](https://pypi.org/project/dtex/)
+[![Python versions](https://img.shields.io/pypi/pyversions/dtex.svg)](https://pypi.org/project/dtex/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![CI](https://github.com/vej-ai/dtex/actions/workflows/ci.yml/badge.svg)](https://github.com/vej-ai/dtex/actions/workflows/ci.yml)
+
+**dtex** ("data extraction tool") is an open-source, self-hosted Python
+**extract-load (EL)** tool. It moves data from a **source** (an API, a
+database, a file drop) into a **destination** (a warehouse, a database, an
+object store) — and nothing more. Transformation is dbt's job.
+
+The pitch in one line: **a CLI-first, dbt-shaped extract-load tool —
+pipelines are configs, connectors are folders, no UI blackbox.** The #1
+principle is to keep it as simple as possible.
+
+## Install
+
+```sh
+pip install dtex                          # every baked connector, ready
+pip install 'dtex[gcs,s3]'                # add gs:// / s3:// filesystem reads
+pip install 'dtex[gcp-secrets]'           # add the GCP Secret Manager resolver
+pip install 'dtex[aws-secrets]'           # add the AWS Secrets Manager resolver
+pip install 'dtex[vault]'                 # add the HashiCorp Vault resolver
+```
+
+`pip install dtex` ships every baked source and destination — DuckDB,
+BigQuery, the filesystem source's local + Parquet path, the REST / Postgres
+/ ShipHero / Stripe sources, the engine, the CLI. Extras stay opt-in for the
+cloud-storage paths of the filesystem source (`gs://` / `s3://`) and for
+secret managers (only relevant if your `profiles.yml` uses `secret://` URLs).
+
+dtex requires Python 3.11+. It installs both a CLI (`dtex`) and an importable
+library (`import dtex`).
+
+## Usage
+
+```sh
+dtex init my_project                      # scaffold a project
+cd my_project
+dtex new source my_api                    # scaffold a source connector
+dtex new config my_pipeline               # scaffold a pipeline config
+dtex validate                             # check everything
+dtex run -p my_pipeline                   # run the pipeline
+dtex runs list -p my_pipeline             # show recent run history
+```
+
+A *pipeline* is one config file binding a source + a destination + a target +
+params. Run it with `dtex run -p <config>`. The library equivalent is
+`dtex.run(config="my_pipeline")` and returns a structured `RunResult`.
+
+## Pre-baked connectors
+
+**Sources:** `filesystem` (CSV/JSONL/Parquet from local, GCS, or S3),
+`rest` (paginated REST APIs — 4 pagination strategies, 4 auth modes),
+`postgres` (keyset pagination, no `OFFSET`), `shiphero` (GraphQL),
+`stripe` (resource-as-stream over the REST API).
+
+**Destinations:** `duckdb` (zero-config dev default, all 5 capabilities) and
+`bigquery` (production warehouse — Parquet-staged via GCS + LOAD jobs,
+MERGE upserts, cursor-based partitioning).
+
+**Engine:** per-stream commit + atomic transactions (rollback on failure),
+state in the destination's `_dtex_state` table, run records in `_dtex_runs`,
+structured JSON-lines logs per run, secret redaction, schema evolution
+(`evolve` default, `strict` opt-in), pipeline-level parallelism with
+per-destination caps.
+
+**Secret managers:** GCP Secret Manager, AWS Secrets Manager, HashiCorp
+Vault — each as an opt-in extra.
+
+## Documentation
+
+The full design handbook lives in [`docs/`](./docs/README.md). Start with
+[00 — Vision & Naming](./docs/00-vision-and-naming.md),
+[02 — Architecture](./docs/02-architecture.md),
+[06 — Project Anatomy](./docs/06-project-anatomy.md),
+[12 — Configs](./docs/12-configs.md), and
+[10 — Roadmap and Scope](./docs/10-roadmap-and-scope.md).
+
+## Security · Contributing · Code of Conduct
+
+- [Security policy](./SECURITY.md) — how to report a vulnerability.
+- [Contributing](./CONTRIBUTING.md) — dev setup, PR process, how to add a connector.
+- [Code of Conduct](./CODE_OF_CONDUCT.md).
+- [Changelog](./CHANGELOG.md).
+
+## License
+
+Apache License 2.0 — see [LICENSE](./LICENSE).