Metadata-Version: 2.4
Name: hyperxql
Version: 1.0.0
Summary: A Python library that bridges the gap between non-technical users and complex database operations through natural language processing and LLMs
Home-page: https://github.com/skandanv/hyperxql
Author: HyperXQL Team
Author-email: hyperxql@skandan.com
License: MIT
Project-URL: Homepage, https://github.com/hyperdyn-ai/hyperxql
Project-URL: Bug Tracker, https://github.com/hyperdyn-ai/hyperxql/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: build>=1.0.3
Requires-Dist: click>=8.1.8
Requires-Dist: python-dotenv>=1.0.1
Requires-Dist: email-validator>=2.2.0
Requires-Dist: flask>=3.1.0
Requires-Dist: flask-sqlalchemy>=3.1.1
Requires-Dist: graphviz>=0.20.3
Requires-Dist: gunicorn>=23.0.0
Requires-Dist: openai>=1.68.2
Requires-Dist: psycopg2-binary>=2.9.10
Requires-Dist: pydot>=3.0.4
Requires-Dist: requests>=2.32.3
Requires-Dist: rich>=13.9.4
Requires-Dist: setuptools>=78.0.2
Requires-Dist: sqlalchemy>=2.0.39
Requires-Dist: together>=1.3.0
Requires-Dist: twine>=6.1.0
Requires-Dist: werkzeug>=3.1.3
Dynamic: author-email
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# HyperXQL

**Natural Language to SQL Database Operations**

HyperXQL is a powerful tool that enables users to interact with databases using natural language. It leverages large language models to generate and execute SQL queries based on your instructions, without requiring you to write SQL code directly.

![HyperXQL Logo](static/img/hyperxql-logo.png)

## Features

- 🔄 Convert natural language to SQL
- 🗄️ Support for SQLite, PostgreSQL, and MySQL
- 🤖 Intelligent AI agent for database operations
- 🔍 Database schema analysis and visualization
- 📊 Interactive command-line interface
- 🌐 Web interface for query execution
- 🛠️ Automatic error detection and recovery

## Installation

```bash
pip install hyperxql
```

## Quick Start

1. Initialize HyperXQL:

```bash
hyperxql init
```

This will guide you through setting up your configuration and database connection.

2. Use the agent to perform database operations:

```bash
hyperxql agent "create a users table with columns for id, name, email and phone number"
```

3. Query your database:

```bash
hyperxql query "show me all users who signed up in the last month"
```

## Database Agent

The intelligent database agent can help you:

- Create tables and schema
- Insert, update, and delete data
- Generate sample data
- Query and analyze your database
- Fix errors and handle edge cases

The agent thinks aloud, explains its reasoning, and shows you exactly what it's doing.

## Web Interface

Start the web interface with:

```bash
hyperxql web
```

Then open your browser to http://localhost:5000

## Requirements

- Python 3.8+
- SQLAlchemy-supported database (SQLite, PostgreSQL, MySQL)
- API key for OpenAI or Together AI (configurable)

## License

MIT License
