Metadata-Version: 2.4
Name: adri
Version: 7.2.9
Summary: Stop Your AI Agents Breaking on Bad Data - Data Quality Assessment Framework
Author-email: Thomas Russell <adri@verodat.com>
Maintainer-email: Thomas Russell <adri@verodat.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" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form 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 header files that merely contain generic
              factual information, version numbers, or other material that
              appears to be publicly available, but merely accompanies 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, merge, publish,
              distribute, sublicense, and/or sell copies of the Work, and to
              permit persons to whom the Work is furnished to do so, subject to
              the following conditions:
        
              The above copyright notice and this permission notice shall be
              included in all copies or substantial portions of the Work.
        
           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, patent, trademark, and
                  attribution 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 Additional Liability. When redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           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 "license" line as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2025 Verodat
        
           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.
        
Project-URL: Homepage, https://github.com/adri-standard/adri
Project-URL: Documentation, https://github.com/adri-standard/adri/blob/main/README.md
Project-URL: Repository, https://github.com/adri-standard/adri
Project-URL: Issues, https://github.com/adri-standard/adri/issues
Project-URL: Changelog, https://github.com/adri-standard/adri/blob/main/CHANGELOG.md
Keywords: data-quality,ai,validation,assessment,reliability,agents,llm
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: pandas>=2.2.2
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: click>=8.1.7
Requires-Dist: pyarrow>=16.1.0
Requires-Dist: tabulate>=0.9.0
Requires-Dist: jsonschema>=4.0.0
Provides-Extra: dev
Requires-Dist: pytest>=8.2.0; extra == "dev"
Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
Requires-Dist: pytest-benchmark>=4.0; extra == "dev"
Requires-Dist: pytest-timeout>=2.1.0; extra == "dev"
Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
Requires-Dist: psutil>=5.9.0; extra == "dev"
Requires-Dist: pre-commit>=3.0.0; extra == "dev"
Requires-Dist: black==26.1.0; extra == "dev"
Requires-Dist: isort>=5.13.2; extra == "dev"
Requires-Dist: flake8>=7.1.1; extra == "dev"
Requires-Dist: mypy>=1.11.2; extra == "dev"
Requires-Dist: pylint>=3.2.6; extra == "dev"
Requires-Dist: bandit[toml]>=1.7.10; extra == "dev"
Requires-Dist: safety>=3.2.8; extra == "dev"
Requires-Dist: pip-audit>=2.7.3; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=8.2.0; extra == "test"
Requires-Dist: pytest-cov>=5.0.0; extra == "test"
Requires-Dist: pytest-benchmark>=4.0; extra == "test"
Requires-Dist: pytest-timeout>=2.1.0; extra == "test"
Requires-Dist: pytest-mock>=3.12.0; extra == "test"
Requires-Dist: psutil>=5.9.0; extra == "test"
Requires-Dist: pyarrow>=14.0.0; extra == "test"
Requires-Dist: tabulate>=0.9.0; extra == "test"
Dynamic: license-file

# ADRI – Agent Data Readiness Index

Protect AI workflows from bad data with one line of code.

ADRI is a small Python library that enforces data quality **before** data reaches an AI agent step. It turns data assumptions into **executable data contracts**, and applies them automatically at runtime.

No platform. No services. Runs locally in your project.

```python
from adri import adri_protected

@adri_protected(contract="customer_data", data_param="data")
def process_customers(data):
    # Your agent logic here
    return results
```

---

## What it is

ADRI provides:
- A decorator to guard a function or agent step
- A CLI for setup and inspection
- A reusable library of contract templates

---

## Install & set up

```bash
pip install adri
adri setup
```

---

## What happens when you run it

### First successful run
- ADRI inspects the input data
- Creates a data contract (stored as YAML)
- Saves local artifacts for debugging/inspection

### Subsequent runs
- Incoming data is checked against the contract
- ADRI calculates quality scores across 5 dimensions
- Based on your settings, it either:
  - allows execution, or
  - blocks execution (raises)

---

## How ADRI works (high level)

![ADRI Flow Diagram](https://raw.githubusercontent.com/adri-standard/adri/main/docs/static/img/adri-flow.png)

**In plain English:** ADRI sits between your code and its data, checking quality before letting data through. Good data passes, bad data gets blocked.

---

## Use it in code

```python
from adri import adri_protected
import pandas as pd

@adri_protected(contract="customer_data", data_param="customer_data")
def analyze_customers(customer_data):
    """Your AI agent logic."""
    print(f"Analyzing {len(customer_data)} customers")
    return {"status": "complete"}

# First run with good data
customers = pd.DataFrame({
    "id": [1, 2, 3],
    "email": ["user1@example.com", "user2@example.com", "user3@example.com"],
    "signup_date": ["2024-01-01", "2024-01-02", "2024-01-03"]
})

analyze_customers(customers)  # ✅ Runs, auto-generates contract
```

**What happened:**
1. Function executed successfully
2. ADRI analyzed the data structure
3. Generated a YAML contract under your project
4. Future runs validate against that contract

**Future runs with bad data:**
```python
bad_customers = pd.DataFrame({
    "id": [1, 2, None],  # Missing ID
    "email": ["user1@example.com", "invalid-email", "user3@example.com"],  # Bad email
    # Missing signup_date column
})

analyze_customers(bad_customers)  # ❌ Raises exception with quality report
```

---

## Quick links

- **[Quickstart](https://github.com/adri-standard/adri/blob/main/QUICKSTART.md)** – 2-minute integration
- **[Getting started](https://github.com/adri-standard/adri/blob/main/docs/GETTING_STARTED.md)** – tutorial
- **[How it works](https://github.com/adri-standard/adri/blob/main/docs/HOW_IT_WORKS.md)** – quality dimensions explained
- **[Data contracts](https://github.com/adri-standard/adri/blob/main/docs/DATA_CONTRACTS.md)** – concept + examples
- **[Contracts library](https://github.com/adri-standard/adri/blob/main/docs/CONTRACTS_LIBRARY.md)** – reusable templates
- **[Framework patterns](https://github.com/adri-standard/adri/blob/main/docs/FRAMEWORK_PATTERNS.md)** – LangChain, CrewAI, AutoGen, etc.
- **[CLI reference](https://github.com/adri-standard/adri/blob/main/docs/CLI_REFERENCE.md)** – CLI commands
- **[FAQ](https://github.com/adri-standard/adri/blob/main/docs/FAQ.md)** – common questions
- **[Examples](https://github.com/adri-standard/adri/tree/main/examples)** – real-world examples

## Protection modes

```python
# Raise mode (default) - blocks bad data by raising an exception
@adri_protected(contract="data", data_param="data", on_failure="raise")

# Warn mode - logs warning but continues execution
@adri_protected(contract="data", data_param="data", on_failure="warn")

# Continue mode - silently continues
@adri_protected(contract="data", data_param="data", on_failure="continue")
```

## Contract templates (start fast)

ADRI includes reusable contract templates for common domains and AI workflows.

### Business domains
- **[Customer Service](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/domains/customer_service_contract.yaml)**
- **[E-commerce Orders](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/domains/ecommerce_order_contract.yaml)**
- **[Financial Transactions](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/domains/financial_transaction_contract.yaml)**
- **[Healthcare Patients](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/domains/healthcare_patient_contract.yaml)**
- **[Marketing Campaigns](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/domains/marketing_campaign_contract.yaml)**

### AI frameworks
- **[LangChain Inputs](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/frameworks/langchain_chain_input_contract.yaml)**
- **[CrewAI Task Context](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/frameworks/crewai_task_context_contract.yaml)**
- **[LlamaIndex Documents](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/frameworks/llamaindex_document_contract.yaml)**
- **[AutoGen Messages](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/frameworks/autogen_message_contract.yaml)**

### Generic templates
- **[API Responses](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/templates/api_response_template.yaml)**
- **[Time Series](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/templates/time_series_template.yaml)**
- **[Key-Value](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/templates/key_value_template.yaml)**
- **[Nested JSON](https://github.com/adri-standard/adri/blob/main/ADRI/contracts/templates/nested_json_template.yaml)**

## Contributing

- Star the project: https://github.com/adri-standard/adri
- Share feedback/requests in Discussions: https://github.com/adri-standard/adri/discussions
- Contribute new contracts and examples: [CONTRIBUTING.md](https://github.com/adri-standard/adri/blob/main/CONTRIBUTING.md)

## Use cases

ADRI works with any data format. Sample data files are included for common scenarios:

### API Data Validation
Protect your API integrations with structural validation.
- Sample: [`api_response.json`](https://github.com/adri-standard/adri/blob/main/examples/data/api_response.json)

### Multi-Agent Workflows
Validate context passed between agents in CrewAI, AutoGen, etc.
- Sample: [`crew_context.json`](https://github.com/adri-standard/adri/blob/main/examples/data/crew_context.json)

### RAG Pipelines
Ensure documents have correct structure before indexing.
- Sample: [`rag_documents.json`](https://github.com/adri-standard/adri/blob/main/examples/data/rag_documents.json)

## License

Apache 2.0. See [LICENSE](https://github.com/adri-standard/adri/blob/main/LICENSE).

---

Built with ❤️ by Thomas Russell at [Verodat](https://verodat.com).

One line of code. Local enforcement. Reliable agents.
