pinky-core 0.1.0.dev1__tar.gz → 0.1.0.dev3__tar.gz

pinky_core-0.1.0.dev3/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+    paths: ['src/**', 'tests/**', 'pyproject.toml', 'scripts/**', '.pre-commit-config.yaml', '.github/workflows/ci.yml']
+  pull_request:
+    branches: [main, develop]
+    paths: ['src/**', 'tests/**', 'pyproject.toml', 'scripts/**', '.pre-commit-config.yaml', '.github/workflows/ci.yml']
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    env:
+      FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Run pre-commit hooks
+        # Single source of truth: .pre-commit-config.yaml (ruff, mypy, bandit, gitleaks,
+        # detect-secrets, check-zws, check-forbidden-keywords, interrogate, darglint,
+        # check-typed-api, mdformat) — replaces the hand-duplicated Lint/Format/Type/Security
+        # steps, which only re-implemented 3 of the ~11 hooks and could silently drift from
+        # .pre-commit-config.yaml's actual args/excludes. j178/prek-action (not `pip install
+        # prek`): official action, caches the prek env between runs, defaults to
+        # `prek run --show-diff-on-failure --color=always --all-files`.
+        uses: j178/prek-action@v2
+
+      - name: Install dependencies
+        run: pip install -e ".[validate,address,dev]"
+
+      - name: Tests
+        run: pytest
+
+  precommit-windows:
+    # ADR-0023 pilot gate: hermetic pre-commit hooks must run on the brother's
+    # machine (Windows, prek only, no toolchain) — this is the real gate, not the Mac.
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        shell: [cmd, pwsh]
+    defaults:
+      run:
+        shell: ${{ matrix.shell }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Run mdformat hook
+        uses: j178/prek-action@v2
+        with:
+          extra-args: 'mdformat --all-files'

{pinky_core-0.1.0.dev1 → pinky_core-0.1.0.dev3}/.github/workflows/publish.yml

@@ -17,10 +17,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python 3.11
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: Install build
         run: pip install build

{pinky_core-0.1.0.dev1 → pinky_core-0.1.0.dev3}/.github/workflows/release.yml

@@ -32,10 +32,10 @@ jobs:
           git tag "v${{ steps.version.outputs.version }}"
           git push origin "v${{ steps.version.outputs.version }}"
 
-      - name: Set up Python 3.11
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: Install build
         run: pip install build

{pinky_core-0.1.0.dev1 → pinky_core-0.1.0.dev3}/.gitignore

@@ -17,26 +17,17 @@ venv/
 .conda/
 
 # ── Tools cache ──────────────────────────────────────────────────────────────
-.ruff_cache/
-.mypy_cache/
-.pytest_cache/
+.cache/*
 .pre-commit-cache/
-htmlcov/
-.coverage
-.coverage.*
-coverage.xml
 
 # ── Generated docs ───────────────────────────────────────────────────────────
-# docs/api/ is versioned — regenerate with: pdoc snowflake_kit -o docs/api/ or wget
+# docs/api/ is versioned — regenerate with: pdoc pinky_core -o docs/api/ or wget
 # Heavy wget mirrors are excluded (1 GB+)
 docs/api/*/*.com/
 # Local MkDocs assets — symlinked from pinky-studio for local dev, not committed
 docs/assets/
 site/
-
-# ── Provider cache ───────────────────────────────────────────────────────────
-.snowflake-provider/
-
+site.nosync/
 # ── Local dev ────────────────────────────────────────────────────────────────
 .local/
 *.local.json
@@ -51,6 +42,7 @@ connections.toml
 .DS_Store
 .AppleDouble
 .LSOverride
+*.icloud
 
 # ── VSCode ───────────────────────────────────────────────────────────────────
 # (keep .vscode/extensions.json and .vscode/settings.json — versioned)

pinky_core-0.1.0.dev3/.gitleaks.toml

@@ -0,0 +1,14 @@
+# Distributed as-is to every onboarded repo's root (see setup/precommit.py distribute()).
+# gitleaks auto-discovers .gitleaks.toml in the scan root — no pre-commit-side wiring needed.
+[extend]
+useDefault = true
+
+[allowlist]
+# .secrets.baseline stores detect-secrets' accepted findings as SHA1 hashes (hashed_secret),
+# never the raw secret — that's the whole point of a baseline. A high-entropy hash next to a
+# "secret"-shaped key still trips gitleaks' generic-api-key heuristic the moment a repo's baseline
+# records its first real finding (empty result sets don't trigger it, which is why this went
+# unnoticed until pinky-studio).
+paths = [
+  '''\.secrets\.baseline''',
+]

pinky_core-0.1.0.dev3/.pre-commit-config.yaml

@@ -0,0 +1,187 @@
+---
+# =============================================================================
+# .pre-commit-config.yaml — GENERATED by pinky-workspace/setup.py — DO NOT EDIT
+# =============================================================================
+# Source: pinky-workspace/core/pre-commit/{base,extras/*}.yaml
+# Third-party revs are pinned centrally in this base — bump them here, once.
+# To change which hooks a repo gets, edit the workspace source and re-run setup.py.
+#
+# Install (done automatically by setup.py):
+#   pip install pre-commit
+#   pre-commit install
+#   pre-commit install --hook-type commit-msg
+# =============================================================================
+default_install_hook_types: [pre-commit, commit-msg]
+# Pin explicite : sans ça, les hooks `language: python` (mdformat, mypy, interrogate, darglint…)
+# créent leur venv avec le python3 ambiant du PATH au moment de l'install, pas une version garantie
+# par le repo — non-déterministe en local (CI est protégée par actions/setup-python en amont).
+default_language_version:
+  python: python3.12
+
+repos:
+  # ── Formatting: trailing spaces + newline ─────────────────────────────────
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+        exclude: ^docs/reference/generated/
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  # ── Docs generation: README + docs/index.md + quality badges ──────────────
+  # Universal (every repo, not just the snowflake extra — 2026-07-10, renamed/extended from
+  # check-docs-up-to-date). Runs before mdformat below so the regenerated README gets reformatted.
+  - repo: local
+    hooks:
+      - id: generate-docs
+        name: Generate docs (README + index.md + badges)
+        entry: scripts/hooks/generate-docs
+        language: script
+        stages: [pre-commit]
+        pass_filenames: false
+
+  # ── Formatting: Markdown ──────────────────────────────────────────────────
+  - repo: local
+    hooks:
+      - id: mdformat
+        name: mdformat
+        entry: mdformat
+        language: python
+        additional_dependencies: ["mdformat==1.0.0"]
+        files: ^README\.md$
+
+  # ── Security: secrets & forbidden files ──────────────────────────────────
+  # gitleaks' hook has pass_filenames: false (it scans the repo itself, not a file list pre-commit
+  # hands it) — a pre-commit `exclude:` here would be silently inert. The real exclusion mechanism
+  # is the distributed .gitleaks.toml allowlist (see distribute()/DISTRIBUTED_PATHS): .secrets.baseline
+  # stores detect-secrets' accepted findings as SHA1 hashes, never the raw secret, but a high-entropy
+  # hash next to a "secret"-shaped key still trips gitleaks' generic-api-key heuristic (found rolling
+  # this out to pinky-studio, the first repo whose baseline had a real finding instead of an empty
+  # result set).
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.30.0
+    hooks:
+      - id: gitleaks
+
+  # ── Security: alternative secret detection ────────────────────────────────
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+        args: ["--baseline", ".secrets.baseline"]
+        exclude: ^docs/
+
+  # ── Zero-width spaces (copy-paste from Outlook/Teams) ────────────────────
+  - repo: local
+    hooks:
+      - id: check-zws
+        name: "[ZWS] Invisible characters (zero-width)"
+        entry: python scripts/hooks/check_zws.py
+        language: system
+        pass_filenames: true
+
+  # ── Employer reference guard ──────────────────────────────────────────────
+  - repo: local
+    hooks:
+      - id: check-forbidden-keywords
+        name: "[FORBIDDEN] Employer references"
+        entry: python scripts/hooks/check_forbidden_keywords.py
+        language: system
+        pass_filenames: true
+
+  # ── Commit message format ─────────────────────────────────────────────────
+  - repo: local
+    hooks:
+      - id: commit-msg-format
+        name: Commit message format
+        entry: scripts/hooks/commit-msg
+        language: script
+        stages: [commit-msg]
+
+  # ── EXTRA python — repos with src/ ────────────────────────────────────────
+  # Python: ruff lint + format
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.15
+    hooks:
+      - id: ruff-check
+        args: [--no-fix]
+      - id: ruff-format
+        args: [--check]
+
+  # Python: type checking
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: mypy
+        # Hermetic (ADR-0026, supersedes ADR-0023's system carve-out): additional_dependencies is
+        # auto-derived per repo by setup.py (build_precommit_config) from THAT repo's own
+        # pyproject.toml runtime `dependencies` — mypy pin + real third-party deps, minus internal
+        # pinky-* packages (pre-release, not on PyPI, excluded from the derivation).
+        # --ignore-missing-imports stays as the residual fallback for those excluded imports only.
+        language: python
+        additional_dependencies: ["mypy==2.0.0", "pydantic>=2.0", "sqlglot", "unidecode"]
+        types: [python]
+        args: [--ignore-missing-imports]
+        files: ^src/
+        # mypy's incremental cache (.mypy_cache/) isn't safe under concurrent access — without
+        # this, prek/pre-commit's default file-batch parallelism spawns multiple mypy processes
+        # against the same cache dir and one crashes with INTERNAL ERROR (reproduced on
+        # pinky-core: a single-process run over the same files passes clean).
+        require_serial: true
+
+  # Python: security
+  # B108 (hardcoded /tmp) is skipped workspace-wide: Snowflake execution only exposes
+  # /tmp as a writable scratch directory, so it is the sanctioned path, not a smell.
+  - repo: https://github.com/PyCQA/bandit
+    rev: "1.9.4"
+    hooks:
+      - id: bandit
+        pass_filenames: false
+        args: [-r, src/, -ll, --skip, B108]
+
+  # Docstrings: coverage
+  - repo: local
+    hooks:
+      - id: interrogate
+        name: "[DOCSTRING] Coverage"
+        entry: interrogate
+        language: python
+        additional_dependencies: ["interrogate==1.7.0"]
+        pass_filenames: false
+        args: [src/, --ignore-init-method, --ignore-magic, --ignore-module, --ignore-private]
+
+  # Docstrings: args/returns match signature
+  - repo: local
+    hooks:
+      - id: darglint
+        name: "[DOCSTRING] Args/Returns match"
+        entry: darglint
+        language: python
+        additional_dependencies: ["darglint==1.8.1"]
+        types: [python]
+        files: ^src/
+
+  # Typed API guard
+  - repo: local
+    hooks:
+      - id: check-typed-api
+        name: "[TYPED-API] No raw dict/tuple/set in public annotations"
+        entry: python scripts/hooks/check_typed_api.py
+        language: system
+        types: [python]
+        files: ^src/
+
+  # ── EXTRA snowflake — Snowpark / Core API repos ───────────────────────────
+  # Snowpark / Core API conventions (no session.sql(), canonical method names)
+  - repo: local
+    hooks:
+      - id: check-snowpark-api
+        name: "[SNOWPARK-API] No session.sql(), canonical method names"
+        entry: python scripts/hooks/check_snowpark_api.py
+        language: system
+        types: [python]
+        files: ^src/

pinky_core-0.1.0.dev3/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: pinky-core
+Version: 0.1.0.dev3
+Summary: Shared Python utilities for Snowflake development
+Project-URL: Homepage, https://github.com/pinky-and-co/pinky-core
+Project-URL: Repository, https://github.com/pinky-and-co/pinky-core
+Project-URL: Issues, https://github.com/pinky-and-co/pinky-core/issues
+Author: pinky-and-co
+License: MIT License
+        
+        Copyright (c) 2026 pinky-and-co
+        
+        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
+Keywords: data-engineering,snowflake,snowpark,utilities
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.0
+Requires-Dist: sqlglot
+Requires-Dist: unidecode
+Provides-Extra: address
+Requires-Dist: usaddress; extra == 'address'
+Provides-Extra: dev
+Requires-Dist: bandit; extra == 'dev'
+Requires-Dist: darglint; extra == 'dev'
+Requires-Dist: genbadge[coverage]; extra == 'dev'
+Requires-Dist: interrogate; extra == 'dev'
+Requires-Dist: mkdocs-awesome-pages-plugin>=2.0; extra == 'dev'
+Requires-Dist: mkdocs-material>=9.0; extra == 'dev'
+Requires-Dist: mkdocstrings[python]>=0.25; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: fec
+Requires-Dist: unidecode; extra == 'fec'
+Provides-Extra: lint
+Requires-Dist: detect-secrets>=1.5; extra == 'lint'
+Requires-Dist: ruff; extra == 'lint'
+Requires-Dist: sqlfluff>=3.0; extra == 'lint'
+Requires-Dist: yamllint>=1.35; extra == 'lint'
+Provides-Extra: schedule
+Requires-Dist: croniter; extra == 'schedule'
+Provides-Extra: validate
+Requires-Dist: email-validator; extra == 'validate'
+Requires-Dist: phonenumbers; extra == 'validate'
+Requires-Dist: python-stdnum; extra == 'validate'
+Provides-Extra: xml
+Requires-Dist: lxml; extra == 'xml'
+Requires-Dist: lxml-stubs; extra == 'xml'
+Description-Content-Type: text/markdown
+
+# pinky-core
+
+<!-- pinky:readme-badges:start -->
+
+<div align="center">
+
+<img src="https://assets.pinky-suite.fr/icons/pinky-header.png" width="380" alt="pinky &amp; co">
+
+![CI](https://github.com/pinky-and-co/pinky-core/actions/workflows/ci.yml/badge.svg)
+![Coverage](docs/reference/generated/coverage_badge.svg)
+![PyPI](https://img.shields.io/pypi/v/pinky-core)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Code style](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
+[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek)
+
+**[Install](#install) • [Documentation](#documentation) • [License](#license)**
+
+</div>
+<!-- pinky:readme-badges:end -->
+
+<!-- pinky:readme-tagline:start -->
+
+Shared Python utilities for Snowflake development.
+
+Part of the [pinky-and-co](https://github.com/pinky-and-co) suite.
+
+<!-- pinky:readme-tagline:end -->
+
+______________________________________________________________________
+
+## Why pinky?
+
+<!-- pinky:readme-why:start -->
+
+The modern data stack was built on a good idea — **best of breed**. One tool for ingestion, one for transformation, one for orchestration, one for observability.
+
+The reality: more licenses, same delivery time, and most of your energy goes into *the glue*.
+
+Snowflake collapsed the stack. **Pinky makes it operational.**
+
+Do it right, and the credits follow.
+
+**Rationalized costs · Pure Python · Snowflake Native First**
+
+<!-- pinky:readme-why:end -->
+
+______________________________________________________________________
+
+## Install
+
+```bash
+pip install pinky-core
+pip install "pinky-core[validate]"   # with SIRET, IBAN, email, phone validators
+pip install "pinky-core[address]"    # with address parsing
+```
+
+______________________________________________________________________
+
+## Documentation
+
+<!-- pinky:readme-docs:start -->
+
+**Explanation**
+
+- [Design](docs/explanation/1-design.md)
+- [Features](docs/explanation/2-features.md)
+
+**API reference**
+
+- [Generated API docs](docs/reference/api/)
+
+**Decisions**
+
+- [ADRs](docs/adr/)
+
+**Structure**
+
+<details>
+<summary>Show the directory tree</summary>
+
+```text
+pinky-core/
+├── .github/
+│   └── workflows/
+│       ├── ci.yml
+│       ├── publish.yml
+│       └── release.yml
+├── scripts/
+│   ├── hooks/
+│   │   ├── badges.toml
+│   │   ├── check_forbidden_keywords.py
+│   │   ├── check_snowpark_api.py
+│   │   ├── check_typed_api.py
+│   │   ├── check_zws.py
+│   │   ├── commit-msg
+│   │   ├── docs_identity.json
+│   │   ├── generate-docs
+│   │   ├── generate_ci_badges.py
+│   │   └── render_docs.py
+│   └── deploy_validate_udfs.py
+├── sql/
+│   └── deploy_udf_example.sql
+├── src/
+│   └── pinky_core/
+│       ├── finance/
+│       │   ├── __init__.py
+│       │   └── fec.py
+│       ├── __init__.py
+│       ├── files.py
+│       ├── fmt.py
+│       ├── html.py
+│       ├── lint.py
+│       ├── schedule.py
+│       ├── security.py
+│       ├── sql.py
+│       ├── validate.py
+│       ├── warnings.py
+│       └── xml.py
+├── tests/
+│   ├── fixtures/
+│   │   └── cats_domination.xml
+│   ├── __init__.py
+│   ├── test_fec.py
+│   ├── test_files.py
+│   ├── test_fmt.py
+│   ├── test_html.py
+│   ├── test_lint.py
+│   ├── test_schedule.py
+│   ├── test_security.py
+│   ├── test_sql.py
+│   ├── test_validate.py
+│   ├── test_warnings.py
+│   └── test_xml_xpath.py
+├── .gitignore
+├── .gitleaks.toml
+├── .pre-commit-config.yaml
+├── .secrets.baseline
+├── LICENSE
+├── pyproject.toml
+└── README.md
+```
+
+</details>
+
+<!-- pinky:readme-docs:end -->
+
+______________________________________________________________________
+
+## License
+
+<!-- pinky:readme-license:start -->
+
+MIT — see [LICENSE](LICENSE).
+
+<!-- pinky:readme-license:end -->