Metadata-Version: 2.4
Name: insyte
Version: 0.2.19
Summary: Local-first AI analytics for PostgreSQL — natural-language questions, validated read-only SQL, credentials never exposed to the model.
Project-URL: Homepage, https://github.com/insyte-ai/insyte
Project-URL: Repository, https://github.com/insyte-ai/insyte
Project-URL: Issues, https://github.com/insyte-ai/insyte/issues
Author: Insyte contributors
License:                                  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.
License-File: LICENSE
Keywords: ai,analytics,cli,database,duckdb,mcp,postgresql,sql
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: certifi>=2024.7.4
Requires-Dist: duckdb-engine>=0.13
Requires-Dist: duckdb>=1.0
Requires-Dist: fastapi>=0.110
Requires-Dist: mcp>=1.2
Requires-Dist: openpyxl>=3.1
Requires-Dist: packaging>=24.0
Requires-Dist: plotext>=5.2
Requires-Dist: polars>=1.0
Requires-Dist: psycopg[binary]>=3.1
Requires-Dist: pyarrow>=16.0
Requires-Dist: pydantic-settings>=2.3
Requires-Dist: pydantic>=2.7
Requires-Dist: pyyaml>=6.0
Requires-Dist: reportlab>=4.0
Requires-Dist: rich>=13.7
Requires-Dist: sqlalchemy>=2.0
Requires-Dist: sqlglot>=25.0
Requires-Dist: textual>=0.60
Requires-Dist: tomli-w>=1.0
Requires-Dist: typer>=0.12
Requires-Dist: uvicorn>=0.29
Provides-Extra: desktop
Requires-Dist: pyinstaller>=6.10; extra == 'desktop'
Provides-Extra: dev
Requires-Dist: httpx>=0.27; extra == 'dev'
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.2; extra == 'dev'
Requires-Dist: ruff>=0.5; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
Description-Content-Type: text/markdown

# Insyte

**Ask your database questions in natural language — locally, and safely.**

Insyte connects to your database with **read-only** credentials and turns natural-language
questions into safe analytics. Ask *"what were total sales last month?"* or *"revenue by
city"* from a browser workspace, a terminal UI, or your own AI tool (Claude Code / Codex) —
Insyte writes the SQL, runs it read-only, and shows the answer.

Two things are always true:

1. **AI models never see your database credentials.**
2. **Nothing can bypass Insyte's SQL validation, row limits, PII masking, or audit log** — a
   dangerous query is rejected, not executed.

## What you can do

- **Ask in natural language** — "total order value last month", "orders by payment method",
  "monthly revenue trend", "what's the expected revenue this year?"
- **Three ways to use it** — a browser workspace (`insyte studio`), a terminal UI
  (`insyte chat`), or directly from **Claude Code / Codex** over MCP.
- **Trends, breakdowns, opportunity segments, comparisons, and forecasts** over metrics Insyte
  generates from your schema — with charts, tables, and the exact SQL on demand.
- **Smart semantic aliases** — during semantic generation, Insyte creates safe natural-language
  aliases from scanned tables, columns, metrics, and dimensions. "order count" can resolve to a
  real `sales_order_count` metric when the `sales_orders` table exists, but aliases only point
  at existing semantic objects and carry evidence.
- **Profile-aware schema retrieval** — guided setup safely profiles bounded samples and
  fingerprints the scanned schema. SQLite full-text search ranks structural metadata, while a
  deterministic semantic catalog ranks metrics, dimensions, aliases, and safe profile evidence.
  Only relevant known objects are offered to the AI resolver; its answer is still validated
  against the complete semantic layer.
- **Investigation Mode Lite** — ask broader questions like "why did total amount change?" or
  explicit comparisons like "Why did order count drop from February 2026 to March 2026?" and
  Studio runs a safe, multi-step investigation: trend, period-aware comparison, segment
  breakdown, freshness checks, and next questions. Relative questions such as "this week" use
  a daily trend and compare the elapsed window with the same elapsed window last week.
- **Saved investigations** — completed Studio investigations are saved locally with their
  timeline, report, original question, and linked analysis result. Reopen them from the
  Investigations workspace and export complete PDF reports.
- **Task-aware model routing** — intent resolution, investigation planning, and reports can use
  different local Claude/Codex backends. Explicit fallback is opt-in; deterministic behavior
  remains available for every task.
