Skip to content

Commit 984bfd9

Browse files
santiviquezpaulteehan
authored andcommitted
Library description (#2546)
1 parent 1118097 commit 984bfd9

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11

2-
<h1 align="center">Soda Core</h1>
2+
<h1 align="center">Soda Core — Data Contracts Engine</h1>
33

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.
55

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
614

715
## Setup
816

@@ -33,7 +41,7 @@ Replace `soda-postgres` with the appropriate package for your data source. See t
3341

3442
## Quickstart
3543

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.
3745

3846
### Configure a data source
3947
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
96104

97105
### Verify a contract
98106

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.
100108

101109

102110
```

0 commit comments

Comments
 (0)