telmai 0.2.0__tar.gz

telmai-0.2.0/.gitignore

@@ -0,0 +1,53 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+# Credentials. Never commit a Telmai API key; the SDK reads it from the
+# environment precisely so it does not need to live in a file.
+.env
+.env.*
+*.env
+.envrc
+secrets/
+# ...but the template must be committable, or a new contributor has no way to
+# know which variables to set. Negation has to follow the patterns above.
+!.env.example
+
+# Coverage output embeds absolute developer paths.
+.coverage
+.coverage.*
+htmlcov/
+
+# Credential shapes, for a repo whose whole job is handling one.
+*.pem
+*.key
+*.p12
+credentials.json
+service-account*.json
+*-key.json
+secrets.y*ml
+.direnv/
+
+# Credential files the tooling this repo recommends will actually create.
+# `.pypirc` is the sharpest: twine is a dev dependency, the release docs walk a
+# maintainer through publishing, and a PyPI token sits in it in cleartext.
+.pypirc
+.databrickscfg
+.netrc
+_netrc
+id_rsa
+id_ed25519
+*.tfvars
+*.tfstate
+*.jks
+*.pfx
+
+# Editor and OS noise.
+.DS_Store
+.idea/
+.vscode/

telmai-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   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,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this 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.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   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, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this 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 consequential 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 any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional 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 act 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

telmai-0.2.0/NOTICE

@@ -0,0 +1,7 @@
+Telmai Python SDK
+Copyright 2026 Telmai, Inc.
+
+This product includes software developed at Telmai, Inc.
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file for the
+full license text.

telmai-0.2.0/PKG-INFO

