Skip to content

Commit c4278f5

Browse files
committed
Add deprecation notice for Data Contract Specification and migration guide to ODCS
1 parent 3e5d194 commit c4278f5

1 file changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
<img alt="Stars" src="https://img.shields.io/github/stars/datacontract/datacontract-specification" /></a>
55
<a href="https://datacontract.com/slack" rel="nofollow"><img src="https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&amp;style=social" alt="Slack Status" data-canonical-src="https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&amp;style=social" style="max-width: 100%;"></a>
66

7+
8+
> **Deprecation Notice**
9+
> With the release of the [Open Data Contract Standard v3.1.0](https://github.com/bitol-io/open-data-contract-standard), we deprecate the Data Contract Specification in line with our commitment to focus on a single industry standard for data contracts. We have actively contributed to the Open Data Contract Standard in the TSC and will continue to support it.<br><br>
10+
> If you are using Data Contract Specification, we recommend [migrating to the Open Data Contract Standard](#migration) within the next few months.
11+
712
![datacontract.png](images/datacontract.png)
813

914
Data contracts bring data providers and data consumers together.
@@ -265,12 +270,27 @@ links:
265270
datacontractCli: https://cli.datacontract.com
266271
```
267272
273+
Migration
274+
---
275+
276+
To migrate from Data Contract Specification to the Open Data Contract Specification, you can use the [Data Contract CLI](https://github.com/datacontract/datacontract-cli):
277+
278+
```
279+
uv tool install --python python3.11 --upgrade 'datacontract-cli[all]'
280+
datacontract export --format odcs --output odcs.yaml datacontract.yaml
281+
```
282+
283+
You can now continue to work with _odcs.yaml_ file.
284+
285+
286+
287+
268288
Data Contract CLI
269289
---
270290

271-
The [Data Contract CLI](https://cli.datacontract.com) is a command line tool and Python library to lint, test, import and export data contracts.
291+
The [Data Contract CLI](https://cli.datacontract.com) is a command line tool and Python library to lint, test, import and export data contracts (supporting Data Contract Specification and ODCS).
272292

273-
Here is short example how to verify that your actual dataset matches the data contract:
293+
Here is a short example of how to verify that your actual dataset matches the data contract:
274294

275295
```bash
276296
pip3 install "datacontract-cli[all]"
@@ -293,6 +313,7 @@ The Data Contract CLI chooses the appropriate engine, formulates test cases, con
293313
More information and configuration options on [cli.datacontract.com](https://cli.datacontract.com).
294314

295315

316+
296317
Specification
297318
---
298319

0 commit comments

Comments
 (0)