- **Typed internal agents** — planner, analyst, quality, report, and critic stages exchange
  validated models. Agents select approved operations and call `AnalysisService`; they never
  execute model-authored SQL or receive database credentials.
- **Detailed reports (opt-in)** — flip on "Detailed report" in Studio for an in-depth analyst
  write-up: executive summary, key insights, data-quality flags, root-cause reasoning,
  evidence/counter-evidence, best/expected/worst forecast, and prioritized recommendations, in a
  visual dashboard. Investigation questions can use the same analyst report skill over the
  grounded investigation bundle. See the privacy note below for what this shares.
- **Interactive charts** — charts include hover tooltips, readable date labels, expandable
  fullscreen views, and smooth trend lines for faster inspection.
- **Conversation context** — Studio remembers compact metric, dimension, period, and result
  context so follow-up questions like "same metric last month" resolve more reliably.
- **Read-only and private** — everything runs on your machine against your database; the raw
  connection URL never leaves your computer.

### Detailed reports & your privacy

Everything above keeps your data on your machine. The one **opt-in** exception is the
**Detailed report**: to write analyst commentary, Insyte sends the *already-aggregated,
PII-masked result* of your query, or a grounded investigation bundle built from those aggregate
results, to your local `claude`/`codex` CLI, which forwards it to that provider. The AI only
writes prose — it never sees credentials, never authors SQL, and every chart is built by Insyte
from real numbers. It's off by default, shows a one-time notice the first time you enable it,
and can be turned off entirely with `ai.detailed_reports: false` in `config.yaml`.

Task routes are configured independently while retaining `studio_backend` compatibility:

```yaml
ai:
  studio_backend: auto
  intent_backend: auto
  planner_backend: auto
  report_backend: auto
  fallback_backend: off
  detailed_reports: true
```

`auto` selects an installed local client. `off` uses the deterministic path. A failed explicit
route tries another model only when `fallback_backend` is configured; otherwise it fails closed.

### Smart aliases without hallucination

Insyte's semantic layer can understand obvious business phrasing without making up data. The
semantic generator creates aliases such as `order count -> sales_order_count` only when the
target metric already exists, and every alias stores evidence such as the metric name and
expression. The parser uses high-confidence aliases after exact metric matching fails; low
confidence or ambiguous aliases do not run silently.

AI-assisted enrichment is a bounded review step: it may propose a filtered metric only from an
existing metric and exact, non-PII, low-cardinality profiled values. Proposals remain blocked
until approved and cannot introduce tables, columns, joins, expressions, unobserved values, or
SQL.

## Install & set up

### macOS app (no terminal or Python required for Insyte)

