tha-snowflake-runner 0.1.0__tar.gz

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

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev --python ${{ matrix.python-version }}
+
+      - name: Lint
+        run: uv run ruff check src/ tests/
+
+      - name: Test
+        run: uv run pytest
+
+      - name: Type check
+        run: uv run mypy src/

tha_snowflake_runner-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,53 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+      - name: Build
+        run: uv build
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    needs: publish-testpypi
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

tha_snowflake_runner-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# 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
+
+# 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/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

tha_snowflake_runner-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nathan Wright
+
+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.

tha_snowflake_runner-0.1.0/PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.4
+Name: tha-snowflake-runner
+Version: 0.1.0
+Summary: A Tabular Helper API library that wraps snowflake-connector-python with typed connection management, multi-format profile support, and a normalized query return shape.
+Project-URL: Homepage, https://github.com/tha-guy-nate/tha-snowflake-runner
+Project-URL: Issues, https://github.com/tha-guy-nate/tha-snowflake-runner/issues
+Author: Nate Wright
+License: MIT
+License-File: LICENSE
+Keywords: connector,helper,snowflake,sql,tabular,warehouse
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: snowflake-connector-python>=3.6
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# tha-snowflake-runner
+
+[![CI](https://github.com/tha-guy-nate/tha-snowflake-runner/actions/workflows/ci.yml/badge.svg)](https://github.com/tha-guy-nate/tha-snowflake-runner/actions/workflows/ci.yml)
+
+A Tabular Helper API library that wraps snowflake-connector-python with typed connection management, multi-format profile support, and a normalized query return shape.
+
+## Install
+
+```bash
+pip install tha-snowflake-runner
+```
+
+## Quick start
+
+```python
+from tha_snowflake_runner import ThaSnowflake
+
+sf = ThaSnowflake(role="ANALYST", warehouse="COMPUTE_WH", database="PROD", schema="PUBLIC")
+
+# inline SQL
+result = sf.query("SELECT id, name FROM users WHERE active = %s", params=(True,))
+# {"rows": [{"ID": "u1", "NAME": "Alice"}], "rowcount": 1, "status": None}
+
+# or load SQL from a file
+result = sf.query(file="queries/users.sql", params=(True,))
+```
+
+## Connection modes
+
+### Mode 1 — native connections.toml (default)
+
+Delegates profile lookup to the connector, which reads `~/.snowflake/connections.toml` (or the path in `SNOWFLAKE_HOME`).
+
+```python
+sf = ThaSnowflake(role="ANALYST", warehouse="WH")
+
+# Named profile
+sf = ThaSnowflake(connection_name="prod", role="ANALYST", warehouse="WH")
+```
+
+### Mode 2 — custom connections file
+
+Pass any `.toml`, `.ini`/`.cfg`, or `.json` file. Both flat (`[profile]`) and nested (`[connections.profile]`) TOML styles are supported.
+
+```python
+sf = ThaSnowflake(
+    connections_file="~/my_connections.toml",
+    connection_name="prod",
+    role="ANALYST",
+    warehouse="WH",
+)
+
+# List available profile names from the file
+names = sf.list_profiles()  # ["default", "prod", "dev"]
+
+# Module-level convenience — no ThaSnowflake instance needed
+from tha_snowflake_runner import list_profiles
+names = list_profiles("~/my_connections.toml")
+```
+
+### Mode 3 — inline (no file)
+
+Supply all connection parameters directly. `account` being set triggers inline mode.
+
+```python
+# Okta SSO — opens a browser window
+sf = ThaSnowflake(account="myorg", user="me@example.com", authenticator="externalbrowser")
+
+# Password (service accounts)
+sf = ThaSnowflake(account="myorg", user="svc@example.com", password="secret")
+
+# Key-pair
+sf = ThaSnowflake(
+    account="myorg",
+    user="svc@example.com",
+    private_key_file="~/keys/rsa_key.p8",
+    private_key_passphrase="mypass",
+)
+
+# OAuth token
+sf = ThaSnowflake(account="myorg", authenticator="oauth", token="...")
+```
+
+Pass `quiet_connect=True` to suppress connector stdout (e.g. the `externalbrowser` browser-open message).
+
+## Query return shape
+
+Every `query()` call returns a normalized dict:
+
+```python
+result = sf.query("SELECT * FROM orders WHERE id = %s", params=("o1",))
+# {
+#   "rows": [{"ID": "o1", "TOTAL": 99.0}],
+#   "rowcount": 1,
+#   "status": None,        # None on success, error string on Snowflake query failure
+# }
+```
+
+`sf.rows` always holds the result of the most recent query (thread-local).
+
+## Session — multiple queries on one connection
+
+```python
+with sf.session(role="ANALYST", warehouse="WH") as sess:
+    users = sess.query("SELECT * FROM users")
+    orders = sess.query("SELECT * FROM orders")
+    # one connection opened, two queries run, connection closed on exit
+```
+
+Pass `accumulate=True` to append rows across queries into `sess.rows`:
+
+```python
+with sf.session(accumulate=True) as sess:
+    sess.query("SELECT * FROM users WHERE region = 'US'")
+    sess.query("SELECT * FROM users WHERE region = 'EU'")
+    all_users = sess.rows  # combined result from both queries
+```
+
+The return value of each `sess.query()` is always the current query's result only — `sess.rows` is the accumulation point.
+
+## Threading
+
+`sf.rows` is thread-local — each thread sees only its own query results. For concurrent workloads, open a `Session` inside each worker:
+
+```python
+from concurrent.futures import ThreadPoolExecutor
+
+def worker(sql):
+    with sf.session() as sess:
+        return sess.query(sql)
+
+with ThreadPoolExecutor(max_workers=4) as pool:
+    results = list(pool.map(worker, queries))
+```
+
+## Retry
+
+```python
+sf = ThaSnowflake(
+    account="myorg",
+    retry_connect=3,         # up to 3 retries (4 total attempts)
+    retry_on=(OSError,),     # only retry on these exception types
+    retry_delay=2.0,         # seconds between attempts
+    status_cb=print,         # called with a message on each failed attempt
+)
+```
+
+## API
+
+### `ThaSnowflake(*, ...)`
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `connection_name` | `str` | `"default"` | Profile name for Mode 1/2 |
+| `connections_file` | `str \| None` | `None` | Path to custom connections file (Mode 2) |
+| `account` | `str \| None` | `None` | Snowflake account identifier (Mode 3) |
+| `user` | `str \| None` | `None` | Username (Mode 3) |
+| `authenticator` | `str \| None` | `None` | `"externalbrowser"`, `"oauth"`, etc. |
+| `password` | `str \| None` | `None` | Password auth (Mode 3) |
+| `private_key_file` | `str \| None` | `None` | Path to `.p8` key file; `~` is expanded |
+| `private_key_passphrase` | `str \| None` | `None` | Passphrase for encrypted private key |
+| `token` | `str \| None` | `None` | OAuth token (Mode 3) |
+| `role` | `str \| None` | `None` | Default Snowflake role |
+| `warehouse` | `str \| None` | `None` | Default warehouse |
+| `database` | `str \| None` | `None` | Default database |
+| `schema` | `str \| None` | `None` | Default schema |
+| `quiet_connect` | `bool` | `False` | Suppress connector stdout on connect |
+| `status_cb` | `callable \| None` | `None` | Called with status strings (retry messages, etc.) |
+| `mode` | `str` | `"app"` | Reserved — `"app"` or `"cli"` |
+| `retry_connect` | `int` | `0` | Number of reconnect retries on failure |
+| `retry_on` | `type \| tuple` | `()` | Exception types that trigger a retry |
+| `retry_delay` | `float` | `1.0` | Seconds to wait between retry attempts |
+
+### Methods
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `set_context(*, role, warehouse, database, schema)` | `None` | Update default context; only non-`None` values are applied |
+| `build_connect_kwargs(*, role, warehouse, database, schema)` | `dict` | Return kwargs that would be passed to `snowflake.connector.connect` — useful for debugging |
+| `connect(**kwargs)` | `SnowflakeConnection` | Open and return a raw connection |
+| `connection(**kwargs)` | context manager | Open a connection, close it on exit |
+| `session(*, accumulate=False, **kwargs)` | context manager → `Session` | Open a `Session` backed by one connection |
+| `query(sql=None, *, file=None, params, conn, role, warehouse, database, schema)` | `dict` | Execute a SELECT; pass `sql` or `file=` (not both); returns `{"rows", "rowcount", "status"}` |
+| `list_profiles()` | `list[str]` | Profile names from `connections_file` (requires Mode 2) |
+
+### `Session`
+
+Obtain via `sf.session()`. Not thread-safe — one `Session` per thread.
+
+| Member | Description |
+|--------|-------------|
+| `query(sql=None, *, file=None, params)` | Execute a SELECT on the persistent connection; pass `sql` or `file=` (not both); returns `{"rows", "rowcount", "status"}` |
+| `rows` | Running result — latest query only when `accumulate=False` (default), all queries combined when `accumulate=True` |
+| `close()` | Close the underlying connection |
+
+### `list_profiles(path)` — module-level
+
+```python
+from tha_snowflake_runner import list_profiles
+
+names = list_profiles("~/connections.toml")  # ["default", "prod", "dev"]
+```
+
+Supports the same formats as Mode 2: `.toml`, `.ini`, `.cfg`, `.json`.
+
+## Alternatives
+
+- **[snowflake-connector-python](https://docs.snowflake.com/en/developer-guide/python-connector/python-connector)** — the official Snowflake connector; `tha-snowflake-runner` is a thin typed convenience layer on top of it
+- **[snowflake-sqlalchemy](https://docs.snowflake.com/en/developer-guide/python-connector/sqlalchemy)** — SQLAlchemy dialect for Snowflake with ORM support
+- **[snowpark-python](https://docs.snowflake.com/en/developer-guide/snowpark/python/index)** — Snowflake's DataFrame/ML API for in-warehouse computation
+
+`tha-snowflake-runner` is intentionally narrow: no ORM, no Snowpark, no async — just a thin typed wrapper for common query patterns and connection-file management.
+
+## License
+
+MIT