datacontract-cli 0.9.2__tar.gz → 0.9.4__tar.gz

{datacontract-cli-0.9.2/datacontract_cli.egg-info → datacontract-cli-0.9.4}/PKG-INFO

@@ -1,31 +1,36 @@
 Metadata-Version: 2.1
 Name: datacontract-cli
-Version: 0.9.2
-Summary: Validate data contracts
+Version: 0.9.4
+Summary: Test data contracts
 Author-email: Jochen Christ <jochen.christ@innoq.com>, Stefan Negele <stefan.negele@innoq.com>
 Project-URL: Homepage, https://cli.datacontract.com
 Project-URL: Issues, https://github.com/datacontract/cli/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: ~=3.11
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer[all]~=0.9.0
-Requires-Dist: pydantic~=2.5.3
+Requires-Dist: pydantic<2.7.0,>=2.5.3
 Requires-Dist: pyyaml~=6.0.1
 Requires-Dist: requests~=2.31.0
 Requires-Dist: fastparquet==2023.10.1
-Requires-Dist: soda-core-duckdb~=3.1.3
-Requires-Dist: soda-core-snowflake~=3.1.3
-Requires-Dist: snowflake-connector-python[pandas]~=3.6.0
-Requires-Dist: duckdb~=0.9.2
+Requires-Dist: soda-core-bigquery~=3.1.5
+Requires-Dist: soda-core-duckdb~=3.1.5
+Requires-Dist: soda-core-postgres~=3.1.5
+Requires-Dist: soda-core-snowflake~=3.1.5
+Requires-Dist: soda-core-spark[databricks]~=3.1.5
+Requires-Dist: soda-core-spark-df~=3.1.5
+Requires-Dist: snowflake-connector-python[pandas]<3.8,>=3.6
+Requires-Dist: duckdb==0.10.0
 Requires-Dist: fastjsonschema~=2.19.1
 Requires-Dist: python-dotenv~=1.0.0
-Requires-Dist: s3fs==2023.12.2
+Requires-Dist: s3fs==2024.2.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: testcontainers-minio; extra == "dev"
+Requires-Dist: testcontainers-postgres; extra == "dev"
 
 # Data Contract CLI
 
@@ -44,12 +49,12 @@ It uses data contract YAML files to lint the data contract, connect to data sour
 
 ## Getting started
 
-Let's use [pip](https://pip.pypa.io/en/stable/getting-started/) to install the CLI.  
+Let's use [pip](https://pip.pypa.io/en/stable/getting-started/) to install the CLI.
 ```bash
 $ pip3 install datacontract-cli
 ```
 
