dfguard 0.1.0__tar.gz

dfguard-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install ruff mypy
+      - run: ruff check dfguard/ tests/
+      - run: mypy dfguard/ --ignore-missing-imports
+
+  test:
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false   # run all versions even if one fails
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - run: pip install -e ".[pyspark,dev]"
+      - run: pytest tests/pyspark/ -q --tb=short --cov=dfguard --cov-report=xml
+
+      - name: Upload coverage
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  # Test against the newest Python release.
+  # Allowed to fail: PySpark may not support it yet.
+  test-latest:
+    needs: lint
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+          cache: pip
+      - run: pip install -e ".[pyspark,dev]"
+      - run: pytest tests/pyspark/ -q --tb=short

dfguard-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,24 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write   # needed to push to gh-pages branch
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install -e ".[pyspark]" sphinx furo sphinx-autodoc-typehints
+      - run: make -C docs html
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html

dfguard-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          release-type: python
+
+  publish:
+    needs: release-please
+    if: needs.release-please.outputs.release_created
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # required for PyPI trusted publishing (no API token needed)
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install build && python -m build
+      - uses: pypa/gh-action-pypi-publish@release/v1

dfguard-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.eggs/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+docs/_build/
+*.DS_Store

dfguard-0.1.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - pyspark
+    - requirements: docs/requirements.txt

dfguard-0.1.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

dfguard-0.1.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.1.0 (2026-04-11)
+
+
+### Features
+
+* complex type tests, Airflow/Kedro examples, subset docs, pipeline docs ([9ff5820](https://github.com/nitrajen/dfguard/commit/9ff58201d6439d7982a7901bcfaf0bfb31ba0fff))
+* initial release of frameguard v0.1.0 ([90eced9](https://github.com/nitrajen/dfguard/commit/90eced96556dc74f463d04f4a59d8bf82b346537))
+* subset flag on enforce() and arm() with global/function-level hierarchy ([8bc0c08](https://github.com/nitrajen/dfguard/commit/8bc0c08d6aa7613ade08459e88d3e20c7fe1f3cf))
+
+
+### Bug Fixes
+
+* enforcement robustness and test coverage ([7db3f1b](https://github.com/nitrajen/dfguard/commit/7db3f1b364cdfd5a66783cd4b8de275adda98ab6))
+* resolve CI lint failures and add coverage reporting ([0ba8926](https://github.com/nitrajen/dfguard/commit/0ba892674a4a8541777d812d69a989de0560d530))
+* support Python 3.10 by replacing typing.Optional with fg.Optional ([ec765f4](https://github.com/nitrajen/dfguard/commit/ec765f42b571f79442c180fb337bc4194a629af0))
+
+
+### Documentation
+
+* fix subset section, add create_dataframe(), fix Kedro/Airflow docs ([d7de934](https://github.com/nitrajen/dfguard/commit/d7de9346632e047f7a2eafc16c8be70ab7a1a53f))
+* make Two ways section fully self-contained with imports and data ([1fcaf0a](https://github.com/nitrajen/dfguard/commit/1fcaf0a95780b3b142e449b9a1915458ad7369b6))
+* remove all em dashes from docs and README ([a86a627](https://github.com/nitrajen/dfguard/commit/a86a6270b5a1b25aa466f8cd56059fbcb9bbb0dc))
+* rewrite opening — lead with the problem, not a presumption ([e10f129](https://github.com/nitrajen/dfguard/commit/e10f1295cd2da2915f08566506686be5df27c336))
+* self-contained examples, drop Pandera mention, fix license label ([7753a94](https://github.com/nitrajen/dfguard/commit/7753a949e8f5f9dcc17410d7ab5aa286b1ff2e4a))
+* version in title, self-contained examples, nested struct, ReadTheDocs config ([d6439c5](https://github.com/nitrajen/dfguard/commit/d6439c5332d8ea642f2692c1e7b2085e81a27035))

dfguard-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to frameguard
+
+Thanks for taking the time. This is a small library with a focused job, so
+contributions don't need to be big to matter.
+
+## Reporting bugs
+
+Open an issue. Include:
+- what you were doing
+- the full error message
+- your Python, PySpark, and frameguard versions
+
+Schema mismatch bugs are especially welcome — if frameguard raised when it
+shouldn't have, or didn't raise when it should, that's exactly the kind of
+thing we want to know about.
+
+## Suggesting changes
+
+Open an issue before writing code. A quick description of the problem and
+what you have in mind is enough. We'll let you know if it fits the direction
+of the library.
+
+## Submitting a PR
+
+1. Fork the repo and create a branch
+2. `pip install -e ".[pyspark,dev]"`
+3. Write code, write tests
+4. `ruff check frameguard/ tests/` and `mypy frameguard/ --ignore-missing-imports`
+5. `pytest tests/pyspark/ -q`
+6. Open the PR with a short description of what changed and why
+
+Keep PRs focused. One thing at a time.
+
+## Roadmap
+
+PySpark is the first integration. Polars and pandas are next. If you want to
+help build those, say so in an issue and we'll coordinate.
+
+The core enforcement mechanism (`_enforcement.py`) is intentionally simple
+and dependency-free. New integrations should follow the same principle.

dfguard-0.1.0/LICENSE

@@ -0,0 +1,147 @@
+                                 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 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, 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. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives.
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 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.
+
+   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; and
+
+      (d) If the Work includes a "NOTICE" text file, 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.
+
+   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.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   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. See the License for the specific language governing
+      permissions and limitations under the 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 (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), 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 such conditions 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
+
+   Copyright 2024 Nithin Rajendran
+
+   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.