Metadata-Version: 2.4
Name: alation-data-quality-sdk
Version: 1.0.7
Summary: Production-ready SDK for running Alation data quality checks using Soda Core
Project-URL: Homepage, https://pypi.org/project/alation-data-quality-sdk/
Project-URL: Documentation, https://www.alation.com/docs/en/latest/
Author-email: Alation Engineering <support@alation.com>
Maintainer-email: Alation Engineering <support@alation.com>
License: Apache License
        Version 2.0, January 2004
        http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1. Definitions.
        
           "License" shall mean the terms and conditions for use, reproduction,
           and distribution as defined by Sections 1 through 9 of this document.
        
           "Licensor" shall mean the copyright owner or entity granting the License.
        
           "Legal Entity" shall mean the union of the acting entity and all
           other entities that control, are controlled by, or are under common
           control with that entity. For the purposes of this definition,
           "control" means (i) the power, direct or indirect, to cause the
           direction or management of such entity, whether by contract or
           otherwise, or (ii) ownership of fifty percent (50%) or more of the
           outstanding shares, or (iii) beneficial ownership of such entity.
        
           "You" (or "Your") shall mean an individual or Legal Entity
           exercising permissions granted by this License.
        
           "Source" shall mean the preferred form for making modifications,
           including but not limited to software source code, documentation
           source, and configuration files.
        
           "Object" shall mean any form resulting from mechanical
           transformation or translation of a Source form, including but
           not limited to compiled object code, generated documentation,
           and conversions to other media types.
        
           "Work" shall mean the work of authorship, whether in Source or
           Object form, made available under the License, as indicated by a
           copyright notice that is included in or attached to the work
           (which shall not include communications that are posted to mailing
           lists, newsgroups or other fora that are used for general discussion
           of the work).
        
           "Derivative Works" shall mean any work, whether in Source or Object
           form, that is based upon (or derived from) the Work and for which the
           editorial revisions, annotations, elaborations, or other modifications
           represent, as a whole, an original work of authorship. For the purposes
           of this License, Derivative Works shall not include works that remain
           separable from, or merely link (or bind by name) to the interfaces of,
           the Work and derivative works thereof.
        
           "Contribution" shall mean any work of authorship, including
           the original version of the Work and any modifications or additions
           to that Work or Derivative Works thereof, that is intentionally
           submitted to Licensor for inclusion in the Work by the copyright owner
           or by an individual or Legal Entity authorized to submit on behalf of
           the copyright owner. For the purposes of this definition, "submitted"
           means any form of electronic, verbal, or written communication sent
           to the Licensor or its representatives, including but not limited to
           communication on electronic mailing lists, source code control
           systems, and issue tracking systems that are managed by, or on behalf
           of, the Licensor for the purpose of discussing and improving the Work,
           but excluding communication that is conspicuously marked or otherwise
           designated in writing by the copyright owner as "Not a Contribution."
        
           "Contributor" shall mean Licensor and any individual or Legal Entity
           on behalf of whom a Contribution has been received by Licensor and
           subsequently incorporated within the Work.
        
        2. Grant of Copyright License. Subject to the terms and conditions of
           this License, each Contributor hereby grants to You a perpetual,
           worldwide, non-exclusive, no-charge, royalty-free, irrevocable
           copyright license to use, reproduce, modify, distribute, and prepare
           Derivative Works of, publicly display, publicly perform, sublicense,
           and distribute the Work and such Derivative Works in Source or Object
           form.
        
        3. Grant of Patent License. Subject to the terms and conditions of
           this License, each Contributor hereby grants to You a perpetual,
           worldwide, non-exclusive, no-charge, royalty-free, irrevocable
           (except as stated in this section) patent license to make, have made,
           use, offer to sell, sell, import, and otherwise transfer the Work,
           where such license applies only to those patent claims licensable
           by such Contributor that are necessarily infringed by their
           Contribution(s) alone or by combination of their Contribution(s)
           with the Work to which such Contribution(s) was submitted. If You
           institute patent litigation against any entity (including a
           cross-claim or counterclaim in a lawsuit) alleging that the Work
           or a Contribution incorporated within the Work constitutes direct
           or contributory patent infringement, then any patent licenses
           granted to You under this License for that Work shall terminate
           as of the date such litigation is filed.
        
        4. Redistribution. You may reproduce and distribute copies of the
           Work or Derivative Works thereof in any medium, with or without
           modifications, and in Source or Object form, provided that You
           meet the following conditions:
        
           (a) You must give any other recipients of the Work or
               Derivative Works a copy of this License; and
        
           (b) You must cause any modified files to carry prominent notices
               stating that You changed the files; and
        
           (c) You must retain, in the Source form of any Derivative Works
               that You distribute, all copyright, trademark, patent,
               attribution and other notices from the Source form of the Work,
               excluding those notices that do not pertain to any part of
               the Derivative Works; and
        
           (d) If the Work includes a "NOTICE" text file as part of its
               distribution, then any Derivative Works that You distribute must
               include a readable copy of the attribution notices contained
               within such NOTICE file, excluding those notices that do not
               pertain to any part of the Derivative Works, in at least one
               of the following places: within a NOTICE text file distributed
               as part of the Derivative Works; within the Source form or
               documentation, if provided along with the Derivative Works; or,
               within a display generated by the Derivative Works, if and
               wherever such third-party notices normally appear. The contents
               of the NOTICE file are for informational purposes only and
               do not modify the License. You may add Your own attribution
               notices within Derivative Works that You distribute, alongside
               or as an addendum to the NOTICE text from the Work, provided
               that such additional attribution notices cannot be construed
               as modifying the License.
        
           You may add Your own copyright notice to Your modifications and
           may provide additional or different license terms and conditions
           for use, reproduction, or distribution of Your modifications, or
           for any such Derivative Works as a whole, provided Your use,
           reproduction, and distribution of the Work otherwise complies with
           the conditions stated in this License.
        
        5. Submission of Contributions. Unless You explicitly state otherwise,
           any Contribution intentionally submitted for inclusion in the Work
           by You to the Licensor shall be under the terms and conditions of
           this License, without any additional terms or conditions.
           Notwithstanding the above, nothing herein shall supersede or modify
           the terms of any separate license agreement you may have executed
           with Licensor regarding such Contributions.
        
        6. Trademarks. This License does not grant permission to use the trade
           names, trademarks, service marks, or product names of the Licensor,
           except as required for reasonable and customary use in describing the
           origin of the Work and reproducing the content of the NOTICE file.
        
        7. Disclaimer of Warranty. Unless required by applicable law or
           agreed to in writing, Licensor provides the Work (and each
           Contributor provides its Contributions) on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
           implied, including, without limitation, any warranties or conditions
           of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
           PARTICULAR PURPOSE. You are solely responsible for determining the
           appropriateness of using or redistributing the Work and assume any
           risks associated with Your exercise of permissions under this License.
        
        8. Limitation of Liability. In no event and under no legal theory,
           whether in tort (including negligence), contract, or otherwise,
           unless required by applicable law (such as deliberate and grossly
           negligent acts) or agreed to in writing, shall any Contributor be
           liable to You for damages, including any direct, indirect, special,
           incidental, or consequential damages of any character arising as a
           result of this License or out of the use or inability to use the
           Work (including but not limited to damages for loss of goodwill,
           work stoppage, computer failure or malfunction, or any and all
           other commercial damages or losses), even if such Contributor
           has been advised of the possibility of such damages.
        
        9. Accepting Warranty or Support. Unless required by applicable law or
           agreed to in writing, any Contributor hereby accepts sole responsibility
           for supporting and maintaining its Contributions, and agrees to provide
           warranty coverage for its Contributions to the extent required by law.
        
        END OF TERMS AND CONDITIONS
        
        APPENDIX: How to apply the Apache License to your work.
        
           To apply the Apache License to your work, attach the following
           boilerplate notice, with the fields enclosed by brackets "[]"
           replaced with your own identifying information. (Don't include
           the brackets!)  The text should be enclosed in the appropriate
           comment syntax for the file format. We also recommend that a
           file or class name and description of purpose be included on the
           same page as the copyright notice for easier identification within
           third-party archives.
        
        Copyright 2024 Alation Inc.
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
License-File: LICENSE
Keywords: Airflow,Alation,Data Pipeline,Data Quality,Soda Core
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Database
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.9
Requires-Dist: alation-logger-utils==0.1.1
Requires-Dist: alation-queryservice-client==0.1.1
Requires-Dist: grpcio>=1.40.0
Requires-Dist: protobuf>=3.19.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests>=2.25.0
Requires-Dist: snowflake-connector-python==3.14.0
Requires-Dist: soda-core-bigquery==3.4.4
Requires-Dist: soda-core-oracle==3.4.4
Requires-Dist: soda-core-postgres==3.4.4
Requires-Dist: soda-core-redshift==3.4.4
Requires-Dist: soda-core-snowflake==3.4.4
Requires-Dist: soda-core-spark-df==3.4.4
Requires-Dist: soda-core-spark[databricks]==3.4.4
Requires-Dist: soda-core-sqlserver==3.4.4
Requires-Dist: soda-core==3.4.4
Requires-Dist: sqlparse<0.6.0,>=0.5.0
Provides-Extra: dev
Requires-Dist: black>=22.0.0; extra == 'dev'
Requires-Dist: flake8>=4.0.0; extra == 'dev'
Requires-Dist: mypy>=0.910; extra == 'dev'
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=3.0.0; extra == 'dev'
Requires-Dist: pytest-mock>=3.6.0; extra == 'dev'
Requires-Dist: pytest>=6.0.0; extra == 'dev'
Requires-Dist: requests-mock>=1.9.0; extra == 'dev'
Description-Content-Type: text/markdown