-Now, let's look at this data contract:  
+Now, let's look at this data contract:
 [https://datacontract.com/examples/covid-cases/datacontract.yaml](https://datacontract.com/examples/covid-cases/datacontract.yaml)
 
 We have a _servers_ section with endpoint details to the (public) S3 bucket, _models_ for the structure of the data, and _quality_ attributes that describe the expected freshness and number of rows.
@@ -77,6 +82,9 @@ $ datacontract lint datacontract.yaml
 # execute schema and quality checks
 $ datacontract test datacontract.yaml
 
+# execute schema and quality checks on the examples within the contract
+$ datacontract test --examples datacontract.yaml
+
 # find differences between to data contracts (Coming Soon)
 $ datacontract diff datacontract-v1.yaml datacontract-v2.yaml
 
@@ -124,6 +132,7 @@ Choose the most appropriate installation method for your needs:
 
 ### pip
 Python 3.11 recommended.
+Python 3.12 available as pre-release release candidate for 0.9.3
 
 ```bash
 pip3 install datacontract-cli
@@ -135,17 +144,17 @@ pipx installs into an isolated environment.
 pipx install datacontract-cli
 ```
 
-### Homebrew (coming soon)
+### Docker
 
 ```bash
-brew install datacontract/brew/datacontract
+docker pull --platform linux/amd64 datacontract/cli
+docker run --rm --platform linux/amd64 -v ${PWD}:/home/datacontract datacontract/cli
 ```
 
-### Docker (coming soon)
+Or via an alias that automatically uses the latest version:
 
 ```bash
-docker pull datacontract/cli
-docker run --rm -v ${PWD}:/datacontract datacontract/cli
+alias datacontract='docker run --rm -v "${PWD}:/home/datacontract" --platform linux/amd64 datacontract/cli:latest'
 ```
 
 ## Documentation
@@ -154,7 +163,7 @@ docker run --rm -v ${PWD}:/datacontract datacontract/cli
 
 Data Contract CLI can connect to data sources and run schema and quality tests to verify that the data contract is valid.
 
-```bash 
+```bash
 $ datacontract test --server production datacontract.yaml
 ```
 
@@ -168,11 +177,12 @@ The application uses different engines, based on the server `type`.
 | `s3`         | `json`     | Support for `new_line` delimited JSON files and one JSON record per file. | ✅           | fastjsonschema<br> soda-core-duckdb |
 | `s3`         | `csv`      |                                                                           | ✅           | soda-core-duckdb                    |
 | `s3`         | `delta`    |                                                                           | Coming soon | TBD                                 |
-| `postgres`   | n/a        |                                                                           | Coming soon | TBD                                 |
-| `snowflake`  | n/a        |                                                                           | ✅ | soda-core-snowflake                 |
-| `bigquery`   | n/a        |                                                                           | Coming soon | TBD                                 |
+| `postgres`   | n/a        |                                                                           | ✅           | soda-core-postgres                  |
+| `snowflake`  | n/a        |                                                                           | ✅           | soda-core-snowflake                 |
+| `bigquery`   | n/a        |                                                                           | ✅           | soda-core-bigquery                  |
 | `redshift`   | n/a        |                                                                           | Coming soon | TBD                                 |
-| `databricks` | n/a        |                                                                           | Coming soon | TBD                                 |
+| `databricks` | n/a        | Support for Databricks SQL with Unity catalog and Hive metastore.         | ✅           | soda-core-spark                     |
+| `databricks` | n/a        | Support for Spark for programmatic use in Notebooks.                      | ✅           | soda-core-spark-df                  |
 | `kafka`      | `json`     |                                                                           | Coming soon | TBD                                 |
 | `kafka`      | `avro`     |                                                                           | Coming soon | TBD                                 |
 | `kafka`      | `protobuf` |                                                                           | Coming soon | TBD                                 |
@@ -182,32 +192,178 @@ The application uses different engines, based on the server `type`.
 
 Feel free to create an issue, if you need support for an additional type.
 
-### Server Type S3
+### S3
 
-Example:
+Data Contract CLI can test data that is stored in S3 buckets or any S3-compliant endpoints in various formats.
+
+#### Example
 
 datacontract.yaml
-```
+```yaml
 servers:
   production:
     type: s3
     endpointUrl: https://minio.example.com # not needed with AWS S3
     location: s3://bucket-name/path/*/*.json
-    delimiter: new_line # new_line, array, or none
     format: json
+    delimiter: new_line # new_line, array, or none
+```
+
+#### Environment Variables
+
+| Environment Variable              | Example                       | Description           |
+|-----------------------------------|-------------------------------|-----------------------|
+| `DATACONTRACT_S3_REGION`            | `eu-central-1`                  | Region of S3 bucket   |
+| `DATACONTRACT_S3_ACCESS_KEY_ID`     | `AKIAXV5Q5QABCDEFGH`            | AWS Access Key ID     |
+| `DATACONTRACT_S3_SECRET_ACCESS_KEY` | `93S7LRrJcqLaaaa/XXXXXXXXXXXXX` | AWS Secret Access Key |
+
+
+### Postgres
+
+Data Contract CLI can test data in Postgres or Postgres-compliant databases (e.g., RisingWave).
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  postgres:
+    type: postgres
+    host: localhost
+    port: 5432
+    database: postgres
+    schema: public
+models:
+  my_table_1: # corresponds to a table
+    type: table
+    fields: 
+      my_column_1: # corresponds to a column
+        type: varchar
+```
+
+#### Environment Variables
+
+| Environment Variable             | Example            | Description |
+|----------------------------------|--------------------|-------------|
+| `DATACONTRACT_POSTGRES_USERNAME` | `postgres`         | Username    |
+| `DATACONTRACT_POSTGRES_PASSWORD` | `mysecretpassword` | Password    |
+
+
+### BigQuery
+
+We support authentication to BigQuery using Service Account Key. The used Service Account should include the roles:
+* BigQuery Job User
+* BigQuery Data Viewer
+
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  production:
+    type: bigquery
+    project: datameshexample-product
+    dataset: datacontract_cli_test_dataset
+models:
+  datacontract_cli_test_table: # corresponds to a BigQuery table
+    type: table
+    fields: ...
+```
+
+#### Environment Variables
+
+| Environment Variable                         | Example                   | Description                                             |
+|----------------------------------------------|---------------------------|---------------------------------------------------------|
+| `DATACONTRACT_BIGQUERY_ACCOUNT_INFO_JSON_PATH` | `~/service-access-key.json` | Service Access key as saved on key creation by BigQuery |
+
+
+### Databricks
+
+Works with Unity Catalog and Hive metastore.
+
+Needs a running SQL warehouse or compute cluster.
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  production:
+    type: databricks
+    host: dbc-abcdefgh-1234.cloud.databricks.com
+    catalog: acme_catalog_prod
+    schema: orders_latest
+models:
+  orders: # corresponds to a table
+    type: table
+    fields: ...
 ```
 
-Environment variables
+#### Environment Variables
+
+| Environment Variable                         | Example                              | Description                                           |
+|----------------------------------------------|--------------------------------------|-------------------------------------------------------|
+| `DATACONTRACT_DATABRICKS_TOKEN` | `dapia00000000000000000000000000000` | The personal access token to authenticate             |
+| `DATACONTRACT_DATABRICKS_HTTP_PATH` | `/sql/1.0/warehouses/b053a3ffffffff` | The HTTP path to the SQL warehouse or compute cluster |
+
+
+### Databricks (programmatic)
+
+Works with Unity Catalog and Hive metastore.
+When running in a notebook or pipeline, the provided `spark` session can be used.
+An additional authentication is not required.
+
+Requires a Databricks Runtime with Python >= 3.10.
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  production:
+    type: databricks
+    host: dbc-abcdefgh-1234.cloud.databricks.com # ignored, always use current host
+    catalog: acme_catalog_prod
+    schema: orders_latest
+models:
+  orders: # corresponds to a table
+    type: table
+    fields: ...
 ```
-export DATACONTRACT_S3_REGION=eu-central-1
-export DATACONTRACT_S3_ACCESS_KEY_ID=AKIAXV5Q5QABCDEFGH
-export DATACONTRACT_S3_SECRET_ACCESS_KEY=93S7LRrJcqLkdb2/XXXXXXXXXXXXX
+
+Notebook
+```python
+%pip install git+https://github.com/datacontract/cli.git
+dbutils.library.restartPython()
+
+from datacontract.data_contract import DataContract
+
+data_contract = DataContract(
+  data_contract_file="/Volumes/acme_catalog_prod/orders_latest/datacontract/datacontract.yaml", 
+  spark=spark)
+run = data_contract.test()
+run.result
 ```
 
 
+### Exports
+
+Available export options:
+
+| Type         | Description                                    | Status |
+|--------------|------------------------------------------------|--------|
+| `jsonschema` | Export to JSON Schema                          | ✅      | 
+| `sodacl`     | Export to SodaCL quality checks in YAML format | ✅      |
+| `dbt`        | Export to dbt model in YAML format             | TBD    |
+| `avro`       | Export to AVRO models                          | TBD    |
+| `pydantic`   | Export to pydantic models                      | TBD    |
+| `sql`        | Export to SQL DDL                              | TBD    |
+| `protobuf`   | Export to Protobuf                             | TBD    |
+
 ## Development Setup
 
-Python base interpreter should be 3.11.x
+Python base interpreter should be 3.11.x (unless working on 3.12 release candidate).
 
 ```bash
 # create venv
@@ -237,7 +393,7 @@ Docker Build
 
 ```
 docker build -t datacontract/cli .
-docker run --rm -v ${PWD}:/datacontract datacontract/cli
+docker run --rm -v ${PWD}:/home/datacontract datacontract/cli
 ```
 
 ## Contribution
@@ -251,3 +407,7 @@ We are happy to receive your contributions. Propose your change in an issue or d
 ## Credits
 
 Created by [Stefan Negele](https://www.linkedin.com/in/stefan-negele-573153112/) and [Jochen Christ](https://www.linkedin.com/in/jochenchrist/).
+
+
+
+<a href="https://github.com/datacontract/cli" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>

{datacontract-cli-0.9.2 → datacontract-cli-0.9.4}/README.md

@@ -15,12 +15,12 @@ It uses data contract YAML files to lint the data contract, connect to data sour
 
 ## Getting started
 
-Let's use [pip](https://pip.pypa.io/en/stable/getting-started/) to install the CLI.  
+Let's use [pip](https://pip.pypa.io/en/stable/getting-started/) to install the CLI.
 ```bash
 $ pip3 install datacontract-cli
 ```
 
-Now, let's look at this data contract:  
+Now, let's look at this data contract:
 [https://datacontract.com/examples/covid-cases/datacontract.yaml](https://datacontract.com/examples/covid-cases/datacontract.yaml)
 
 We have a _servers_ section with endpoint details to the (public) S3 bucket, _models_ for the structure of the data, and _quality_ attributes that describe the expected freshness and number of rows.
@@ -48,6 +48,9 @@ $ datacontract lint datacontract.yaml
 # execute schema and quality checks
 $ datacontract test datacontract.yaml
 
+# execute schema and quality checks on the examples within the contract
+$ datacontract test --examples datacontract.yaml
+
 # find differences between to data contracts (Coming Soon)
 $ datacontract diff datacontract-v1.yaml datacontract-v2.yaml
 
@@ -95,6 +98,7 @@ Choose the most appropriate installation method for your needs:
 
 ### pip
 Python 3.11 recommended.
+Python 3.12 available as pre-release release candidate for 0.9.3
 
 ```bash
 pip3 install datacontract-cli
@@ -106,17 +110,17 @@ pipx installs into an isolated environment.
 pipx install datacontract-cli
 ```
 
-### Homebrew (coming soon)
+### Docker
 
 ```bash
-brew install datacontract/brew/datacontract
+docker pull --platform linux/amd64 datacontract/cli
+docker run --rm --platform linux/amd64 -v ${PWD}:/home/datacontract datacontract/cli
 ```
 
-### Docker (coming soon)
+Or via an alias that automatically uses the latest version:
 
 ```bash
-docker pull datacontract/cli
-docker run --rm -v ${PWD}:/datacontract datacontract/cli
+alias datacontract='docker run --rm -v "${PWD}:/home/datacontract" --platform linux/amd64 datacontract/cli:latest'
 ```
 
 ## Documentation
@@ -125,7 +129,7 @@ docker run --rm -v ${PWD}:/datacontract datacontract/cli
 
 Data Contract CLI can connect to data sources and run schema and quality tests to verify that the data contract is valid.
 
-```bash 
+```bash
 $ datacontract test --server production datacontract.yaml
 ```
 
@@ -139,11 +143,12 @@ The application uses different engines, based on the server `type`.
 | `s3`         | `json`     | Support for `new_line` delimited JSON files and one JSON record per file. | ✅           | fastjsonschema<br> soda-core-duckdb |
 | `s3`         | `csv`      |                                                                           | ✅           | soda-core-duckdb                    |
 | `s3`         | `delta`    |                                                                           | Coming soon | TBD                                 |
-| `postgres`   | n/a        |                                                                           | Coming soon | TBD                                 |
-| `snowflake`  | n/a        |                                                                           | ✅ | soda-core-snowflake                 |
-| `bigquery`   | n/a        |                                                                           | Coming soon | TBD                                 |
+| `postgres`   | n/a        |                                                                           | ✅           | soda-core-postgres                  |
+| `snowflake`  | n/a        |                                                                           | ✅           | soda-core-snowflake                 |
+| `bigquery`   | n/a        |                                                                           | ✅           | soda-core-bigquery                  |
 | `redshift`   | n/a        |                                                                           | Coming soon | TBD                                 |
-| `databricks` | n/a        |                                                                           | Coming soon | TBD                                 |
+| `databricks` | n/a        | Support for Databricks SQL with Unity catalog and Hive metastore.         | ✅           | soda-core-spark                     |
+| `databricks` | n/a        | Support for Spark for programmatic use in Notebooks.                      | ✅           | soda-core-spark-df                  |
 | `kafka`      | `json`     |                                                                           | Coming soon | TBD                                 |
 | `kafka`      | `avro`     |                                                                           | Coming soon | TBD                                 |
 | `kafka`      | `protobuf` |                                                                           | Coming soon | TBD                                 |
@@ -153,32 +158,178 @@ The application uses different engines, based on the server `type`.
 
 Feel free to create an issue, if you need support for an additional type.
 
-### Server Type S3
+### S3
 
-Example:
+Data Contract CLI can test data that is stored in S3 buckets or any S3-compliant endpoints in various formats.
+
+#### Example
 
 datacontract.yaml
-```
+```yaml
 servers:
   production:
     type: s3
     endpointUrl: https://minio.example.com # not needed with AWS S3
     location: s3://bucket-name/path/*/*.json
-    delimiter: new_line # new_line, array, or none
     format: json
+    delimiter: new_line # new_line, array, or none
+```
+
+#### Environment Variables
+
+| Environment Variable              | Example                       | Description           |
+|-----------------------------------|-------------------------------|-----------------------|
+| `DATACONTRACT_S3_REGION`            | `eu-central-1`                  | Region of S3 bucket   |
+| `DATACONTRACT_S3_ACCESS_KEY_ID`     | `AKIAXV5Q5QABCDEFGH`            | AWS Access Key ID     |
+| `DATACONTRACT_S3_SECRET_ACCESS_KEY` | `93S7LRrJcqLaaaa/XXXXXXXXXXXXX` | AWS Secret Access Key |
+
+
+### Postgres
+
+Data Contract CLI can test data in Postgres or Postgres-compliant databases (e.g., RisingWave).
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  postgres:
+    type: postgres
+    host: localhost
+    port: 5432
+    database: postgres
+    schema: public
+models:
+  my_table_1: # corresponds to a table
+    type: table
+    fields: 
+      my_column_1: # corresponds to a column
+        type: varchar
+```
+
+#### Environment Variables
+
+| Environment Variable             | Example            | Description |
+|----------------------------------|--------------------|-------------|
+| `DATACONTRACT_POSTGRES_USERNAME` | `postgres`         | Username    |
+| `DATACONTRACT_POSTGRES_PASSWORD` | `mysecretpassword` | Password    |
+
+
+### BigQuery
+
+We support authentication to BigQuery using Service Account Key. The used Service Account should include the roles:
+* BigQuery Job User
+* BigQuery Data Viewer
+
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  production:
+    type: bigquery
+    project: datameshexample-product
+    dataset: datacontract_cli_test_dataset
+models:
+  datacontract_cli_test_table: # corresponds to a BigQuery table
+    type: table
+    fields: ...
+```
+
+#### Environment Variables
+
+| Environment Variable                         | Example                   | Description                                             |
+|----------------------------------------------|---------------------------|---------------------------------------------------------|
+| `DATACONTRACT_BIGQUERY_ACCOUNT_INFO_JSON_PATH` | `~/service-access-key.json` | Service Access key as saved on key creation by BigQuery |
+
+
+### Databricks
+
+Works with Unity Catalog and Hive metastore.
+
+Needs a running SQL warehouse or compute cluster.
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  production:
+    type: databricks
+    host: dbc-abcdefgh-1234.cloud.databricks.com
+    catalog: acme_catalog_prod
+    schema: orders_latest
+models:
+  orders: # corresponds to a table
+    type: table
+    fields: ...
 ```
 
-Environment variables
+#### Environment Variables
+
+| Environment Variable                         | Example                              | Description                                           |
+|----------------------------------------------|--------------------------------------|-------------------------------------------------------|
+| `DATACONTRACT_DATABRICKS_TOKEN` | `dapia00000000000000000000000000000` | The personal access token to authenticate             |
+| `DATACONTRACT_DATABRICKS_HTTP_PATH` | `/sql/1.0/warehouses/b053a3ffffffff` | The HTTP path to the SQL warehouse or compute cluster |
+
+
+### Databricks (programmatic)
+
+Works with Unity Catalog and Hive metastore.
+When running in a notebook or pipeline, the provided `spark` session can be used.
+An additional authentication is not required.
+
+Requires a Databricks Runtime with Python >= 3.10.
+
+#### Example
+
+datacontract.yaml
+```yaml
+servers:
+  production:
+    type: databricks
+    host: dbc-abcdefgh-1234.cloud.databricks.com # ignored, always use current host
+    catalog: acme_catalog_prod
+    schema: orders_latest
+models:
+  orders: # corresponds to a table
+    type: table
+    fields: ...
 ```
-export DATACONTRACT_S3_REGION=eu-central-1
-export DATACONTRACT_S3_ACCESS_KEY_ID=AKIAXV5Q5QABCDEFGH
-export DATACONTRACT_S3_SECRET_ACCESS_KEY=93S7LRrJcqLkdb2/XXXXXXXXXXXXX
+
+Notebook
+```python
+%pip install git+https://github.com/datacontract/cli.git
+dbutils.library.restartPython()
+
+from datacontract.data_contract import DataContract
+
+data_contract = DataContract(
+  data_contract_file="/Volumes/acme_catalog_prod/orders_latest/datacontract/datacontract.yaml", 
+  spark=spark)
+run = data_contract.test()
+run.result
 ```
 
 
+### Exports
+
+Available export options:
+
+| Type         | Description                                    | Status |
+|--------------|------------------------------------------------|--------|
+| `jsonschema` | Export to JSON Schema                          | ✅      | 
+| `sodacl`     | Export to SodaCL quality checks in YAML format | ✅      |
+| `dbt`        | Export to dbt model in YAML format             | TBD    |
+| `avro`       | Export to AVRO models                          | TBD    |
+| `pydantic`   | Export to pydantic models                      | TBD    |
+| `sql`        | Export to SQL DDL                              | TBD    |
+| `protobuf`   | Export to Protobuf                             | TBD    |
+
 ## Development Setup
 
-Python base interpreter should be 3.11.x
+Python base interpreter should be 3.11.x (unless working on 3.12 release candidate).
 
 ```bash
 # create venv
@@ -208,7 +359,7 @@ Docker Build
 
 ```
 docker build -t datacontract/cli .
-docker run --rm -v ${PWD}:/datacontract datacontract/cli
+docker run --rm -v ${PWD}:/home/datacontract datacontract/cli
 ```
 
 ## Contribution
@@ -222,3 +373,7 @@ We are happy to receive your contributions. Propose your change in an issue or d
 ## Credits
 
 Created by [Stefan Negele](https://www.linkedin.com/in/stefan-negele-573153112/) and [Jochen Christ](https://www.linkedin.com/in/jochenchrist/).
+
+
+
+<a href="https://github.com/datacontract/cli" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>

{datacontract-cli-0.9.2 → datacontract-cli-0.9.4}/datacontract/cli.py

@@ -87,14 +87,16 @@ def test(
              "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).")] = "all",
+    examples: Annotated[bool, typer.Option(
+        help="Run the schema and quality tests on the example data within the data contract.")] = None,
     publish: Annotated[str, typer.Option(
-        help="")] = None,
+        help="The url to publish the results after the test")] = None,
 ):
     """
     Run schema and quality tests on configured servers.
     """
     print(f"Testing {location}")
-    run = DataContract(data_contract_file=location, publish_url=publish).test()
+    run = DataContract(data_contract_file=location, publish_url=publish, examples=examples).test()
     _handle_result(run)