Download the latest Apple silicon DMG from
[GitHub Releases](https://github.com/insyte-ai/insyte/releases/latest/download/Insyte-macOS-arm64.dmg),
drag Insyte to Applications, and open it. The app bundles the matching Insyte package and Python
runtime, then opens the local Studio setup wizard. It does not run `pip install` on the user's
computer. AI-powered questions use an already-installed Claude Code or Codex client; that client
opens and owns its browser sign-in flow.

Release builds use the exact package version from the tagged source. Studio can check PyPI for a
newer version and link to the latest release, but updates remain user-controlled.

### Python package

Easiest — **pipx** installs Insyte in its own isolated environment (no virtual-env to manage):

```bash
pipx install insyte
insyte init          # asks for your read-only DB URL and which AI tool, then sets everything up
```

<sub>No pipx yet? `brew install pipx` (macOS) or `python -m pip install --user pipx && pipx ensurepath`, then reopen your terminal.</sub>

Prefer plain pip? Install into a virtual environment:

```bash
python -m venv .venv && source .venv/bin/activate
pip install insyte
insyte init
```

You can now start with the browser instead:

```bash
insyte studio
```

When no project exists, Studio opens a local first-run wizard. Choose Claude, Codex, or the
deterministic mode; paste a PostgreSQL URL; select schemas and SSL mode; and let Insyte test the
read-only connection, scan, profile, generate metrics, and validate the semantic layer. The URL
is submitted only to the local `127.0.0.1` process and is stored in the same protected `0600`
project secret used by the CLI.

`insyte init` remains available for terminal-first and automated setup. It walks you through:

1. Enter your **read-only database URL** (stored once in a `0600` file — never in config,
   never logged, never sent to an AI).
2. Pick your **AI tool** — Claude Code, Codex, or none.
3. Insyte then **connects, scans and profiles the schema, generates and validates metrics,
   proposes grounded derived metrics for review, creates concise schema-grounded starter
   questions, and wires up your AI tool** — no scripts, no environment variables.

Then use it:

```bash
insyte studio        # browser workspace at http://127.0.0.1:3838
insyte chat          # terminal UI
insyte analyze total_amount --by city
```

### AWS RDS and GCP Cloud SQL

The Studio wizard accepts standard password-based PostgreSQL URLs for Amazon RDS/Aurora
PostgreSQL and Google Cloud SQL for PostgreSQL. The database must be reachable from the local
computer through an allowlisted public endpoint, VPN, or an already-running proxy/tunnel. Use a
dedicated PostgreSQL role with `CONNECT`, schema `USAGE`, and table `SELECT` privileges only.

AWS IAM tokens and automatic Google Cloud SQL Auth Proxy/IAM login are not static URLs and are
planned as separate credential providers. BigQuery, Redshift, Athena, and Spanner are not
PostgreSQL and are not supported by this connector.

Studio Settings also includes **Check for updates**. It compares the running version with PyPI
and links to the latest GitHub release; it never installs or upgrades packages automatically.

**Requirements:** Python 3.11+, a PostgreSQL database, and — for natural-language questions —
the `claude` or `codex` CLI (Studio also answers metric questions without one).

### Recommended: a read-only database user

Insyte enforces read-only regardless, but a dedicated account is safest:

```sql
CREATE ROLE insyte_reader LOGIN PASSWORD '…';
GRANT CONNECT ON DATABASE your_db TO insyte_reader;
GRANT USAGE ON SCHEMA public TO insyte_reader;
GRANT SELECT ON ALL TABLES IN SCHEMA public TO insyte_reader;
```

## Use it from Claude Code / Codex

`insyte init` already installs the Insyte MCP server into your chosen tool. Restart it, then
ask questions in plain language — Claude/Codex call Insyte's safe tools; it validates, runs
read-only, masks PII, and audits every query. (Re-run any time with `insyte mcp install claude`
or `insyte mcp install codex`.)

## Handy commands

| Command | What it does |
|---|---|
| `insyte init` | Guided setup: DB URL + AI tool → connect, scan, profile, generate, validate, questions, MCP |
| `insyte scan` / `insyte profile` | Refresh structural metadata / bounded safe column profiles |
| `insyte studio` | Browser workspace (localhost only) |
| `insyte chat` | Terminal UI |
| `insyte analyze <metric> --by <dimension>` | A single analysis from the CLI |
| `insyte metrics` | List the metrics Insyte generated |
| `insyte semantic generate` | Regenerate suggested metrics, dimensions, entities, and safe aliases from scanned metadata |
| `insyte semantic enrich` | Ask the local AI CLI for profiled-value-derived metric proposals; proposals remain blocked until approved |
| `insyte semantic questions` | Regenerate short Studio starter questions with the selected local AI CLI |
| `insyte semantic validate` | Verify every semantic object against the latest scanned schema |
| `insyte status` / `insyte doctor` | Project state / health checks |

Everything lives under `~/.insyte/projects/<name>/` (config, stored URL, scanned schema,
metrics, aliases, conversations, saved investigations). The connection URL is read only when
needed and never written to `config.yaml`.

When a question contains an undefined qualifier such as "positive", "failed", or "active",
Insyte does not drop the qualifier and run the base metric. It may propose a derived metric using
an exact non-PII profiled field and observed values, but that metric remains non-executable until
you approve it from Studio's Metrics page or with `insyte metrics approve <name>`.

## Feedback

Found a bug or have an idea? Please open an issue:
**https://github.com/insyte-ai/insyte/issues** — feedback is very welcome.

## Contributing

```bash
uv venv && uv pip install -e '.[dev]'
uv run ruff check src tests && uv run mypy src && uv run pytest -q
```

## Security & license

See [SECURITY.md](SECURITY.md) for the read-only posture and how to report a vulnerability.
Licensed under **Apache-2.0** — see [LICENSE](LICENSE).