# Alation Data Quality SDK

A production-ready Python SDK for executing Alation data quality checks using Soda Core. Designed for seamless integration into data pipelines, CI/CD workflows, and Airflow DAGs with minimal configuration.

## Features

- **Simple Configuration**: OAuth-based authentication with environment variables
- **Production Ready**: Comprehensive error handling, logging, and retry logic
- **Pipeline Friendly**: Built for Airflow and CI/CD integration with proper exit codes
- **Automatic Setup**: Fetches datasource credentials and check definitions from Alation
- **Comprehensive Results**: Detailed scan results with actionable recommendations
- **Enterprise Grade**: JWT token management with automatic refresh

## Installation

```bash
pip install alation-data-quality-sdk
```

## Prerequisites

Before using the SDK, ensure you have:

1. **Alation Instance Access**: A running Alation instance with data quality monitoring enabled
2. **OAuth Credentials**: Client ID and Secret configured in Alation (Settings > Authentication > OAuth Client Applications). Make sure you add an appropriate admin role for data quality access.
3. **Data Quality Monitor**: At least one configured monitor in Alation with defined checks
4. **Supported Datasource**: Connection to Snowflake, Redshift, Databricks, or BigQuery

## Configuration

### Required Environment Variables

```bash
export ALATION_HOST="https://your-instance.alationcloud.com"
export MONITOR_ID="123"
export ALATION_CLIENT_ID="your-client-id"
export ALATION_CLIENT_SECRET="your-client-secret"
export TENANT_ID="your-tenant-id"
```