@@ -0,0 +1,295 @@
+Metadata-Version: 2.5
+Name: telmai
+Version: 0.2.0
+Summary: Python SDK for gating pipelines on Telmai data quality scans
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: circuit breaker,data observability,data quality,databricks,telmai
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.32
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: pyyaml; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# telmai
+
+Python SDK for gating data pipelines on Telmai data quality scans.
+
+> **Pre-release.** Not published to PyPI yet, so `pip install telmai` does not
+> work. Install from source — see [Getting set up](#getting-set-up). The first
+> published version will be `0.2.0`.
+
+## Why this exists
+
+Telmai finds quality problems. It cannot act on them, because the moment that
+matters is inside someone else's pipeline: the step between writing a batch and
+publishing it. No API call can fail a customer's Databricks task or skip their
+Airflow step. That has to be code running in their job.
+
+Customers who want that today write their own HTTP client. Asking "did this
+batch pass?" is four calls, a state machine, and five failure modes that all
+have to resolve the same way. Getting it wrong is easy and the consequences are
+asymmetric, so this ships it once, correctly.
+
+```python
+from telmai import CircuitBreakerTripped, Severity, Telmai
+
+tm = Telmai.from_env()  # TELMAI_HOST / TELMAI_TENANT / TELMAI_API_KEY
+tm.circuit_breaker("a1b2c3d4e5f6")  # raises if the batch is not clean
+```
+
+## Getting set up
+
+```bash
+git clone https://github.com/Telmai/telmai-python.git && cd telmai-python
+python3 -m venv .venv && ./.venv/bin/pip install -e ".[dev]"
+```
+
+Every command below uses `./.venv/bin/...` explicitly, so nothing depends on
+whether the venv is activated.
+
+Three environment variables, and nothing else:
+
+| | |
+|---|---|
+| `TELMAI_HOST` | bare hostname, no scheme — `your-tenant.telm.ai` |
+| `TELMAI_TENANT` | the tenant id, the opaque string in your Telmai URL |
+| `TELMAI_API_KEY` | from your secret store, never from a file in a repo |
+
+[`.env.example`](.env.example) documents these three plus `TELMAI_LIVE`, and is
+the fastest local setup. Nothing auto-loads it — the SDK reads the environment,
+not a file — so source it yourself:
+
+```bash
+cp .env.example .env        # then fill in TELMAI_API_KEY
+set -a && source .env && set +a
+```
+
+`.env` is gitignored. `.env.example` deliberately leaves `TELMAI_API_KEY`
+commented out rather than empty, so sourcing a half-filled file cannot export an
+empty string over a key that was already working in your shell.
+
+Python 3.9 or newer. CI runs 3.9 through 3.13. The floor is 3.9 rather than
+something more modern because Databricks and Airflow runtimes lag, and those
+are the two places this code actually runs.
+
+## Assets are addressed by id
+
+Always ids, never table names. Two tables in one project can both be called
+`orders`; only the id is unique, and it survives a rename in Telmai while your
+pipeline code stays put. Passing a name where an id belongs is rejected before
+any scan is triggered.
+
+Look the id up once, out of band, and put it in your job config:
+
+```bash
+python -m telmai resolve gold.orders    # prints the id, then exits
+```
+
+There is a `tm.resolve(name)` for scripts that must do it at runtime, but a
+pipeline that runs every day should not be paying for a lookup — or risking an
+ambiguous one — on every run.
+
+## Three ways to act on a scan
+
+One scan underneath, three responses to its result.
+
+**Circuit Breaker.** Stop the pipeline. Wire it between the write step and the
+promote step, so a failure skips everything downstream.
+
+```python
+tm.circuit_breaker(ORDERS)
+tm.circuit_breaker([ORDERS, CLAIMS], min_severity=Severity.MEDIUM)
+```
+
+**Quarantine.** Keep running, route the bad records aside. Needs Data Binning
+configured on the asset — see `tm.binning`.
+
+```python
+for r in tm.quarantine([ORDERS, CLAIMS]):
+    if not r.clean:
+        if r.fully_isolated:
+            move_flagged_rows(r.location.incorrect_data_path)
+        else:
+            hold_entire_batch(r.label)  # binning covers only some monitors
+```
+
+**Live Pass Through.** Get told, without the gate deciding for you. For
+pipelines that must run regardless of what the scan finds.
+
+```python
+tm.live_pass_through(ORDERS, on_result=lambda v: notify(v) if not v.passed else None)
+```
+
+It waits for the scan to finish, same as the other two, then calls back with the
+verdict — it does not run alongside your pipeline. What it gives you over
+`circuit_breaker` is that it never raises for a quality result, so nothing
+downstream is skipped.
+
+## Fail closed, by contract
+
+Every path that cannot confirm a clean result blocks: a scan that fails or times
+out, a severity we cannot read, an alert type meaning the scan never read the
+table, an asset with no monitors. A gate that reports success on bad data is
+worse than no gate, because the pipeline then certifies the batch.
+
+Four consequences worth knowing before reading the code:
+
+- **A typo raises, it does not become a verdict.** An unresolvable or ambiguous
+  asset id fails the whole batch before anything is scanned. A typo should not
+  look like a data problem.
+- **`CircuitBreakerTripped` is not a `TelmaiError`.** A blocked batch is a
+  correct decision, not an API failure, so `except TelmaiError: retry` cannot
+  silently retry past it.
+- **A severity we cannot read blocks.** If Telmai adds a tier above `HIGH`
+  tomorrow, an SDK that predates it treats that alert as unrankable and stops
+  the pipeline, rather than reading an unfamiliar value as harmless.
+- **"Blocked" and "bad data" are different things.** A scan that could not read
+  the table blocks too, and says so separately. `passed` decides whether the
+  pipeline continues; `blocked_by_quality` decides what you tell someone. The
+  CLI splits them as exit `2` versus exit `1`.
+
+```python
+try:
+    tm.circuit_breaker([ORDERS, CLAIMS])
+except CircuitBreakerTripped as e:
+    for v in e.failed:  # every failure, not just the first
+        log.error("%s: %s", v.label, [a.policy_name for a in v.blocking_alerts])
+    raise
+```
+
+## Everything else
+
+Nine namespaces, mirroring what you are working on:
+
+```python
+tm.connections.create({...})  # connect a warehouse
+tm.connections.test(conn_id, {...})  # check it can still reach the source
+
+tm.assets.create(project_id, {...})
+tm.assets.detect_columns(ORDERS)  # async; poll with tm.jobs.wait()
+tm.assets.set_monitored_columns(ORDERS, {...})
+
+tm.monitors.create(ORDERS, {...})
+tm.monitors.set_enabled(ORDERS, monitor_id, False)
+tm.monitors.export(ORDERS)  # monitors as code, with import_()
+
+job_id, status = tm.scans.run(ORDERS, wait=True)
+tm.scans.cancel(ORDERS, job_id)  # abandoning a scan does not stop it
+
+tm.alerts.for_scan(ORDERS, job_id)
+tm.jobs.wait(ORDERS, job_id)
+tm.incidents.list()
+tm.dq_score.get(ORDERS)
+tm.binning.set(ORDERS, {...})  # where quarantine routes bad rows
+```
+
+Below those, `tm._api` carries the generated operations — every customer-facing
+route in Telmai's OpenAPI spec, so a missing wrapper is never a dead end. It is
+not the whole platform: `tools/generate.py` filters out `/internal` and `/admin`
+routes plus the tag areas in its `EXCLUDE_TAGS` set, which serve the web app or
+are configured in the product, auth among them. The names there come from the platform's own
+`operationId`s, so they are faithful rather than pretty — creating a connection
+is `tm._api.get_connection_4()`. See [docs/versioning.md](docs/versioning.md)
+for why it is underscored and what that means for upgrades.
+
+## Runnable examples
+
+Nine scripts under [`examples/`](examples/README.md), covering all twenty
+features, with a table of which ones cost compute. Start with the read-only one,
+which prints the asset ids the rest need:
+
+```bash
+./.venv/bin/python examples/01_find_your_assets.py
+```
+
+Anything that costs compute asks first. Anything that writes configuration is a
+dry run until you pass `--commit`.
+
+## Developing
+
+```bash
+./.venv/bin/pytest -q                          # offline, no network, under a second
+./.venv/bin/ruff check . && ./.venv/bin/ruff format --check .
+./.venv/bin/mypy                               # strict
+./.venv/bin/python tools/generate.py --check   # generated layer is current
+```
+
+`mypy` takes no argument on purpose: it is configured to check the package.
+`mypy .` would also walk the tests and the Airflow recipe, which imports a
+package the SDK does not depend on, and it reports several hundred errors that
+are not defects. Widening strict typing to the test suite is real work, not a
+config flag.
+
+**Never hand-edit `telmai/_generated/`.** Fix `tools/generate.py` and
+regenerate. Any tool that generates code here runs the real linter and formatter
+on its own output rather than reimplementing their rules — that bit us twice.
+
+### The live suite
+
+`tests/live/` creates and deletes real objects on a real tenant. It is excluded
+from the default run and opts in by naming the tenant twice, which is what stops
+a stray environment variable pointing destructive tests somewhere unintended:
+
+```bash
+export TELMAI_LIVE=$TELMAI_TENANT
+./.venv/bin/pytest tests/live -m "not costly"   # free
+./.venv/bin/pytest tests/live -m costly         # triggers real scans, spends compute
+```
+
+Nothing pre-existing is ever deleted: cleanup only removes ids the run itself
+recorded. Read `tests/live/conftest.py` before changing it.
+
+It earns its keep. Two bugs no offline test could have found: `iter_detailed`
+looped forever on a real first page, and `alerts.counts()` could never have
+worked because a required query parameter was generated as optional.
+
+## Where it stands
+
+Pre-release. All three gate modes are built and validated end to end against a
+live tenant, not just against fakes. Real alert payloads captured from that
+tenant are checked against our enums in `tests/test_contract.py`, which found
+defects no offline test could — including a severity tier the platform does not
+emit, and an alert type we were reporting as bad data when it actually meant the
+scan could not run.
+
+The offline suite runs in under a second and is the specification, not a safety
+net: `tests/test_fail_closed.py` encodes decisions that look like
+over-engineering and are not. `mypy --strict` and `ruff` are clean, and the
+wheel ships `py.typed`, verified reaching a consumer's own type checker.
+
+Known gaps and open questions are in [TODO.md](TODO.md). If you are picking this
+up, start with [HANDOFF.md](HANDOFF.md).
+
+## More
+
+- [HANDOFF.md](HANDOFF.md) — where the project is and what to do next
+- [ARCHITECTURE.md](ARCHITECTURE.md) — how it fits together, and the platform
+  contract read off platform source because the public docs disagree in places
+- [docs/versioning.md](docs/versioning.md) — what you can rely on across
+  versions, and the release process
+- [docs/phase1-features.md](docs/phase1-features.md) — the twenty features and
+  the endpoint behind each
+- [recipes/databricks/](recipes/databricks/) — notebook, job wiring, and where
+  the halt comes from
+- [recipes/airflow/](recipes/airflow/) — operator
+- [CONTRIBUTING.md](CONTRIBUTING.md) — the one rule, and what not to tidy