Metadata-Version: 2.4
Name: urimai
Version: 0.1.2
Summary: AI-powered SQL answer engine - ask questions about your databases
Author: Shiva
License: Elastic License 2.0 (ELv2)
        
        Licensor: Shiva
        Licensed Work: urimai
        
        ## Acceptance
        
        By using the software, you agree to all of the terms and conditions below.
        
        ## Copyright License
        
        The licensor grants you a non-exclusive, royalty-free, worldwide,
        non-sublicensable, non-transferable license to use, copy, distribute, make
        available, and prepare derivative works of the software, in each case subject to
        the limitations and conditions below.
        
        ## Limitations
        
        You may not provide the software to third parties as a hosted or managed
        service, where the service provides users with access to any substantial set of
        the features or functionality of the software.
        
        You may not move, change, disable, or circumvent the license key functionality
        in the software, and you may not remove or obscure any functionality in the
        software that is protected by the license key.
        
        You may not alter, remove, or obscure any licensing, copyright, or other notices
        of the licensor in the software. Any use of the licensor's trademarks is subject
        to applicable law.
        
        ## Patents
        
        The licensor grants you a license, under any patent claims the licensor can
        license, or becomes able to license, to make, have made, use, sell, offer for
        sale, import and have imported the software, in each case subject to the
        limitations and conditions in this license. This license does not cover any
        patent claims that you cause to be infringed by modifications or additions to
        the software. If you or your company make any written claim that the software
        infringes or contributes to infringement of any patent, your patent license for
        the software granted under these terms ends immediately. If your company makes
        such a claim, your patent license ends immediately for work on behalf of your
        company.
        
        ## Notices
        
        You must ensure that anyone who gets a copy of any part of the software from you
        also gets a copy of these terms.
        
        If you modify the software, you must include in any modified copies of the
        software prominent notices stating that you have modified the software.
        
        ## No Other Rights
        
        These terms do not imply any licenses other than those expressly granted in
        these terms.
        
        ## Termination
        
        If you use the software in violation of these terms, such use is not licensed,
        and your licenses will automatically terminate. If the licensor provides you with
        a notice of your violation, and you cease all violation of this license no later
        than 30 days after you receive that notice, your licenses will be reinstated
        retroactively. However, if you violate these terms after such reinstatement, any
        additional violation of these terms will cause your licenses to terminate
        automatically and permanently.
        
        ## No Liability
        
        As far as the law allows, the software comes as is, without any warranty or
        condition, and the licensor will not be liable to you for any damages arising out
        of these terms or the use or nature of the software, under any kind of legal
        claim.
        
        ## Definitions
        
        The "licensor" is the entity offering these terms, and the "software" is the
        software the licensor makes available under these terms, including any portion
        of it.
        
        "you" refers to the individual or entity agreeing to these terms.
        
        "your company" is any legal entity, sole proprietorship, or other kind of
        organization that you work for, plus all organizations that have control over,
        are under the control of, or are under common control with that organization.
        "control" means ownership of substantially all the assets of an entity, or the
        power to direct its management and policies by vote, contract, or otherwise.
        Control can be direct or indirect.
        
        "your licenses" are all the licenses granted to you for the software under these
        terms.
        
        "use" means anything you do with the software requiring one of your licenses.
        
        "trademark" means trademarks, service marks, and similar rights.
        
Project-URL: Homepage, https://github.com/shivakharbanda/urimAI
Project-URL: Source, https://github.com/shivakharbanda/urimAI
Keywords: sql,ai,llm,database,natural-language,query
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Database
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dq-db-manager>=0.2.0
Requires-Dist: pydantic>=2.12.3
Requires-Dist: pydantic-ai>=0.0.14
Requires-Dist: typer>=0.12.0
Requires-Dist: rich>=13.0.0
Requires-Dist: keyring>=25.0.0
Requires-Dist: tomli-w>=1.0.0
Requires-Dist: aiosqlite>=0.20.0
Requires-Dist: prompt-toolkit>=3.0.0
Requires-Dist: numpy>=2.3.4
Requires-Dist: scipy>=1.16.3
Requires-Dist: pandas>=2.0.0
Requires-Dist: openai>=1.0.0
Requires-Dist: openpyxl>=3.1.0
Dynamic: license-file

# urimai

AI-powered SQL answer engine — ask questions about your databases using AI.

## Installation

```bash
# From PyPI
pip install urimai

# From source
git clone https://github.com/shivakharbanda/urimAI
cd urimAI
uv sync
```

## Quick Start

```bash
urim setup              # First-time config wizard
urim init ./chinook.db  # Register a database
urim chat chinook       # Start chatting
```

## Commands

| Command | Description |
|---------|-------------|
| `urim setup` | Run first-time setup wizard (provider, API key, name) |
| `urim init <path>` | Register a SQLite database or CSV file |
| `urim list` | List all registered databases |
| `urim chat <db_name>` | Start interactive chat session |
| `urim sync <db_name>` | Re-sync database schema metadata |
| `urim config [key] [value]` | View or modify settings |
| `urim export <db_name>` | Export data dictionary (xlsx/markdown) |

### `urim setup`

Run the first-time setup wizard to configure your AI provider, API key, and display name.

### `urim init <path>`

Register a SQLite database or CSV file. CSV files are automatically converted to SQLite with LLM-powered schema inference.

```bash
urim init ./my_database.db
urim init ./data.csv --name my_data --table-name sales --delimiter "," --encoding utf-8
```

| Option | Description |
|--------|-------------|
| `--name` | Custom name for the database (default: filename) |
| `--table-name` | Table name for CSV import (default: LLM-suggested) |
| `--delimiter` | CSV delimiter character (default: `,`) |
| `--encoding` | CSV file encoding (default: `utf-8`) |

### `urim list`

List all registered databases.

```bash
urim list
```

### `urim chat <db_name>`

Start an interactive chat session with a registered database.

```bash
urim chat chinook
```

### `urim sync <db_name>`

Re-sync schema metadata for a registered database. Useful after the source data changes.

```bash
urim sync chinook
```

### `urim config [key] [value]`

View or modify configuration settings.

```bash
urim config                          # Show all settings
urim config provider.default openai  # Set default provider
urim config --reset                  # Reset to defaults
urim config --path                   # Show directory paths
```

| Option | Description |
|--------|-------------|
| `--reset` | Reset config to defaults |
| `--path` | Show config/data directory paths |
| (no args) | Show all current settings |

### `urim export <db_name>`

Export data dictionary for a registered database.

```bash
urim export chinook
urim export chinook -f markdown -o chinook_dict.md
urim export chinook --include-sample-data
```

| Option | Description |
|--------|-------------|
| `--format` / `-f` | Output format: `xlsx` or `markdown` (default: `xlsx`) |
| `--output` / `-o` | Output file path |
| `--include-sample-data` | Include sample data rows (default: off) |
| `--include-profile` | Include column profile statistics (default: on) |
| `--include-quality` | Include quality report data (default: on) |

### Global option

| Option | Description |
|--------|-------------|
| `--model <provider>` | Override the default AI provider for a single command |

## Configuration

- **Config file**: `~/.urimai/config.toml`
- **API keys**: stored in the system keyring, or set via environment variables (`GOOGLE_API_KEY`, `OPENAI_API_KEY`)
- **Supported providers**: Google Gemini, OpenAI

## License

[Elastic License 2.0 (ELv2)](LICENSE)