### How to Obtain Configuration Values

- **ALATION_HOST**: Your Alation instance URL (e.g., `https://company.alationcloud.com`)
- **MONITOR_ID**: Found in Alation Data Quality Monitor page, in the URL (e.g., `.../data_quality/monitor/123`, the ID is `123`)
- **ALATION_CLIENT_ID & ALATION_CLIENT_SECRET**: Generated in Alation Settings > Authentication > OAuth Client Applications
- **TENANT_ID**: Found in Alation under Help (`?` Icon on top right) > About this instance

### Optional Environment Variables

```bash
export ALATION_TIMEOUT="30"     # Request timeout in seconds (default: 30)
export LOG_LEVEL="INFO"         # Logging level: DEBUG, INFO, WARNING, ERROR (default: INFO)
```

## Quick Start

### Python API

```python
from data_quality_sdk import DataQualityRunner

# Initialize and run checks
runner = DataQualityRunner()
result = runner.run_checks()

# Check results
if result['exit_code'] == 0:
    print("✅ All quality checks passed!")
else:
    print(f"❌ Quality checks failed: {result['summary']}")
    for recommendation in result['recommendations']:
        print(f"  - {recommendation}")
```

### Command Line Interface

```bash
# Run quality checks
alation-dq

# Perform health check
alation-dq --health-check

# Return only exit code (for pipelines)
alation-dq --exit-code-only
```

