|
1 | 1 |
|
2 | | -<h1 align="center">Soda Core</h1> |
| 2 | +<h1 align="center">Soda Core — Data Contracts Engine</h1> |
3 | 3 |
|
4 | | -TODO re-add preamble |
| 4 | +Soda Core is a data quality and data contract verification engine. It lets you define data quality contracts in YAML and automatically validate both schema and data across your data stack. |
5 | 5 |
|
| 6 | +Soda Core runs contracts as part of your pipelines and orchestration tools, making data quality enforcement scalable, automated, and easy to integrate. |
| 7 | + |
| 8 | +## Highlights |
| 9 | + |
| 10 | +- Define data contracts using a clean, human-readable YAML syntax |
| 11 | +- Run checks on PostgreSQL, Snowflake, BigQuery, Databricks, DuckDB, and more |
| 12 | +- Use 50+ built-in data quality checks for common and advanced validations |
| 13 | +- Integrate with [Soda Cloud](https://soda.io/?utm_source=github&utm_medium=readme&utm_campaign=soda-core&utm_content=soda_cloud) for centralized management and anomaly detection monitoring |
6 | 14 |
|
7 | 15 | ## Setup |
8 | 16 |
|
@@ -33,7 +41,7 @@ Replace `soda-postgres` with the appropriate package for your data source. See t |
33 | 41 |
|
34 | 42 | ## Quickstart |
35 | 43 |
|
36 | | -The examples show a minimal configuration of a data source and contract. Please see the [Soda Cloud documentation](https://docs.soda.io/soda-v4/reference/cli-reference) for more detailed examples as well as features available for Soda Cloud users. |
| 44 | +The examples show a minimal configuration of a data source and contract. Please see the [Soda Cloud documentation](https://docs.soda.io/soda-v4/reference/cli-reference) for more detailed examples as well as features available for [Soda Cloud](https://soda.io/?utm_source=github&utm_medium=readme&utm_campaign=soda-core&utm_content=soda_cloud) users. |
37 | 45 |
|
38 | 46 | ### Configure a data source |
39 | 47 | These commands help you define a local configuration for your data source (used by Soda Core) and validate the connection. |
@@ -96,7 +104,7 @@ For a full reference of contracts including available check definitions, please |
96 | 104 |
|
97 | 105 | ### Verify a contract |
98 | 106 |
|
99 | | -Executes a contract verification to check if the dataset complies with its expectations. You can verify a local contract file or a Soda Cloud contract either locally (in your Python environment) or remotely with a Soda Agent. |
| 107 | +Executes a contract verification to check if the dataset complies with its expectations. You can verify a local contract file or a [Soda Cloud](https://soda.io/?utm_source=github&utm_medium=readme&utm_campaign=soda-core&utm_content=soda_cloud) contract either locally (in your Python environment) or remotely with a Soda Agent. |
100 | 108 |
|
101 | 109 |
|
102 | 110 | ``` |
|
0 commit comments