datacontract-cli 0.11.7__tar.gz → 0.11.8__tar.gz

{datacontract_cli-0.11.7/datacontract_cli.egg-info → datacontract_cli-0.11.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datacontract-cli
-Version: 0.11.7
+Version: 0.11.8
 Summary: The datacontract CLI is an open source command-line tool for working with Data Contracts. It uses data contract YAML files to lint the data contract, connect to data sources and execute schema and quality tests, detect breaking changes, and export to different formats. The tool is written in Python. It can be used as a standalone CLI tool, in a CI/CD pipeline, or directly as a Python library.
 Author-email: Jochen Christ <jochen.christ@innoq.com>, Stefan Negele <stefan.negele@innoq.com>, Simon Harrer <simon.harrer@innoq.com>
 License-Expression: MIT
@@ -14,12 +14,13 @@ License-File: LICENSE
 Requires-Dist: typer<0.25,>=0.18.0
 Requires-Dist: pydantic<2.13.0,>=2.8.2
 Requires-Dist: pyyaml~=6.0.1
-Requires-Dist: requests<2.33,>=2.31
+Requires-Dist: requests<2.34,>=2.31
 Requires-Dist: fastjsonschema<2.22.0,>=2.19.1
+Requires-Dist: jsonschema<5.0.0,>=4.23.0
 Requires-Dist: pytz>=2024.1
 Requires-Dist: python-multipart<1.0.0,>=0.0.20
 Requires-Dist: rich<15.0,>=13.7
-Requires-Dist: sqlglot<29.0.0,>=26.6.0
+Requires-Dist: sqlglot<31.0.0,>=26.6.0
 Requires-Dist: setuptools>=60
 Requires-Dist: python-dotenv<2.0.0,>=1.0.0
 Requires-Dist: boto3<2.0.0,>=1.34.41
@@ -27,6 +28,7 @@ Requires-Dist: Jinja2<4.0.0,>=3.1.5
 Requires-Dist: jinja_partials<1.0.0,>=0.2.1
 Requires-Dist: datacontract-specification<2.0.0,>=1.2.3
 Requires-Dist: open-data-contract-standard<4.0.0,>=3.1.2
+Requires-Dist: deepdiff<9.0.0,>=6.0.0
 Provides-Extra: avro
 Requires-Dist: avro==1.12.1; extra == "avro"
 Provides-Extra: bigquery
@@ -39,16 +41,14 @@ Provides-Extra: databricks
 Requires-Dist: soda-core-spark-df<3.6.0,>=3.3.20; extra == "databricks"
 Requires-Dist: soda-core-spark[databricks]<3.6.0,>=3.3.20; extra == "databricks"
 Requires-Dist: databricks-sql-connector<4.3.0,>=3.7.0; extra == "databricks"
-Requires-Dist: databricks-sdk<0.86.0; extra == "databricks"
+Requires-Dist: databricks-sdk<0.103.0; extra == "databricks"
 Requires-Dist: pyspark<5.0.0,>=3.5.0; extra == "databricks"
-Requires-Dist: numpy<2.0.0,>=1.26.4; extra == "databricks"
 Provides-Extra: iceberg
-Requires-Dist: pyiceberg==0.11.0; extra == "iceberg"
+Requires-Dist: pyiceberg==0.11.1; extra == "iceberg"
 Provides-Extra: kafka
 Requires-Dist: datacontract-cli[avro]; extra == "kafka"
 Requires-Dist: soda-core-spark-df<3.6.0,>=3.3.20; extra == "kafka"
 Requires-Dist: pyspark<5.0.0,>=3.5.0; extra == "kafka"
-Requires-Dist: numpy<2.0.0,>=1.26.4; extra == "kafka"
 Provides-Extra: mysql
 Requires-Dist: soda-core-mysql<3.6.0,>=3.3.20; extra == "mysql"
 Requires-Dist: mysql-connector-python<10.0.0,>=8.0.30; extra == "mysql"
@@ -56,7 +56,7 @@ Provides-Extra: postgres
 Requires-Dist: soda-core-postgres<3.6.0,>=3.3.20; extra == "postgres"
 Provides-Extra: s3
 Requires-Dist: s3fs<2027.0.0,>=2025.2.0; extra == "s3"
-Requires-Dist: aiobotocore<3.2.0,>=2.17.0; extra == "s3"
+Requires-Dist: aiobotocore<3.4.0,>=2.17.0; extra == "s3"
 Provides-Extra: snowflake
 Requires-Dist: snowflake-connector-python[pandas]<4.4,>=3.6; extra == "snowflake"
 Requires-Dist: soda-core-snowflake<3.6.0,>=3.3.20; extra == "snowflake"
@@ -73,15 +73,15 @@ Requires-Dist: dbt-core>=1.8.0; extra == "dbt"
 Provides-Extra: dbml
 Requires-Dist: pydbml>=1.1.1; extra == "dbml"
 Provides-Extra: duckdb
-Requires-Dist: duckdb<1.5.0,>=1.0.0; extra == "duckdb"
+Requires-Dist: duckdb<1.6.0,>=1.0.0; extra == "duckdb"
 Requires-Dist: soda-core-duckdb<3.6.0,>=3.3.20; extra == "duckdb"
 Provides-Extra: parquet
 Requires-Dist: pyarrow>=18.1.0; extra == "parquet"
 Provides-Extra: rdf
 Requires-Dist: rdflib==7.6.0; extra == "rdf"
 Provides-Extra: api
-Requires-Dist: fastapi==0.129.0; extra == "api"
-Requires-Dist: uvicorn==0.40.0; extra == "api"
+Requires-Dist: fastapi==0.135.3; extra == "api"
+Requires-Dist: uvicorn==0.44.0; extra == "api"
 Provides-Extra: protobuf
 Requires-Dist: grpcio-tools>=1.53; extra == "protobuf"
 Provides-Extra: all
@@ -97,9 +97,9 @@ Requires-Dist: pre-commit<4.6.0,>=3.7.1; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-xdist; extra == "dev"
 Requires-Dist: pymssql==2.3.13; extra == "dev"
-Requires-Dist: ruff==0.15.2; extra == "dev"
+Requires-Dist: ruff==0.15.7; extra == "dev"
 Requires-Dist: testcontainers[kafka,minio,mssql,mysql,postgres]==4.14.1; extra == "dev"
-Requires-Dist: trino==0.336.0; extra == "dev"
+Requires-Dist: trino==0.337.0; extra == "dev"
 Dynamic: license-file
 
 # Data Contract CLI
@@ -107,6 +107,8 @@ Dynamic: license-file
 <p>
   <a href="https://github.com/datacontract/datacontract-cli/actions/workflows/ci.yaml?query=branch%3Amain">
     <img alt="Test Workflow" src="https://img.shields.io/github/actions/workflow/status/datacontract/datacontract-cli/ci.yaml?branch=main"></a>
+  <a href="https://pypi.org/project/datacontract-cli/">
+    <img alt="PyPI Version" src="https://img.shields.io/pypi/v/datacontract-cli" /></a>
   <a href="https://github.com/datacontract/datacontract-cli">
     <img alt="Stars" src="https://img.shields.io/github/stars/datacontract/datacontract-cli" /></a>
   <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>
@@ -119,6 +121,7 @@ It can be used as a standalone CLI tool, in a CI/CD pipeline, or directly as a P
 
 ![Main features of the Data Contract CLI](datacontractcli.png)
 
+> **Quick navigation:** [Documentation](#documentation) · [Best Practices](#best-practices) · [Custom Export and Import](#customizing-exporters-and-importers) · [Development Setup](#development-setup)
 
 ## Getting started
 
@@ -218,9 +221,12 @@ $ datacontract export --format html --output orders-v1.odcs.html https://datacon
 # create a new data contract from example and write it to odcs.yaml
 $ datacontract init odcs.yaml
 
-# lint the odcs.yaml
+# lint the odcs.yaml and stop after the first validation error (default).
 $ datacontract lint odcs.yaml
 
+# show a changelog between two data contracts
+$ datacontract changelog v1.odcs.yaml v2.odcs.yaml
+
 # execute schema and quality checks (define credentials as environment variables)
 $ datacontract test odcs.yaml
 
@@ -364,7 +370,9 @@ Commands
 
 - [init](#init)
 - [lint](#lint)
+- [changelog](#changelog)
 - [test](#test)
+- [ci](#ci)
 - [export](#export)
 - [import](#import)
 - [catalog](#catalog)
@@ -394,37 +402,64 @@ Commands
 ```
 
 ### lint
+```
+                                                                                
+ Usage: datacontract lint [OPTIONS] [LOCATION]                                  
+                                                                                
+ Validate that the datacontract.yaml is correctly formatted.                    
+                                                                                
+╭─ Arguments ──────────────────────────────────────────────────────────────────╮
+│   location      [LOCATION]  The location (url or path) of the data contract  │
+│                             yaml.                                            │
+│                             [default: datacontract.yaml]                     │
+╰──────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ────────────────────────────────────────────────────────────────────╮
+│ --schema                         TEXT          The location (url or path) of │
+│                                                the ODCS JSON Schema          │
+│ --output                         PATH          Specify the file path where   │
+│                                                the test results should be    │
+│                                                written to (e.g.,             │
+│                                                './test-results/TEST-datacon… │
+│                                                If no path is provided, the   │
+│                                                output will be printed to     │
+│                                                stdout.                       │
+│ --output-format                  [json|junit]  The target format for the     │
+│                                                test results.                 │
+│ --all-errors                                   Report all JSON Schema        │
+│                                                validation errors instead of  │
+│                                                stopping after the first one. │
+│ --debug            --no-debug                  Enable debug logging          │
+│ --help                                         Show this message and exit.   │
+╰──────────────────────────────────────────────────────────────────────────────╯
+
+```
+
+### changelog
 ```
                                                                                                     
- Usage: datacontract lint [OPTIONS] [LOCATION]                                                      
-                                                                                                    
- Validate that the datacontract.yaml is correctly formatted.                                        
+ Usage: datacontract changelog [OPTIONS] V1 V2                                                      
                                                                                                     
+ Show a changelog between two data contracts.                                                       
                                                                                                     
 ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮
-│   location      [LOCATION]  The location (url or path) of the data contract yaml.                │
-│                             [default: datacontract.yaml]                                         │
+│ *    v1      TEXT  The location (path) of the source (before) data contract YAML. [required]     │
+│ *    v2      TEXT  The location (path) of the target (after) data contract YAML. [required]      │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
 ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
-│ --schema                         TEXT     The location (url or path) of the ODCS JSON Schema     │
-│                                           [default: None]                                        │
-│ --output                         PATH     Specify the file path where the test results should be │
-│                                           written to (e.g.,                                      │
-│                                           './test-results/TEST-datacontract.xml'). If no path is │
-│                                           provided, the output will be printed to stdout.        │
-│                                           [default: None]                                        │
-│ --output-format                  [junit]  The target format for the test results.                │
-│                                           [default: None]                                        │
-│ --debug            --no-debug             Enable debug logging [default: no-debug]               │
-│ --help                                    Show this message and exit.                            │
+│ --debug     --no-debug                 Enable debug logging                                      │
+│ --help                                 Show this message and exit.                               │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
 
 ```
 
+```bash
+$ datacontract changelog v1.odcs.yaml v2.odcs.yaml
+```
+
 ### test
 ```
                                                                                                     
- Usage: datacontract test [OPTIONS] [LOCATION]                                                      
+ Usage: datacontract test [OPTIONS] [LOCATION]
                                                                                                     
  Run schema and quality tests on configured servers.                                                
                                                                                                     
@@ -478,45 +513,20 @@ Data Contract CLI connects to a data source and runs schema and quality tests to
 $ datacontract test --server production datacontract.yaml
 ```
 
-To connect to the databases the `server` block in the datacontract.yaml is used to set up the connection.
-In addition, credentials, such as username and passwords, may be defined with environment variables.
+For CI/CD pipelines, see [`ci`](#ci).
 
 The application uses different engines, based on the server `type`.
 Internally, it connects with DuckDB, Spark, or a native connection and executes the most tests with _soda-core_ and _fastjsonschema_.
 
-Credentials are provided with environment variables.
-
-Supported server types:
-
-- [s3](#S3)
-- [athena](#athena)
-- [bigquery](#bigquery)
-- [azure](#azure)
-- [sqlserver](#sqlserver)
-- [oracle](#oracle)
-- [databricks](#databricks)
-- [databricks (programmatic)](#databricks-programmatic)
-- [dataframe (programmatic)](#dataframe-programmatic)
-- [snowflake](#snowflake)
-- [kafka](#kafka)
-- [postgres](#postgres)
-- [mysql](#mysql)
-- [trino](#trino)
-- [impala](#impala)
-- [api](#api)
-- [local](#local)
-
-Supported formats:
+#### Supported Data Sources
 
-- parquet
-- json
-- csv
-- delta
-- iceberg (coming soon)
+The `server` block in the datacontract.yaml is used to set up the connection.
+In addition, credentials, such as username and passwords, are provided with environment variables.
 
-Feel free to create an [issue](https://github.com/datacontract/datacontract-cli/issues), if you need support for an additional type and formats.
+Feel free to create an [issue](https://github.com/datacontract/datacontract-cli/issues), if you need support for additional types and formats.
 
-#### S3
+<details markdown="1">
+<summary><strong>S3</strong></summary>
 
 Data Contract CLI can test data that is stored in S3 buckets or any S3-compliant endpoints in various formats.
 
@@ -562,8 +572,10 @@ servers:
 | `DATACONTRACT_S3_SECRET_ACCESS_KEY` | `93S7LRrJcqLaaaa/XXXXXXXXXXXXX` | AWS Secret Access Key                  |
 | `DATACONTRACT_S3_SESSION_TOKEN`     | `AQoDYXdzEJr...`                | AWS temporary session token (optional) |
 
+</details>
 
-#### Athena
+<details markdown="1">
+<summary><strong>Athena</strong></summary>
 
 Data Contract CLI can test data in AWS Athena stored in S3.
 Supports different file formats, such as Iceberg, Parquet, JSON, CSV...
@@ -598,8 +610,10 @@ models:
 | `DATACONTRACT_S3_SECRET_ACCESS_KEY` | `93S7LRrJcqLaaaa/XXXXXXXXXXXXX` | AWS Secret Access Key                  |
 | `DATACONTRACT_S3_SESSION_TOKEN`     | `AQoDYXdzEJr...`                | AWS temporary session token (optional) |
 
+</details>
 
-#### Google Cloud Storage (GCS)
+<details markdown="1">
+<summary><strong>Google Cloud Storage (GCS)</strong></summary>
 
 The [S3](#S3) integration also works with files on Google Cloud Storage through its [interoperability](https://cloud.google.com/storage/docs/interoperability).
 Use `https://storage.googleapis.com` as the endpoint URL.
@@ -624,8 +638,10 @@ servers:
 | `DATACONTRACT_S3_ACCESS_KEY_ID`     | `GOOG1EZZZ...` | The GCS [HMAC Key](https://cloud.google.com/storage/docs/authentication/hmackeys) Key ID |
 | `DATACONTRACT_S3_SECRET_ACCESS_KEY` | `PDWWpb...`    | The GCS [HMAC Key](https://cloud.google.com/storage/docs/authentication/hmackeys) Secret |
 
+</details>
 
-#### BigQuery
+<details markdown="1">
+<summary><strong>BigQuery</strong></summary>
 
 We support authentication to BigQuery using Service Account Key or Application Default Credentials (ADC). ADC supports Workload Identity Federation (WIF), GCE metadata server, and `gcloud auth application-default login`. The used Service Account should include the roles:
 * BigQuery Job User
@@ -655,8 +671,10 @@ models:
 | `DATACONTRACT_BIGQUERY_ACCOUNT_INFO_JSON_PATH` | `~/service-access-key.json` | Service Account key JSON file. If not set, ADC/WIF is used automatically. |
 | `DATACONTRACT_BIGQUERY_IMPERSONATION_ACCOUNT` | `sa@project.iam.gserviceaccount.com` | Optional. Service account to impersonate. Works with both key file and ADC auth. |
 
+</details>
 
-#### Azure
+<details markdown="1">
+<summary><strong>Azure</strong></summary>
 
 Data Contract CLI can test data that is stored in Azure Blob storage or Azure Data Lake Storage (Gen2) (ADLS) in various formats.
 
@@ -681,9 +699,10 @@ Authentication works with an Azure Service Principal (SPN) aka App Registration
 | `DATACONTRACT_AZURE_CLIENT_ID`     | `3cf7ce49-e2e9-4cbc-a922-4328d4a58622` | The ApplicationID / ClientID of the app registration |
 | `DATACONTRACT_AZURE_CLIENT_SECRET` | `yZK8Q~GWO1MMXXXXXXXXXXXXX`            | The Client Secret value                              |
 
+</details>
 
-
-#### Sqlserver
+<details markdown="1">
+<summary><strong>SQL Server</strong></summary>
 
 Data Contract CLI can test data in MS SQL Server (including Azure SQL, Synapse Analytics SQL Pool, and Microsoft Fabric).
 
@@ -721,10 +740,10 @@ models:
 | `DATACONTRACT_SQLSERVER_DRIVER`                   | `ODBC Driver 18 for SQL Server` | ODBC driver name                                                                                                                  |
 | `DATACONTRACT_SQLSERVER_TRUSTED_CONNECTION`       | `True`                          | Deprecated. Equivalent to `AUTHENTICATION=windows`                                                                                |
 
+</details>
 
-
-
-#### Oracle
+<details markdown="1">
+<summary><strong>Oracle</strong></summary>
 
 Data Contract CLI can test data in Oracle Database.
 
@@ -770,10 +789,10 @@ installed on the system and specify the path to the installation within the envi
 | `DATACONTRACT_ORACLE_PASSWORD`                   | `0x162e53`         | Password                                   |
 | `DATACONTRACT_ORACLE_CLIENT_DIR`                 | `C:\oracle\client` | Path to Oracle Instant Client installation |
 
+</details>
 
-
-
-#### Databricks
+<details markdown="1">
+<summary><strong>Databricks</strong></summary>
 
 Works with Unity Catalog and Hive metastore.
 
@@ -802,8 +821,10 @@ models:
 | `DATACONTRACT_DATABRICKS_HTTP_PATH`       | `/sql/1.0/warehouses/b053a3ffffffff` | The HTTP path to the SQL warehouse or compute cluster     |
 | `DATACONTRACT_DATABRICKS_SERVER_HOSTNAME` | `dbc-abcdefgh-1234.cloud.databricks.com` | The host name of the SQL warehouse or compute cluster |
 
+</details>
 
-#### Databricks (programmatic)
+<details markdown="1">
+<summary><strong>Databricks (programmatic)</strong></summary>
 
 Works with Unity Catalog and Hive metastore.
 When running in a notebook or pipeline, the provided `spark` session can be used.
@@ -859,7 +880,10 @@ models:
 
 Databricks' library management properly resolves dependencies during cluster initialization, rather than at runtime in the notebook.
 
-#### Dataframe (programmatic)
+</details>
+
+<details markdown="1">
+<summary><strong>Dataframe (programmatic)</strong></summary>
 
 Works with Spark DataFrames.
 DataFrames need to be created as named temporary views.
@@ -894,8 +918,10 @@ run = data_contract.test()
 assert run.result == "passed"
 ```
 
+</details>
 
-#### Snowflake
+<details markdown="1">
+<summary><strong>Snowflake</strong></summary>
 
 Data Contract CLI can test data in Snowflake.
 
@@ -945,8 +971,10 @@ servers:
     schema: ORDERS_PII_V2
 ```
 
+</details>
 
-#### Kafka
+<details markdown="1">
+<summary><strong>Kafka</strong></summary>
 
 Kafka support is currently considered experimental.
 
@@ -970,8 +998,10 @@ servers:
 | `DATACONTRACT_KAFKA_SASL_PASSWORD`  | `xxx`   | The SASL password (secret).                                                      |
 | `DATACONTRACT_KAFKA_SASL_MECHANISM` | `PLAIN` | Default `PLAIN`. Other supported mechanisms: `SCRAM-SHA-256` and `SCRAM-SHA-512` |
 
+</details>
 
-#### Postgres
+<details markdown="1">
+<summary><strong>Postgres</strong></summary>
 
 Data Contract CLI can test data in Postgres or Postgres-compliant databases (e.g., RisingWave).
 
@@ -1001,8 +1031,10 @@ models:
 | `DATACONTRACT_POSTGRES_USERNAME` | `postgres`         | Username    |
 | `DATACONTRACT_POSTGRES_PASSWORD` | `mysecretpassword` | Password    |
 
+</details>
 
-#### MySQL
+<details markdown="1">
+<summary><strong>MySQL</strong></summary>
 
 Data Contract CLI can test data in MySQL or MySQL-compliant databases (e.g., MariaDB).
 
@@ -1031,8 +1063,10 @@ models:
 | `DATACONTRACT_MYSQL_USERNAME` | `root`             | Username    |
 | `DATACONTRACT_MYSQL_PASSWORD` | `mysecretpassword` | Password    |
 
+</details>
 
-#### Trino
+<details markdown="1">
+<summary><strong>Trino</strong></summary>
 
 Data Contract CLI can test data in Trino.
 
@@ -1066,8 +1100,10 @@ models:
 | `DATACONTRACT_TRINO_USERNAME` | `trino`            | Username    |
 | `DATACONTRACT_TRINO_PASSWORD` | `mysecretpassword` | Password    |
 
+</details>
 
-#### Impala
+<details markdown="1">
+<summary><strong>Impala</strong></summary>
 
 Data Contract CLI can run Soda checks against an Apache Impala cluster.
 
@@ -1114,7 +1150,10 @@ If `physicalType` is not specified in the schema, we recommend the following map
 
 This keeps the Impala schema compatible with the expectations of the Soda checks generated by datacontract-cli.
 
-#### API
+</details>
+
+<details markdown="1">
+<summary><strong>API</strong></summary>
 
 Data Contract CLI can test APIs that return data in JSON format. 
 Currently, only GET requests are supported.
@@ -1145,8 +1184,10 @@ models:
 |-----------------------------------------|------------------|---------------------------------------------------|
 | `DATACONTRACT_API_HEADER_AUTHORIZATION` | `Bearer <token>` | The value for the `authorization` header. Optional. |
 
+</details>
 
-#### Local
+<details markdown="1">
+<summary><strong>Local</strong></summary>
 
 Data Contract CLI can test local files in parquet, json, csv, or delta format.
 
@@ -1169,6 +1210,149 @@ models:
         type: string
 ```
 
+</details>
+
+### ci
+```
+                                                                                
+ Usage: datacontract ci [OPTIONS] [LOCATIONS]...                                
+                                                                                
+ Run tests for CI/CD pipelines. Emits GitHub Actions annotations and step       
+ summary.                                                                       
+                                                                                
+╭─ Arguments ──────────────────────────────────────────────────────────────────╮
+│   locations      [LOCATIONS]...  The location(s) (url or path) of the data   │
+│                                  contract yaml file(s).                      │
+╰──────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ────────────────────────────────────────────────────────────────────╮
+│ --schema                                   TEXT          The location (url   │
+│                                                          or path) of the     │
+│                                                          ODCS JSON Schema    │
+│ --server                                   TEXT          The server          │
+│                                                          configuration to    │
+│                                                          run the schema and  │
+│                                                          quality tests. Use  │
+│                                                          the key of the      │
+│                                                          server object in    │
+│                                                          the data contract   │
+│                                                          yaml file to refer  │
+│                                                          to a server, e.g.,  │
+│                                                          `production`, or    │
+│                                                          `all` for all       │
+│                                                          servers (default).  │
+│                                                          [default: all]      │
+│ --publish                                  TEXT          The url to publish  │
+│                                                          the results after   │
+│                                                          the test.           │
+│ --output                                   PATH          Specify the file    │
+│                                                          path where the test │
+│                                                          results should be   │
+│                                                          written to (e.g.,   │
+│                                                          './test-results/TE… │
+│ --output-format                            [json|junit]  The target format   │
+│                                                          for the test        │
+│                                                          results.            │
+│ --logs                --no-logs                          Print logs          │
+│                                                          [default: no-logs]  │
+│ --json                --no-json                          Print test results  │
+│                                                          as JSON to stdout.  │
+│                                                          [default: no-json]  │
+│ --fail-on                                  TEXT          Minimum severity    │
+│                                                          that causes a       │
+│                                                          non-zero exit code: │
+│                                                          'warning', 'error', │
+│                                                          or 'never'.         │
+│                                                          [default: error]    │
+│ --ssl-verification    --no-ssl-verific…                  SSL verification    │
+│                                                          when publishing the │
+│                                                          data contract.      │
+│                                                          [default:           │
+│                                                          ssl-verification]   │
+│ --debug               --no-debug                         Enable debug        │
+│                                                          logging             │
+│ --help                                                   Show this message   │
+│                                                          and exit.           │
+╰──────────────────────────────────────────────────────────────────────────────╯
+
+```
+
+The `ci` command wraps [`test`](#test) with CI/CD-specific features:
+
+- **Multiple contracts**: `datacontract ci contracts/*.yaml`
+- **CI annotations:** Inline annotations for failed checks (GitHub Actions and Azure DevOps)
+- **Markdown summary** of the test results (GitHub Actions)
+- **`--json`**: Print test results as JSON to stdout for machine-readable output
+- **`--fail-on`**: Control the minimum severity that causes a non-zero exit code. Default is `error`; set to `warning` to also fail on warnings, or `never` to always exit 0.
+
+The [supported server types](#supported-data-sources) and their configuration are equivalent to the `test` command.
+
+```bash
+# Single contract
+$ datacontract ci datacontract.yaml
+
+# Multiple contracts
+$ datacontract ci contracts/*.yaml
+
+# Fail on warnings too
+$ datacontract ci --fail-on warning datacontract.yaml
+
+# JSON output for scripting
+$ datacontract ci --json datacontract.yaml
+```
+
+<details markdown="1">
+<summary>GitHub Actions workflow example</summary>
+
+```yaml
+# .github/workflows/datacontract.yml
+name: Data Contract CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  datacontract-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install datacontract-cli
+      # Test one or more data contracts (supports globs, e.g. contracts/*.yaml)
+      - run: datacontract ci datacontract.yaml
+```
+
+</details>
+
+<details markdown="1">
+<summary>Azure DevOps pipeline example</summary>
+
+```yaml
+# azure-pipelines.yml
+trigger:
+  branches:
+    include:
+      - main
+
+pool:
+  vmImage: "ubuntu-latest"
+
+steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: "3.11"
+  - script: pip install datacontract-cli
+    displayName: "Install datacontract-cli"
+  # Test one or more data contracts (supports globs, e.g. contracts/*.yaml)
+  - script: datacontract ci datacontract.yaml
+    displayName: "Run data contract tests"
+```
+
+</details>
+
 
 ### export
 ```
@@ -1477,67 +1661,65 @@ The export function converts the data contract specification into the custom for
 datacontract export --format custom --template template.txt datacontract.yaml
 ```
 
-##### Jinja variables
+##### Jinja templates & variables
 
 You can directly use the Data Contract Specification as template variables.
 
+{% raw %}
 ```shell
 $ cat template.txt
 title: {{ data_contract.info.title }}
+models:
+{%- for model_name, model in data_contract.models.items() %}
+  - name: {{ model.name }}
+{%- endfor %}
 
 $ datacontract export --format custom --template template.txt datacontract.yaml
 title: Orders Latest
 ```
+{% endraw %}
 
-##### Example Jinja Templates
+##### Example Jinja Templates for a customized dbt model
 
-###### Customized dbt model
+You can export a given dbt model containing any logic by adding the `schema-name` filter/parameter (in ODCS, "schemas" are the equivalent of "models" in dbt).
 
-You can export the dbt models containing any logic.
+It adds jinja variable passed to your template.file:
+- `schema_name`: str
+- `schema`: SchemaObject from ODCS
 
 Below is an example of a dbt staging layer that converts a field of `type: timestamp` to a `DATETIME` type with time zone conversion.
 
-template.sql
-
-{% raw %}
-```sql
-{%- for model_name, model in data_contract.models.items() %}
-{#- Export only the first model #}
-{%- if loop.first -%}
-SELECT
-{%- for field_name, field in model.fields.items() %}
-  {%- if field.type == "timestamp" %}
-  DATETIME({{ field_name }}, "Asia/Tokyo") AS {{ field_name }},
-  {%- else %}
-  {{ field_name }} AS {{ field_name }},
-  {%- endif %}
-{%- endfor %}
-FROM
-  {{ "{{" }} ref('{{ model_name }}') {{ "}}" }} 
-{%- endif %}
-{%- endfor %}
-```
-{% endraw %}
-
-command
-
-```shell
-datacontract export --format custom --template template.sql --output output.sql datacontract.yaml
-```
-
-output.sql
-
-```sql
-SELECT
-  order_id AS order_id,
-  DATETIME(order_timestamp, "Asia/Tokyo") AS order_timestamp,
-  order_total AS order_total,
-  customer_id AS customer_id,
-  customer_email_address AS customer_email_address,
-  DATETIME(processed_timestamp, "Asia/Tokyo") AS processed_timestamp,
-FROM
-  {{ ref('orders') }}
-```
+- `template.sql`
+  {% raw %}
+  ```sql
+  SELECT
+  {%- for field in schema.properties %}
+    {%- if field.physicalType == "timestamp" %}
+    DATETIME({{ field.name }}, "Asia/Tokyo") AS {{ field.name }},
+    {%- else %}
+    {{ field.name }} AS {{ field.name }},
+    {%- endif %}
+  {%- endfor %}
+  FROM {{ "{{" }} ref('{{ schema_name }}') {{ "}}" }}
+  ```
+  {% endraw %}
+- export command
+  ```shell
+  datacontract export datacontract.odcs.yaml --format custom --template template.sql --schema-name orders
+  ```
+- `output.sql`
+  {% raw %}
+  ```sql
+  SELECT
+    order_id AS order_id,
+    DATETIME(order_timestamp, "Asia/Tokyo") AS order_timestamp,
+    order_total AS order_total,
+    customer_id AS customer_id,
+    customer_email_address AS customer_email_address,
+    DATETIME(processed_timestamp, "Asia/Tokyo") AS processed_timestamp,
+  FROM {{ ref('orders') }}
+  ```
+  {% endraw %}
 
 #### ODCS Excel Template
 
@@ -1985,10 +2167,11 @@ Create a data contract based on the actual data. This is the fastest way to get
    $ datacontract lint
    ```
 
-4. Set up a CI pipeline that executes daily for continuous quality checks. You can also report the
-   test results to tools like [Data Mesh Manager](https://datamesh-manager.com)
+4. Set up a CI pipeline that executes daily for continuous quality checks. Use the [`ci`](#ci) command for
+   CI-optimized output (GitHub Actions annotations and step summary, Azure DevOps annotations).
+   You can also report the test results to tools like [Data Mesh Manager](https://datamesh-manager.com).
    ```bash
-   $ datacontract test --publish https://api.datamesh-manager.com/api/test-results
+   $ datacontract ci --publish https://api.datamesh-manager.com/api/test-results
    ```
 
 ### Contract-First
@@ -2199,11 +2382,20 @@ uv run ruff check
 uv run pytest
 ```
 
+## Contribution
+
+We are happy to receive your contributions. Propose your change in an issue or directly create a
+pull request with your improvements.
+
+Before creating a pull request, please make sure that all tests are passing (`uv run pytest`) and
+your code is properly formatted (`ruff format`). Create a changelog entry and reference fixed
+issues (if any).
+
 ### Troubleshooting
 
 #### Windows: Some tests fail
 
-Run in wsl. (We need to fix the paths in the tests so that normal Windows will work, contributions are appreciated)
+Run in WSL. (We need to fix the paths in the tests so that normal Windows will work, contributions are appreciated)
 
 #### PyCharm does not pick up the `.venv` 
 
@@ -2265,10 +2457,6 @@ This command runs the container momentarily to check the version of the `datacon
 5. Wait until GitHub Release is created
 6. Add the release notes to the GitHub Release
 
-## Contribution
-
-We are happy to receive your contributions. Propose your change in an issue or directly create a pull request with your improvements.
-
 ## Companies using this tool
 
 - [Entropy Data](https://www.entropy-data.com)