## Supported Data Sources

The SDK currently supports the following data sources:

- **Snowflake**
- **Amazon Redshift**
- **Databricks**
- **Google BigQuery**

Additional datasource support may be available through custom configuration. Contact Alation support for details.

## Integration Examples

### Airflow Integration

```python
from airflow import DAG
from airflow.operators.python import PythonOperator
from airflow.operators.bash import BashOperator
from datetime import datetime, timedelta

def run_data_quality_checks(**context):
    from data_quality_sdk import DataQualityRunner

    runner = DataQualityRunner()
    result = runner.run_checks()

    if result['exit_code'] != 0:
        raise Exception(f"Data quality checks failed: {result['summary']}")

    return result

default_args = {
    'owner': 'data-team',
    'depends_on_past': False,
    'start_date': datetime(2024, 1, 1),
    'email_on_failure': True,
    'email_on_retry': False,
    'retries': 2,
    'retry_delay': timedelta(minutes=5),
}

dag = DAG(
    'data_quality_pipeline',
    default_args=default_args,
    description='Data Quality Pipeline',
    schedule_interval='@daily',
    catchup=False,
)

# Your ETL tasks here
extract_task = BashOperator(
    task_id='extract_data',
    bash_command='your-extract-script.sh',
    dag=dag,
)

transform_task = BashOperator(
    task_id='transform_data',
    bash_command='your-transform-script.sh',
    dag=dag,
)

# Data quality checks
quality_check_task = PythonOperator(
    task_id='data_quality_checks',
    python_callable=run_data_quality_checks,
    env_vars={
        'ALATION_HOST': '{{ var.value.ALATION_HOST }}',
        'MONITOR_ID': '{{ var.value.MONITOR_ID }}',
        'ALATION_CLIENT_ID': '{{ var.value.ALATION_CLIENT_ID }}',
        'ALATION_CLIENT_SECRET': '{{ var.value.ALATION_CLIENT_SECRET }}',
        'TENANT_ID': '{{ var.value.TENANT_ID }}',
    },
    dag=dag,
)

# Load task (only runs if quality checks pass)
load_task = BashOperator(
    task_id='load_data',
    bash_command='your-load-script.sh',
    dag=dag,
)

# Set dependencies
extract_task >> transform_task >> quality_check_task >> load_task
```

### CI/CD Integration

```yaml
# .github/workflows/data-quality.yml
name: Data Quality Checks

on:
  schedule:
    - cron: "0 6 * * *" # Daily at 6 AM
  workflow_dispatch:

jobs:
  quality-checks:
    runs-on: ubuntu-latest

    steps:
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.9"

      - name: Install SDK
        run: |
          pip install alation-data-quality-sdk

      - name: Run data quality checks
        env:
          ALATION_HOST: ${{ secrets.ALATION_HOST }}
          MONITOR_ID: ${{ secrets.MONITOR_ID }}
          ALATION_CLIENT_ID: ${{ secrets.ALATION_CLIENT_ID }}
          ALATION_CLIENT_SECRET: ${{ secrets.ALATION_CLIENT_SECRET }}
          TENANT_ID: ${{ secrets.TENANT_ID }}
        run: |
          alation-dq --exit-code-only
```

