dtcs 0.11.0

Reference implementation of the Data Transformation Contract Standard (DTCS)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# DTCS — Data Transformation Contract Standard

[![CI](https://github.com/eddiethedean/dtcs/actions/workflows/ci.yml/badge.svg)](https://github.com/eddiethedean/dtcs/actions/workflows/ci.yml)
[![Documentation Status](https://readthedocs.org/projects/dtcs/badge/?version=latest)](https://dtcs.readthedocs.io/en/latest/)
[![crates.io](https://img.shields.io/crates/v/dtcs)](https://crates.io/crates/dtcs)
[![PyPI](https://img.shields.io/pypi/v/dtcs)](https://pypi.org/project/dtcs/)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)

DTCS is a **draft** standard and toolkit for writing **vendor-neutral data transformation contracts** in YAML/JSON — the *semantics* of transforms, not a Spark, Polars, or SQL engine.

**Status:** Spec `1.0.0-draft` · Tools `0.11.0` (alpha). Good for validation, compatibility analysis, and conformance research — **not** a production ETL runtime.

[Documentation](https://dtcs.readthedocs.io/) · [Getting started](docs/user/getting-started.md) · [Adoption](docs/adoption/overview.md) · [Examples](examples/) · [Changelog](CHANGELOG.md) · [Security](SECURITY.md)

## Try it (no clone)

**Requirements:** Python 3.9+ for PyPI wheels, or Rust 1.75+ for `cargo install` (compile can take several minutes).

```bash
pip install dtcs
dtcs version
# → dtcs 0.11.0
# → spec 1.0.0-draft

curl -fsSL https://raw.githubusercontent.com/eddiethedean/dtcs/main/examples/minimal.dtcs.yaml \
  -o contract.dtcs.yaml
dtcs validate contract.dtcs.yaml
# → valid
# → exit 0
```

Or paste the same file from [`examples/minimal.dtcs.yaml`](examples/minimal.dtcs.yaml). Contracts must set `dtcsVersion: "1.0.0"` exactly (the Spec itself is still `1.0.0-draft`).

**Bindings:** Python (`pip install dtcs`), WASM (`@eddiethedean/dtcs-wasm`), Node (`@eddiethedean/dtcs`). See [docs/api/](docs/api/).

## What this repository contains

- **[SPEC.md](SPEC.md)** — normative DTCS 1.0 draft (26 chapters + Appendix A)
- **Reference tools** — parse, validate, analyze, plan, optimize, match, compile, and run contracts (Rust CLI + Python; limited WASM/Node surface)

| | |
|---|---|
| **Spec status** | Draft (`1.0.0-draft`) |
| **Reference tools** | `0.11.0` (alpha) — validator through reference runtime and conformance |
| **Document `dtcsVersion`** | Must be exactly `1.0.0` today (patch versions are rejected) |

Coverage tables labeled “Covered” or “Complete” mean the **reference implementation exercises that draft SPEC area**, not that DTCS 1.0 is finalized or production-certified.

## Next steps (after `valid`)

Clone for richer examples and fixtures (PyPI wheels do **not** include `examples/` or `tests/`):

```bash
git clone https://github.com/eddiethedean/dtcs.git
cd dtcs
dtcs validate examples/customer_pipeline.dtcs.yaml
dtcs run examples/customer_pipeline.dtcs.yaml \
  --input tests/fixtures/runtime/customer_pipeline_input.json
```

| Goal | Where |
|------|--------|
| Concepts in two pages | [docs/user/concepts.md](docs/user/concepts.md) |
| Write contracts | [docs/user/writing-contracts.md](docs/user/writing-contracts.md) |
| CLI reference | [docs/user/cli-guide.md](docs/user/cli-guide.md) |
| Upgrade from 0.10.x | [docs/user/migration-0.11.md](docs/user/migration-0.11.md) |
| Evaluate for your org | [docs/adoption/overview.md](docs/adoption/overview.md) |

## Develop from source

Requires Rust + [maturin](https://www.maturin.rs/). See [CONTRIBUTING.md](CONTRIBUTING.md#contributor-quickstart).

## Repository layout

| Path | Purpose |
|------|---------|
| [SPEC.md](SPEC.md) | Full DTCS 1.0 draft specification |
| [docs/user/](docs/user/) | User guides |
| [docs/adoption/](docs/adoption/) | Evaluator / security materials |
| [docs/api/](docs/api/) | Python, Rust, WASM, Node API docs |
| [docs/implementation/](docs/implementation/) | Reference implementation design guides |
| [examples/](examples/) | Sample contracts |
| [src/](src/) | Rust crate (`dtcs`) |
| [python/](python/) | Python package |
| [ROADMAP.md](ROADMAP.md) | Implementation milestones |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). Security reports: [SECURITY.md](SECURITY.md). When guidance conflicts with the specification, **SPEC.md wins**.

## License

Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE).