Metadata-Version: 2.4
Name: cascade-protocol
Version: 1.3.0
Summary: Python SDK for the Cascade Protocol — privacy-first health data serialization in RDF/Turtle
Project-URL: Homepage, https://cascadeprotocol.org
Project-URL: Documentation, https://cascadeprotocol.org/docs
Project-URL: Repository, https://github.com/the-cascade-protocol/sdk-python
Project-URL: Issue Tracker, https://github.com/the-cascade-protocol/sdk-python/issues
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 authorized by
              the copyright owner that is 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 made available under
              the License, as indicated by a copyright notice that is included in
              or attached to the work (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other transformations
              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, as submitted to the 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, any work of
              authorship, including the original version of the Work and any
              modifications or additions to that Work or any modifications or
              additions to a Derivative Works of the Work.
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been submitted to the Licensor.
        
              "Contributor Version" shall mean the combination of the Contributor's
              Contributions, plus any modifications or additions to such
              Contributions submitted to the Licensor for inclusion in the Work.
        
              "Submitted" shall mean 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 Legal Entity on behalf of
              whom a Contribution has been submitted to the Licensor.
        
           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 reproduce, 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 the 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 any
              Contribution embodied 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, You must include a readable copy of the
                  attribution notices contained within such NOTICE file, 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 license statement for Your modifications and
              may provide additional grant of rights to use, copy, modify, merge,
              publish, distribute, sublicense, and/or sell copies of the
              modifications, and to permit persons to whom the modifications are
              furnished, subject to the following conditions: the above copyright
              notice and this permission notice shall be included in all copies or
              substantial portions of the modifications.
        
           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 reproducing 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 exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (even if such Contributor has been advised of the possibility
              of such damages).
        
           9. Accepting Warranty or Liability. While 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 offer only obligations consistent
              with this License, and only if You accept that such obligations are
              consistent with this License and not in violation of the License.
        
           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. Also, we recommend that a
              file and directory "README" file be included with your work.
        
           Copyright 2026 Cascade Agentic Labs
        
           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: cascade,fhir,health,privacy,rdf,turtle
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: rdflib>=7.0.0
Provides-Extra: all
Requires-Dist: jupyter>=1.0.0; extra == 'all'
Requires-Dist: matplotlib>=3.7.0; extra == 'all'
Requires-Dist: pandas>=2.0.0; extra == 'all'
Requires-Dist: pyshacl>=0.26.0; extra == 'all'
Provides-Extra: notebooks
Requires-Dist: jupyter>=1.0.0; extra == 'notebooks'
Requires-Dist: matplotlib>=3.7.0; extra == 'notebooks'
Requires-Dist: pandas>=2.0.0; extra == 'notebooks'
Provides-Extra: pandas
Requires-Dist: pandas>=2.0.0; extra == 'pandas'
Provides-Extra: validation
Requires-Dist: pyshacl>=0.26.0; extra == 'validation'
Description-Content-Type: text/markdown

# cascade-protocol

Python SDK for the [Cascade Protocol](https://cascadeprotocol.org) — a privacy-first, local-first standard for serializing personal health data as RDF/Turtle.

## Installation

```bash
pip install cascade-protocol
```

With optional extras:

```bash
pip install "cascade-protocol[pandas]"       # pandas DataFrame integration
pip install "cascade-protocol[validation]"   # SHACL validation via pyshacl
pip install "cascade-protocol[notebooks]"    # Jupyter notebook support
pip install "cascade-protocol[all]"          # Everything
```

## Quick Start

```python
from cascade_protocol import Medication, serialize, validate, Pod

# Create a medication record
med = Medication(
    id="urn:uuid:med0-0001-aaaa-bbbb-ccccddddeeee",
    medication_name="Metoprolol Succinate",
    is_active=True,
    dose="25mg",
    data_provenance="ClinicalGenerated",
    schema_version="1.3",
)

# Serialize to Turtle
turtle = serialize(med)
print(turtle)

# Validate structural integrity
result = validate(turtle)
print(result.is_valid, result.errors)

# Open a Cascade Pod and query records
pod = Pod.open("./my-pod")
meds = pod.query("medications")

# Convert to pandas DataFrame (requires pandas extra)
df = meds.to_dataframe()
print(df.head())

# Reconstruct models from DataFrame
restored = Medication.from_dataframe(df)
```

## Serialization Output

```turtle
@prefix cascade: <https://ns.cascadeprotocol.org/core/v1#> .
@prefix health: <https://ns.cascadeprotocol.org/health/v1#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<urn:uuid:med0-0001-aaaa-bbbb-ccccddddeeee> a health:MedicationRecord ;
    health:medicationName "Metoprolol Succinate" ;
    health:isActive true ;
    cascade:dataProvenance cascade:ClinicalGenerated ;
    cascade:schemaVersion "1.3" ;
    health:dose "25mg" .
```

## Supported Data Types

| Class | RDF Type | Description |
|---|---|---|
| `Medication` | `health:MedicationRecord` | Prescription and OTC drugs |
| `Condition` | `health:ConditionRecord` | Medical diagnoses |
| `Allergy` | `health:AllergyRecord` | Allergies and intolerances |
| `LabResult` | `health:LabResultRecord` | Laboratory test results |
| `VitalSign` | `clinical:VitalSign` | Vital sign measurements |
| `Immunization` | `health:ImmunizationRecord` | Vaccine records |
| `Procedure` | `health:ProcedureRecord` | Clinical procedures |
| `FamilyHistory` | `health:FamilyHistoryRecord` | Family health history |
| `Coverage` | `coverage:InsurancePlan` | Insurance coverage |
| `PatientProfile` | `cascade:PatientProfile` | Patient demographics |
| `ActivitySnapshot` | `health:ActivitySnapshot` | Daily activity data |
| `SleepSnapshot` | `health:SleepSnapshot` | Nightly sleep data |
| `Encounter` | `clinical:Encounter` | Clinical encounters and visits |
| `MedicationAdministration` | `clinical:MedicationAdministration` | Medication administration events |
| `ImplantedDevice` | `clinical:ImplantedDevice` | Implanted medical devices |
| `ImagingStudy` | `clinical:ImagingStudy` | Imaging studies and results |
| `ClaimRecord` | `coverage:ClaimRecord` | Insurance claim records |
| `BenefitStatement` | `coverage:BenefitStatement` | Explanation of benefits |
| `DenialNotice` | `coverage:DenialNotice` | Coverage denial notices |
| `AppealRecord` | `coverage:AppealRecord` | Denial appeal records |

## Pod API

```python
from cascade_protocol import Pod

pod = Pod.open("./my-pod")

# Query by data type
meds = pod.query("medications")
vitals = pod.query("vital-signs")
profile = pod.query("patient-profile")

# Iterate records
for med in meds:
    print(med.medication_name, med.dose)

# DataFrame conversion
df = meds.to_dataframe()
```

## Parsing Turtle

```python
from cascade_protocol.deserializer import parse, parse_one

# Parse multiple records
meds = parse(turtle_string, "MedicationRecord")

# Parse a single record
med = parse_one(turtle_string, "MedicationRecord")
```

## Namespaces

```python
from cascade_protocol.vocabularies import NAMESPACES, CURRENT_SCHEMA_VERSION

print(NAMESPACES["cascade"])   # https://ns.cascadeprotocol.org/core/v1#
print(NAMESPACES["health"])    # https://ns.cascadeprotocol.org/health/v1#
print(CURRENT_SCHEMA_VERSION)  # 1.3
```

## Privacy & Security

- Zero network calls during normal operation
- All processing is local
- No telemetry or analytics
- Data never leaves your machine

## License

Apache 2.0 — see [LICENSE](LICENSE).

## Links

- [Getting Started Guide](https://cascadeprotocol.org/docs/getting-started/python/)
- [Protocol Schema Reference](https://cascadeprotocol.org/docs/cascade-protocol-schemas)
- [Conformance Test Suite](https://github.com/the-cascade-protocol/cascadeprotocol.org/tree/main/conformance)