## How It Works

1. **Authenticate**: Uses OAuth client credentials to obtain JWT tokens from Alation
2. **Fetch Checks**: Retrieves check definitions and datasource information using the Monitor ID
3. **Get Credentials**: Obtains datasource connection credentials via Alation's metadata API
4. **Generate Config**: Converts protobuf configuration to Soda Core YAML format
5. **Execute Scan**: Runs Soda Core scan with generated configuration and check definitions
6. **Report Results**: Sends scan results back to Alation and provides detailed local results

## Advanced Usage

### Programmatic Configuration

```python
from data_quality_sdk import SDKConfig, DataQualityRunner

config = SDKConfig(
    alation_host="https://my-instance.alationcloud.com",
    monitor_id="123",
    client_id="your-client-id",
    client_secret="your-client-secret",
    tenant_id="your-tenant-id",
    timeout=60,
    log_level="DEBUG"
)

runner = DataQualityRunner(config)
result = runner.run_checks()
```

### Health Check

Before running in production, verify your setup:

```python
health = DataQualityRunner.health_check()

print(f"Status: {health['status']}")
for check, result in health['checks'].items():
    print(f"  {check}: {result}")
```

## Understanding Results

The SDK returns detailed results with the following structure:

```python
{
    'exit_code': 0,                    # 0 = success, >0 = issues
    'monitor_id': '123',
    'summary': {
        'total_checks': 10,
        'passed': 8,
        'failed': 2,
        'warnings': 0,
        'errors': 0
    },
    'failed_checks': [...],            # Details of failed checks
    'recommendations': [...],          # Actionable recommendations
    'execution_metadata': {...}       # Runtime information
}
```

## Exit Codes

- `0`: Success - all checks passed
- `1`: Quality checks failed (data quality issues)
- `2`: Configuration or setup error
- `3`: Results upload failed
- `4`: Network connectivity error
- `5`: Unexpected error

## Error Handling

The SDK provides comprehensive error handling with specific exception types:

- `AlationAPIError`: Issues with Alation API calls
- `DatasourceConfigError`: Problems with datasource configuration
- `SodaScanError`: Soda Core execution failures
- `UnsupportedDatasourceError`: Unsupported datasource types
- `NetworkError`: Network connectivity issues

## Logging

The SDK provides structured logging with configurable levels:

```python
# Set log level via environment variable
export LOG_LEVEL="DEBUG"

# Or programmatically
from data_quality_sdk.utils.logging import setup_logging
logger = setup_logging("DEBUG")
```

## Troubleshooting

### Common Issues

1. **"Invalid OAuth credentials"**
   - Verify ALATION_CLIENT_ID and ALATION_CLIENT_SECRET are correct
   - Ensure OAuth application is active in Alation Settings

2. **"Tenant ID not found"**
   - Verify TENANT_ID matches the value in Alation > Help > About this instance
   - Check that your OAuth application has the correct tenant scope

3. **"Monitor not found"**
   - Verify MONITOR_ID exists in Alation Data Quality Monitors
   - Ensure your user has access to the specified monitor

4. **"Unsupported datasource type"**
   - Check that your datasource is one of: Snowflake, Redshift, Databricks, BigQuery
   - Contact Alation support for additional datasource support

5. **Connection errors**
   - Verify ALATION_HOST is correct and accessible
   - Check network connectivity to your Alation instance
   - Ensure your OAuth credentials have not expired

### Debug Mode

Enable debug logging to get detailed information:

```bash
export LOG_LEVEL="DEBUG"
alation-dq
```

## Support

For issues and questions:

1. Check the troubleshooting section above
2. Enable debug logging with `LOG_LEVEL="DEBUG"`
3. Contact your Alation Customer Success team
4. Visit Alation Community forums at https://help.alation.com

For bug reports, please contact Alation Support with:
- SDK version (`pip show alation-data-quality-sdk`)
- Python version
- Error messages and logs
- Steps to reproduce

## License

Apache License 2.0
