piitag 0.1.0__tar.gz

piitag-0.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

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

@@ -0,0 +1,160 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  schedule:
+    - cron: "17 3 * * 1"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  UV_VERSION: "0.9.17"
+  MODEL_REVISION: "v0.4.0"
+
+jobs:
+  checks:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --python ${{ matrix.python-version }} --extra dev --extra litert
+
+      - name: Restore model assets
+        id: model-cache
+        uses: actions/cache@v6
+        with:
+          path: tests/fixtures/model
+          key: redact-model-${{ env.MODEL_REVISION }}
+
+      - name: Fetch model assets
+        if: steps.model-cache.outputs.cache-hit != 'true'
+        run: uv run python scripts/fetch_test_assets.py
+
+      - name: Run Ruff
+        run: |
+          uv run ruff check src/ tests/ scripts/
+          uv run ruff format --check src/ tests/ scripts/
+
+      - name: Run mypy
+        run: uv run mypy src/
+
+      - name: Run tests
+        run: uv run pytest -m "not slow"
+
+      - name: Build distribution
+        run: uv run python -m build
+
+      - name: Check distribution metadata
+        run: uv run twine check dist/*
+
+  scheduled-integration:
+    name: Scheduled model integration
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Install dependencies
+        run: uv sync --python 3.14 --extra dev --extra litert
+
+      - name: Restore model assets
+        id: model-cache
+        uses: actions/cache@v6
+        with:
+          path: tests/fixtures/model
+          key: redact-model-${{ env.MODEL_REVISION }}
+
+      - name: Fetch model assets
+        if: steps.model-cache.outputs.cache-hit != 'true'
+        run: uv run python scripts/fetch_test_assets.py
+
+      - name: Run model-backed tests
+        run: uv run pytest -m slow
+
+  release:
+    name: Semantic release
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'push' && github.ref == 'refs/heads/main')
+    needs: checks
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-release-${{ github.ref_name }}
+      cancel-in-progress: false
+    permissions:
+      contents: write
+    outputs:
+      released: ${{ steps.release.outputs.released }}
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Run semantic-release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v10.6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload distributions
+        if: steps.release.outputs.released == 'true'
+        uses: actions/upload-artifact@v6
+        with:
+          name: distributions
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to PyPI
+    if: needs.release.outputs.released == 'true'
+    needs: release
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/piitag
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v7
+        with:
+          name: distributions
+          path: dist/
+
+      - name: Publish distributions
+        uses: pypa/gh-action-pypi-publish@release/v1

piitag-0.1.0/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock is version controlled for reproducible dependency resolution.
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# Local model fixtures:
+tests/fixtures/model/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

piitag-0.1.0/AGENTS.md

@@ -0,0 +1,52 @@
+# AGENTS.md
+
+## Project overview
+
+This repo contains `piitag`, a Python package that wraps the Desert Ant Labs
+Redact on-device PII detection pipeline.
+
+- Package layout uses a `src/` layout under `src/piitag`.
+- Runtime dependencies are managed with `uv`.
+- Python requirement is 3.10 or newer.
+- Model assets are not bundled in the distribution and are downloaded from the
+  pinned Hugging Face revision at runtime or via the local test fixture
+  workflow.
+- Releases are driven by Conventional Commits and `python-semantic-release`.
+
+## Working conventions
+
+- Prefer `uv` commands over direct `python -m pip` usage.
+- Keep changes reproducible; do not hand-edit the generated lockfile.
+- Keep documentation in sync with behavior, especially `README.md`,
+  `CHANGELOG.md`, and `docs/PLAN.md`.
+- Do not add model weights or downloaded fixtures to git-tracked source files.
+- Keep CI in a single workflow file at `.github/workflows/ci.yml`.
+
+## Validation commands
+
+```sh
+uv run pytest
+uv run ruff check src/ tests/ scripts/
+uv run ruff format --check src/ tests/ scripts/
+uv run mypy src/
+uv run python -m build
+uv run twine check dist/*
+```
+
+## Commit and release expectations
+
+Use Conventional Commits:
+
+- `fix:` -> patch release
+- `feat:` -> minor release
+- `BREAKING CHANGE:` or `!` -> major release
+
+## Model fixtures and test assets
+
+The expected local asset directory is `tests/fixtures/model/`. It is for
+fetched test assets and should not be committed.
+
+## Notes for future agents
+
+Keep the implementation aligned with `docs/PLAN.md`. Prefer minimal, surgical
+edits over broad rewrites.

piitag-0.1.0/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+<!-- version list -->
+
+## v0.1.0 (2026-09-20)
+
+- Initial Release

piitag-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2026 Richard Hull
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software 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 Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

piitag-0.1.0/NOTICE.md

@@ -0,0 +1,10 @@
+# Third-party model assets
+
+`piitag` does not include Desert Ant Labs model weights or taxonomy assets.
+When downloaded at runtime, those assets come from the
+`desert-ant-labs/redact` Hugging Face repository at revision `v0.4.0` and are
+subject to the Desert Ant Labs Source-Available License.
+
+That license is separate from the MIT license covering the `piitag` wrapper
+code. Review the model license before using the assets in a commercial
+deployment.

piitag-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.5
+Name: piitag
+Version: 0.1.0
+Summary: Python port of Desert Ant Labs' Redact on-device PII detector
+License: # MIT License
+        
+        Copyright (c) 2026 Richard Hull
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software 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 Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE.md
+License-File: NOTICE.md
+Requires-Python: >=3.10
+Requires-Dist: huggingface-hub>=0.20
+Requires-Dist: numpy>=1.24
+Requires-Dist: regex>=2024.1
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Provides-Extra: litert
+Requires-Dist: ai-edge-litert; extra == 'litert'
+Provides-Extra: tensorflow
+Requires-Dist: tensorflow; extra == 'tensorflow'
+Description-Content-Type: text/markdown
+
+# piitag
+
+Python port of Desert Ant Labs' Redact on-device PII detector.
+
+The package is under active development. The implementation is being built in
+stages described in [the implementation plan](docs/PLAN.md).
+
+## Quick start
+
+Install the package and one of the supported TFLite runtimes:
+
+```sh
+uv add piitag ai-edge-litert
+```
+
+The first detection downloads the pinned model assets into the Hugging Face
+cache. You can also provide a directory containing the three model files:
+
+```python
+from piitag import Label, Options, Redact
+
+redactor = Redact()
+result = redactor.redaction("Email anna@example.com")
+print(result.redacted_text)
+print(result.restore(result.redacted_text))
+
+only_email = redactor.redaction(
+    "Email anna@example.com",
+    Options(labels=frozenset({Label.EMAIL})),
+)
+```
+
+The command-line interface accepts the same model cache by default:
+
+```sh
+uv run piitag "Email anna@example.com"
+uv run piitag "Call +44 20 7946 0958" --labels PHONE --json
+```
+
+Use `--directory PATH` for an offline directory containing
+`redact_tokenizer.bin`, `labels.json`, and `redact.tflite`.
+
+## Development setup
+
+Requirements:
+
+- Python 3.10 or newer
+- [uv](https://docs.astral.sh/uv/)
+
+Create an isolated environment and install the development dependencies:
+
+```sh
+uv venv
+source .venv/bin/activate
+uv sync --extra dev --extra litert
+```
+
+Use `--extra tensorflow` instead of `--extra litert` when TensorFlow is the
+preferred TFLite runtime.
+
+## Build, test, and check
+
+```sh
+uv run pytest
+uv run ruff check src/ tests/ scripts/
+uv run ruff format --check src/ tests/ scripts/
+uv run mypy src/
+uv run python -m build
+uv run twine check dist/*
+```
+
+Model weights and taxonomy assets are not bundled with the package. See
+[NOTICE.md](NOTICE.md) for the applicable model license.
+
+## Release
+
+Releases use Conventional Commits on `main` with
+`python-semantic-release`. The release workflow updates the package version,
+synchronizes `uv.lock`, updates [CHANGELOG.md](CHANGELOG.md), creates a tag
+and GitHub release, and publishes the wheel and source archive to PyPI.
+
+PyPI publishing uses Trusted Publishing. Configure the PyPI project publisher
+for this repository, workflow, and the `pypi` environment before publishing.
+
+- `fix:` creates a patch release.
+- `feat:` creates a minor release.
+- `BREAKING CHANGE:` or a `!` after the commit type creates a major release.
+
+Preview the next release locally without changing files:
+
+```sh
+uv run semantic-release --noop version
+```
+
+## License
+
+The `piitag` wrapper code is available under the MIT license. Model weights
+and taxonomy assets are not bundled with the package. Runtime downloads from
+the `desert-ant-labs/redact` Hugging Face repository at revision `v0.4.0` are
+subject to the Desert Ant Labs Source-Available License. See
+[NOTICE.md](NOTICE.md) before using those assets commercially.
+
+## AI-generated code disclaimer
+
+This codebase was generated with assistance from **GitHub Copilot**. The
+exact underlying model identifier used for this session is not exposed by the
+available session metadata, so no more specific model name is claimed here.
+Review and test all generated code before using it in production.