Metadata-Version: 2.4
Name: pinky-core
Version: 0.1.0.dev5
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: 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
├── .vscode/
│   └── settings.json
├── scripts/
│   ├── hooks/
│   │   ├── badges.toml
│   │   ├── check_forbidden_keywords.py
│   │   ├── check_snowpark_api.py
│   │   ├── check_typed_api.py
│   │   ├── check_weak_assertions.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/
│   │   ├── golden/
│   │   │   ├── dl_card_basic.html
│   │   │   ├── dl_card_expiry.html
│   │   │   ├── generate_html_basic.html
│   │   │   ├── task_table_error.html
│   │   │   ├── task_table_no_snowsight.html
│   │   │   └── task_table_snowsight.html
│   │   └── cats_domination.xml
│   ├── __init__.py
│   ├── test_fec.py
│   ├── test_files.py
│   ├── test_fmt.py
│   ├── test_html.py
│   ├── test_lint.py
│   ├── test_public_api.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
├── .python-version
├── .secrets.baseline
├── CONTEXT.md
├── LICENSE
├── pyproject.toml
├── README.md
└── uv.lock
```

</details>

<!-- pinky:readme-docs:end -->

______________________________________________________________________

## License

<!-- pinky:readme-license:start -->

MIT — see [LICENSE](LICENSE).

<!-- pinky:readme-license:end -->
