dtcs 0.12.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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

# MkDocs configuration for Read the Docs and local preview.
# Build: pip install -r docs/requirements.txt && NO_MKDOCS_2_WARNING=true mkdocs serve
site_name: DTCS
site_description: Data Transformation Contract Standard — vendor-neutral contracts for transformation semantics
site_url: https://dtcs.readthedocs.io
repo_url: https://github.com/eddiethedean/dtcs
repo_name: eddiethedean/dtcs
edit_uri: edit/main/docs/
copyright: Copyright © DTCS contributors — Apache-2.0
docs_dir: docs
site_dir: site
strict: true

# index.md is a symlink to docs/README.md; exclude only that hub duplicate.
exclude_docs: |
  /README.md
  DTCS_PORTABLE_SPEC_PROPOSAL.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
    - toc.follow

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/eddiethedean/dtcs
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/dtcs/
    - icon: fontawesome/brands/rust
      link: https://crates.io/crates/dtcs

validation:
  omitted_files: warn
  absolute_links: relative_to_docs
  unrecognized_links: warn
  anchors: warn

nav:
  - Home: index.md
  - Getting started: user/getting-started.md
  - Tutorials:
      - Concepts: user/concepts.md
      - Writing contracts: user/writing-contracts.md
      - Cookbook: user/cookbook.md
  - Guides:
      - Versioning: user/versioning.md
      - CLI guide: user/cli-guide.md
      - Expressions: user/expressions.md
      - Compatibility: user/compatibility.md
      - JSON output: user/json-output.md
      - CI integration: user/ci-integration.md
      - Conformance: user/conformance.md
      - Error taxonomy: user/error-taxonomy.md
      - Diagnostic catalog: user/diagnostic-catalog.md
      - Extensions & registries: user/extensions-and-registries.md
      - Migration 0.12: user/migration-0.12.md
      - Portable Relational migration: user/migration-portable-relational.md
      - Migration 0.11 (historical): user/migration-0.11.md
      - Limits & deployment: user/limits.md
      - Troubleshooting: user/troubleshooting.md
      - FAQ: user/faq.md
      - Glossary: user/glossary.md
  - Adoption:
      - Overview: adoption/overview.md
      - Security checklist: adoption/security-checklist.md
  - API:
      - Python: api/python.md
      - Rust: api/rust.md
      - WASM: api/wasm.md
      - Node: api/node.md
  - Specification:
      - SPEC.md: SPEC.md
      - Spec completeness: implementation/spec-completeness.md
      - Portable conformance: implementation/portable-conformance.md
      - Changelog: https://github.com/eddiethedean/dtcs/blob/main/CHANGELOG.md
      - Roadmap: https://github.com/eddiethedean/dtcs/blob/main/ROADMAP.md
  - Contribute:
      - Contributing: https://github.com/eddiethedean/dtcs/blob/main/CONTRIBUTING.md
      - Architecture: implementation/architecture.md
      - Reference implementers:
          - Overview: implementation/README.md
          - Project goal: implementation/project-goal.md
          - Crate layout: implementation/crate-layout.md
          - Model guide: implementation/model-guide.md
          - Validation guide: implementation/validation-guide.md
          - Diagnostics guide: implementation/diagnostics-guide.md
          - Public API notes: implementation/public-api.md
          - CLI spec: implementation/cli-spec.md
          - Testing plan: implementation/testing-plan.md
          - Release runbook: implementation/release-runbook.md
          - Rust dependencies: implementation/rust-dependencies.md
          - Spec usage: implementation/spec-usage.md
          - Non-goals: implementation/non-goals.md
          - Test verification: implementation/test-verification-report.md
          - Implementation phases: implementation/implementation-phases.md
      - Editorial:
          - Baseline: editorial/baseline.md
          - Style guide: editorial/style-guide.md
          - Authoring guide: editorial/authoring-guide.md
          - Review checklist: editorial/review-checklist.md