mitra-sdk 0.1.0__tar.gz

mitra_sdk-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+.env
+.env.*
+!.env.example
+node_modules/
+dist/
+build/
+__pycache__/
+*.egg-info/
+.venv/
+.DS_Store
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+*.sqlite
+*.sqlite3
+*.db
+.idea/
+.vscode/
+sdks/typescript/src/schema.d.ts
+

mitra_sdk-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Matih Labs
+
+   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.

mitra_sdk-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+Matih SDKs and tools
+Copyright 2026 Matih Labs
+
+This product includes software developed at Matih Labs (https://matih.ai).
+Licensed under the Apache License, Version 2.0.

mitra_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.5
+Name: mitra-sdk
+Version: 0.1.0
+Summary: Python client for the Matih public API (ask, Gems, dashboards, forecasts).
+Project-URL: Homepage, https://github.com/matih-labs/mitra-sdk
+Project-URL: Source, https://github.com/matih-labs/mitra-sdk
+Project-URL: Issues, https://github.com/matih-labs/mitra-sdk/issues
+Author: Matih Labs
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: analytics,api,matih,mcp,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.6
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<p align="center"><img src="https://raw.githubusercontent.com/matih-labs/mitra-sdk/main/assets/matih-logo.png" alt="Matih" width="160"></p>
+
+# mitra-sdk (Python)
+
+Python client for the Matih public API. Sync (`Mitra`) and async (`AsyncMitra`) clients on
+[httpx](https://www.python-httpx.org/), pydantic v2 models for the main response shapes, SSE
+streaming, background-job polling and webhook signature verification.
+
+> Pre-release (0.1.0): the package is not on PyPI until `/api/v1` is live for every workspace. Install from a checkout with
+> `pip install -e sdks/python`.
+
+```bash
+pip install mitra-sdk        # once released
+```
+
+Python 3.10+. The package imports as `mitra`.
+
+Full documentation: [matih.ai/docs/api](https://matih.ai/docs/api/overview), with the [SDK reference](https://matih.ai/docs/api/sdk/python).
+
+## Authenticate
+
+```python
+from mitra import Mitra
+
+client = Mitra(api_key="mtk_...")            # or set MATIH_API_KEY
+client = Mitra(access_token="mto_...", workspace_id="ws_123")  # OAuth token
+```
+
+API keys are pinned to one workspace. OAuth tokens pick a workspace per client with
+`workspace_id=` (sent as `X-Matih-Workspace`) or per call, or set a default with
+`client.workspaces.use(workspace_id)`. Keep keys in environment variables, never in source.
+
+Admins create keys under `Settings › API & MCP`, choose the products the key may use (all on by default) and revoke keys in the same screen. Keys never expire by default. Use an API key here; an MCP connector key works only on `/api/v1/mcp`. Scopes: `workspaces:read`, `members:read`, `members:manage`, `sources:read`, `sources:write`, `files:read`, `files:write`, `gems:read`, `gems:generate`, `ask`, `dashboards:read`, `predict`, `embeds:create`, `embeds:read`, `webhooks:manage`.
+
+## Ask
+
+```python
+answer = client.ask("What were last month's sales by region?", language="en-IN")
+
+if answer.status == "answered":
+    print(answer.answer)
+    for row in answer.result.rows:
+        print(row)
+    if answer.image_url:
+        open("chart.png", "wb").write(client.download_image(answer.image_url))
+elif answer.status == "clarification":
+    print(answer.clarification.question, answer.clarification.options)
+    # reply in the same conversation
+    answer = client.ask(answer.clarification.options[0], conversation_id=answer.conversation_id)
+
+follow_up = client.ask(answer.follow_ups[0], conversation_id=answer.conversation_id)
+```
+
+Questions may be in any of 22 Indian languages and are auto-detected; pass `language="hi-IN"` to
+force the response language. Data values, column names and figures are never translated.
+
+Voice notes: `answer = client.ask_audio("note.ogg", language="hi-IN")`; `answer.heard` holds the
+transcript and detected language.
+
+### Streaming
+
+```python
+for event in client.ask_stream("Top 5 products by revenue"):
+    if event.event == "progress":
+        print("...", event.data)
+    elif event.event == "answer":
+        answer = event.as_answer()
+    elif event.event == "error":
+        raise RuntimeError(event.data)
+```
+
+## Gems, dashboards, forecasts
+
+```python
+gems = client.gems.list(source_id="src_1")
+png = client.gems.image(gems.gems[0].id)                  # bytes
+
+job = client.gems.generate("src_1")                        # waits, returns the finished Job
+job = client.gems.generate("src_1", background=True)       # returns the queued Job at once
+job = client.jobs.wait(job, 600)                           # poll it later
+
+dashboards = client.dashboards.list()
+png = client.dashboards.render(dashboards.dashboards[0].id)   # job + wait + download
+
+job = client.predictions.create("Forecast next quarter's revenue", source_id="src_1")
+print(job.result["answer"], job.result.get("attachments"))
+```
+
+`jobs.wait(job, timeout=1860, poll_interval=1.0, max_poll_interval=15.0, on_update=fn)` raises
+`JobTimeoutError` (the job keeps running) or `JobFailedError` (failed or cancelled). Predictions
+can take up to 30 minutes. `ask` and `predictions.create` send an `Idempotency-Key` automatically
+and reuse it across retries, so a retry is never charged twice (the server honours the key on
+these two calls only). Pass `idempotency_key=` to control it.
+
+## Sources and files
+
+```python
+client.sources.list()
+client.sources.get("src_1")                               # includes readiness
+client.sources.connectors()
+client.sources.test({"connector_type": "postgres", "display_name": "Orders DB", "host": "...", "database": "..."})
+try:
+    client.sources.create({...}, activate=True)           # admin, sources:write
+except SourceTestFailedError as e:                        # HTTP 422
+    print(e.test_result)
+client.sources.activate("src_1"); client.sources.delete("src_1")
+
+# files: files:read to list and get; files:write to upload, answer a duplicate prompt and delete
+f = client.files.upload("sales.csv", on_duplicate="ask")         # CSV or Excel; "ask" (default) or "keep_both"
+client.files.get(f.id)          # status, decision_required, decision_options
+client.files.duplicate(f.id, "use_existing")              # answer a duplicate prompt: use_existing, keep_both or cancel
+client.files.list(); client.files.delete(f.id)
+```
+
+## Members and invitations
+
+Needs `members:read` / `members:manage`; only do these when a person asked for them.
+
+```python
+client.members.list()
+client.invitations.create("user", email="new@example.com")   # or phone="+91..."
+client.invitations.list(); client.invitations.revoke("inv_1")
+client.members.update("mem_1", "admin"); client.members.remove("mem_1")
+```
+
+## Embeds
+
+Show a dashboard (with per-viewer row filters) or a Gems feed inside your own product. Needs
+`embeds:create` (mint, revoke) or `embeds:read` (list). Call it from your backend: the API key
+never goes to the browser. The browser gets only the short-lived token, through the
+`<matih-embed>` element (`@matihlabs/embed`, see `sdks/embed/`).
+
+```python
+embed = client.embeds.create(
+    resource={"type": "dashboard", "id": "d_123"},   # or {"type": "gems", "id": "<source id>"}
+    filters={"customer_id": "C123"},                  # exactly the dashboard's embed parameters; none for Gems
+    origins=["https://app.customer.com"],             # 1 to 10 exact origins that may frame the page
+    ttl_seconds=300,                                  # 60 to 900, default 300; never renewed, mint again
+)
+embed.src     # the iframe URL without the token (keeps ?e=emt_...)
+embed.token   # met_..., a secret; left out of repr
+embed.id      # emt_..., not secret: pass it to revoke
+
+client.embeds.list()            # tokens minted by this key (never the secret or filter values)
+client.embeds.revoke(embed.id)  # 204, idempotent, returns None
+```
+
+Minting is not idempotent (every call mints) and is never retried after a 5xx. A refusal raises
+`EmbedRefusedError` (422) with `.code` one of `missing_parameter`, `unknown_parameter`,
+`invalid_value`, `invalid_origin`, `filters_not_supported` (Gems cannot be filtered),
+`no_embed_parameters`; an unknown or unreadable dashboard or source raises `EmbedNotFoundError`
+(404); a role that no longer allows it is a `PermissionDeniedError` (403). `AsyncMitra` is the
+same with `await`.
+
+## Webhooks
+
+```python
+hook = client.webhooks.create("https://example.com/hooks/matih", ["prediction.completed"])
+print(hook.secret)   # whsec_..., shown once
+client.webhooks.test(hook.id); client.webhooks.deliveries(hook.id)
+
+# Deliveries carry Matih-Signature, Matih-Event and Matih-Delivery headers.
+
+# In your web handler, with the RAW request body:
+from mitra import verify_webhook
+if not verify_webhook(secret, request.headers["Matih-Signature"], raw_body):  # constant-time
+    return 400
+# assert_webhook(...) is the same check but raises WebhookVerificationError with the reason.
+```
+
+## Sync vs async
+
+Two independent choices: the client (`Mitra` blocks the thread, `AsyncMitra` is awaited) and the
+mode of each long call (wait for the result, or get a job back and come back later). Both
+clients have the same methods, including members, sources, files, webhooks, voice and jobs.
+
+Every long call (`gems.generate`, `predictions.create`, `dashboards.image`, `sources.create`,
+`files.upload`) takes:
+
+- `wait=` seconds (default 10 minutes for Gems, 5 for images, sources and files, 31 for
+  predictions). The SDK sends `Prefer: wait=N` (the server honours at most 60 s for jobs, 120 s
+  for sources and files) and keeps polling until the result is final or `wait` runs out.
+    - Job calls (`gems.generate`, `predictions.create`, `dashboards.image`) poll the job. Running
+      out raises `JobTimeoutError`; the job keeps running.
+    - Resource calls (`sources.create`, `files.upload`) poll the source or the file. Running out
+      raises nothing: you get the source or file as it stands (for example `phase: building`), so
+      check `readiness.can_ask` or `status`.
+- `background=True` to return right away: the queued `Job`, or for `sources.create` and
+  `files.upload` whatever the server answered. No `Prefer: wait` is sent.
+
+```python
+job = client.predictions.create("Forecast Q4", wait=900)               # blocks, finished Job
+job = client.predictions.create("Forecast Q4", background=True)        # returns immediately
+job = client.jobs.wait(job.id, 900)                                    # later, or from another process
+
+queued = client.ask("Top customers this year", background=True)        # Prefer: respond-async
+done = client.jobs.wait(queued.id, 120)
+answer = done.as_answer()                                              # the Answer held in job.result
+```
+
+Without `background=True`, `ask` answers in one call. `predictions.run` and
+`dashboards.render` are shortcuts for the waiting form (`render` also downloads the PNG).
+
+## Async
+
+```python
+import asyncio
+from mitra import AsyncMitra
+
+async def main():
+    async with AsyncMitra(api_key="mtk_...") as client:
+        answer = await client.ask("How many orders today?")
+        job = await client.predictions.create("Forecast Q4", background=True)
+        job = await client.jobs.wait(job.id, 900)
+        async for event in client.ask_stream("Top customers"):
+            print(event.event)
+
+asyncio.run(main())
+```
+
+## Errors
+
+All API errors derive from `MitraError` with `.status`, `.category`, `.code`, `.request_id` and
+`.body`. Subclasses: `AuthError` (401), `PermissionDeniedError` (403: `scope`, `workspace_role`,
+`source_access`), `CreditsError` (402: `not_ready`, `member_cap`), `BusyError` (409, a conflict with the current state),
+`RateLimitError` (429, `.retry_after`), `EmbedRefusedError` (422 from `embeds.create`, read `.code`), `EmbedNotFoundError` (404 from `embeds.create` and `embeds.revoke`), `SourceTestFailedError` (422 from `sources.create`, `.test_result`), plus `JobFailedError`, `JobTimeoutError`. 429 is retried
+automatically (honouring `Retry-After`) up to `max_retries` (default 2), as are 5xx and network
+errors on GETs and on calls with an idempotency key.
+
+## Models
+
+`mitra.models` holds pydantic models for the main shapes (`Answer`, `Job`, `Gem`, `Workspace`, ...).
+They accept unknown fields, so new server fields never break old clients. See
+[`scripts/README.md`](scripts/README.md) for generating models from the OpenAPI spec.
+
+## Develop
+
+```bash
+pip install -e "sdks/python[dev]"
+pytest && ruff check .
+```
+
+License: Apache-2.0.