sqlshell 0.1.9__tar.gz → 0.2.0__tar.gz

sqlshell-0.2.0/.gitignore

@@ -0,0 +1,87 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Test data files
+tests/data/*.db
+tests/data/*.parquet
+tests/data/*.xlsx
+tests/data/*.xls
+tests/data/*.csv
+tests/data/*.delta
+tests/data/*.duckdb
+tests/data/*.sqls
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Environment
+.env
+.venv
+env/
+venv/
+ENV/
+
+# Distribution
+dist/
+build/
+*.egg-info/
+
+# Generated files
+*.log
+.coverage
+htmlcov/
+
+# Virtual Environment
+venv/
+env/
+ENV/
+.env
+.venv
+
+# Project specific
+*.db
+*.xlsx
+*.xls
+*.csv
+sample_sales_data.xlsx
+pool.db
+
+# Logs
+*.log
+logs/
+
+# OS specific
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# Distribution / packaging
+*.spec
+*.manifest
+*.spec 
+*.parquet 
+*.sqls
+sqlshell-0.2.0/
+TODO

sqlshell-0.2.0/MANIFEST.in

@@ -0,0 +1,20 @@
+include README.md
+include LICENSE
+include sqlshell_logo.png
+include sqlshell_demo.png
+include pool.db
+include sqlshell/resources/*.png
+include sqlshell/resources/*.gif
+include sqlshell/data/*.py
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude tests/data
+global-exclude */tests/data
+global-exclude *.db
+global-exclude *.parquet
+global-exclude *.xlsx
+global-exclude *.xls
+global-exclude *.csv
+global-exclude *.delta
+global-exclude test.duckdb
+prune tests/data 

sqlshell-0.2.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: sqlshell
+Version: 0.2.0
+Summary: A powerful SQL shell with GUI interface for data analysis
+Author: SQLShell Team
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/oyvinrog/SQLShell
+Keywords: sql,data analysis,gui,duckdb
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: PyQt6>=6.4.0
+Requires-Dist: duckdb>=0.9.0
+Requires-Dist: openpyxl>=3.1.0
+Requires-Dist: pyarrow>=14.0.1
+Requires-Dist: fastparquet>=2023.10.1
+Requires-Dist: xlrd>=2.0.1
+Requires-Dist: deltalake
+Requires-Dist: Pillow>=10.0.0
+
+# SQLShell
+
+<div align="center">
+
+<img src="sqlshell_logo.png" alt="SQLShell Logo" width="180" height="auto">
+
+**A powerful SQL shell with GUI interface for data analysis**
+
+<img src="sqlshell_demo.png" alt="SQLShell Interface" width="80%" height="auto">
+
+</div>
+
+## 🚀 Key Features
+
+- **Interactive SQL Interface** - Rich syntax highlighting for enhanced query writing
+- **Context-Aware Suggestions** - Intelligent SQL autocompletion based on query context and schema
+- **DuckDB Integration** - Powerful analytical queries powered by DuckDB
+- **Multi-Format Support** - Import and query Excel (.xlsx, .xls), CSV, and Parquet files effortlessly
+- **Modern UI** - Clean, tabular results display with intuitive controls
+- **Table Preview** - Quick view of imported data tables
+- **Test Data Generation** - Built-in sample data for testing and learning
+- **Multiple Views** - Support for multiple concurrent table views
+- **Productivity Tools** - Streamlined workflow with keyboard shortcuts (e.g., Ctrl+Enter for query execution)
+
+## 📦 Installation
+
+### Using pip (Recommended)
+
+```bash
+pip install sqlshell
+```
+
+### Linux Setup with Virtual Environment
+
+```bash
+# Create and activate virtual environment
+python3 -m venv ~/.venv/sqlshell
+source ~/.venv/sqlshell/bin/activate
+
+# Install SQLShell
+pip install sqlshell
+
+# Configure shell alias
+echo 'alias sqls="~/.venv/sqlshell/bin/sqls"' >> ~/.bashrc  # or ~/.zshrc for Zsh
+source ~/.bashrc  # or source ~/.zshrc
+```
+
+### Development Installation
+
+```bash
+git clone https://github.com/oyvinrog/SQLShell.git
+cd SQLShell
+pip install -e .
+```
+
+## 🎯 Getting Started
+
+1. **Launch the Application**
+   ```bash
+   sqls
+   ```
+   
+   If the `sqls` command doesn't work (e.g., "access denied" on Windows), you can use this alternative:
+   ```bash
+   python -c "import sqlshell; sqlshell.start()"
+   ```
+
+2. **Database Connection**
+   - SQLShell automatically connects to a local DuckDB database named 'pool.db'
+
+3. **Working with Data Files**
+   - Click "Load Files" to select your Excel, CSV, or Parquet files
+   - File contents are loaded as queryable SQL tables
+   - Query using standard SQL syntax
+
+4. **Query Execution**
+   - Enter SQL in the editor
+   - Execute using Ctrl+Enter or the "Execute" button
+   - View results in the structured output panel
+
+5. **Test Data**
+   - Load sample test data using the "Test" button for quick experimentation
+   
+6. **Using Context-Aware Suggestions**
+   - Press Ctrl+Space to manually trigger suggestions
+   - Suggestions appear automatically as you type
+   - Context-specific suggestions based on your query position:
+     - After SELECT: columns and functions
+     - After FROM/JOIN: tables with join conditions
+     - After WHERE: columns with appropriate operators
+     - Inside functions: relevant column suggestions
+
+## 📝 Query Examples
+
+### Basic Join Operation
+```sql
+SELECT *
+FROM sample_sales_data cd
+INNER JOIN product_catalog pc ON pc.productid = cd.productid
+LIMIT 3;
+```
+
+### Multi-Statement Queries
+```sql
+-- Create a temporary view
+CREATE OR REPLACE TEMPORARY VIEW test_v AS
+SELECT *
+FROM sample_sales_data cd
+INNER JOIN product_catalog pc ON pc.productid = cd.productid;
+
+-- Query the view
+SELECT DISTINCT productid
+FROM test_v;
+```
+
+## 💡 Pro Tips
+
+- Use temporary views for complex query organization
+- Leverage keyboard shortcuts for efficient workflow
+- Explore the multi-format support for various data sources
+- Create multiple tabs for parallel query development
+- The context-aware suggestions learn from your query patterns
+- Type `table_name.` to see all columns for a specific table
+- After JOIN keyword, the system suggests relevant tables and join conditions
+
+## 📊 Column Profiler
+
+The Column Profiler provides quick statistical insights into your table columns:
+
+<img src="column_profiler.png" alt="Column Profiler" width="80%" height="auto">
+
+### Using the Column Profiler
+
+1. **Access the Profiler**
+   - Right-click on any table in the schema browser
+   - Select "Profile Table" from the context menu
+
+2. **View Column Statistics**
+   - Instantly see key metrics for each column:
+     - Data type
+     - Non-null count and percentage
+     - Unique values count
+     - Mean, median, min, and max values (for numeric columns)
+     - Most frequent values and their counts
+     - Distribution visualization
+
+3. **Benefits**
+   - Quickly understand data distribution
+   - Identify outliers and data quality issues
+   - Make informed decisions about query conditions
+   - Assess column cardinality for join operations
+
+The Column Profiler is an invaluable tool for exploratory data analysis, helping you gain insights before writing complex queries.
+
+## 📋 Requirements
+
+- Python 3.8 or higher
+- Dependencies (automatically installed):
+  - PyQt6 ≥ 6.4.0
+  - DuckDB ≥ 0.9.0
+  - Pandas ≥ 2.0.0
+  - NumPy ≥ 1.24.0
+  - openpyxl ≥ 3.1.0 (Excel support)
+  - pyarrow ≥ 14.0.1 (Parquet support)
+  - fastparquet ≥ 2023.10.1 (Alternative parquet engine)
+  - xlrd ≥ 2.0.1 (Support for older .xls files)
+
+## 📄 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

sqlshell-0.2.0/README.md

@@ -0,0 +1,170 @@
+# SQLShell
+
+<div align="center">
+
+<img src="sqlshell_logo.png" alt="SQLShell Logo" width="180" height="auto">
+
+**A powerful SQL shell with GUI interface for data analysis**
+
+<img src="sqlshell_demo.png" alt="SQLShell Interface" width="80%" height="auto">
+
+</div>
+
+## 🚀 Key Features
+
+- **Interactive SQL Interface** - Rich syntax highlighting for enhanced query writing
+- **Context-Aware Suggestions** - Intelligent SQL autocompletion based on query context and schema
+- **DuckDB Integration** - Powerful analytical queries powered by DuckDB
+- **Multi-Format Support** - Import and query Excel (.xlsx, .xls), CSV, and Parquet files effortlessly
+- **Modern UI** - Clean, tabular results display with intuitive controls
+- **Table Preview** - Quick view of imported data tables
+- **Test Data Generation** - Built-in sample data for testing and learning
+- **Multiple Views** - Support for multiple concurrent table views
+- **Productivity Tools** - Streamlined workflow with keyboard shortcuts (e.g., Ctrl+Enter for query execution)
+
+## 📦 Installation
+
+### Using pip (Recommended)
+
+```bash
+pip install sqlshell
+```
+
+### Linux Setup with Virtual Environment
+
+```bash
+# Create and activate virtual environment
+python3 -m venv ~/.venv/sqlshell
+source ~/.venv/sqlshell/bin/activate
+
+# Install SQLShell
+pip install sqlshell
+
+# Configure shell alias
+echo 'alias sqls="~/.venv/sqlshell/bin/sqls"' >> ~/.bashrc  # or ~/.zshrc for Zsh
+source ~/.bashrc  # or source ~/.zshrc
+```
+
+### Development Installation
+
+```bash
+git clone https://github.com/oyvinrog/SQLShell.git
+cd SQLShell
+pip install -e .
+```
+
+## 🎯 Getting Started
+
+1. **Launch the Application**
+   ```bash
+   sqls
+   ```
+   
+   If the `sqls` command doesn't work (e.g., "access denied" on Windows), you can use this alternative:
+   ```bash
+   python -c "import sqlshell; sqlshell.start()"
+   ```
+
+2. **Database Connection**
+   - SQLShell automatically connects to a local DuckDB database named 'pool.db'
+
+3. **Working with Data Files**
+   - Click "Load Files" to select your Excel, CSV, or Parquet files
+   - File contents are loaded as queryable SQL tables
+   - Query using standard SQL syntax
+
+4. **Query Execution**
+   - Enter SQL in the editor
+   - Execute using Ctrl+Enter or the "Execute" button
+   - View results in the structured output panel
+
+5. **Test Data**
+   - Load sample test data using the "Test" button for quick experimentation
+   
+6. **Using Context-Aware Suggestions**
+   - Press Ctrl+Space to manually trigger suggestions
+   - Suggestions appear automatically as you type
+   - Context-specific suggestions based on your query position:
+     - After SELECT: columns and functions
+     - After FROM/JOIN: tables with join conditions
+     - After WHERE: columns with appropriate operators
+     - Inside functions: relevant column suggestions
+
+## 📝 Query Examples
+
+### Basic Join Operation
+```sql
+SELECT *
+FROM sample_sales_data cd
+INNER JOIN product_catalog pc ON pc.productid = cd.productid
+LIMIT 3;
+```
+
+### Multi-Statement Queries
+```sql
+-- Create a temporary view
+CREATE OR REPLACE TEMPORARY VIEW test_v AS
+SELECT *
+FROM sample_sales_data cd
+INNER JOIN product_catalog pc ON pc.productid = cd.productid;
+
+-- Query the view
+SELECT DISTINCT productid
+FROM test_v;
+```
+
+## 💡 Pro Tips
+
+- Use temporary views for complex query organization
+- Leverage keyboard shortcuts for efficient workflow
+- Explore the multi-format support for various data sources
+- Create multiple tabs for parallel query development
+- The context-aware suggestions learn from your query patterns
+- Type `table_name.` to see all columns for a specific table
+- After JOIN keyword, the system suggests relevant tables and join conditions
+
+## 📊 Column Profiler
+
+The Column Profiler provides quick statistical insights into your table columns:
+
+<img src="column_profiler.png" alt="Column Profiler" width="80%" height="auto">
+
+### Using the Column Profiler
+
+1. **Access the Profiler**
+   - Right-click on any table in the schema browser
+   - Select "Profile Table" from the context menu
+
+2. **View Column Statistics**
+   - Instantly see key metrics for each column:
+     - Data type
+     - Non-null count and percentage
+     - Unique values count
+     - Mean, median, min, and max values (for numeric columns)
+     - Most frequent values and their counts
+     - Distribution visualization
+
+3. **Benefits**
+   - Quickly understand data distribution
+   - Identify outliers and data quality issues
+   - Make informed decisions about query conditions
+   - Assess column cardinality for join operations
+
+The Column Profiler is an invaluable tool for exploratory data analysis, helping you gain insights before writing complex queries.
+
+## 📋 Requirements
+
+- Python 3.8 or higher
+- Dependencies (automatically installed):
+  - PyQt6 ≥ 6.4.0
+  - DuckDB ≥ 0.9.0
+  - Pandas ≥ 2.0.0
+  - NumPy ≥ 1.24.0
+  - openpyxl ≥ 3.1.0 (Excel support)
+  - pyarrow ≥ 14.0.1 (Parquet support)
+  - fastparquet ≥ 2023.10.1 (Alternative parquet engine)
+  - xlrd ≥ 2.0.1 (Support for older .xls files)
+
+## 📄 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

{sqlshell-0.1.9 → sqlshell-0.2.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=45", "wheel"]
+requires = ["setuptools>=61.0", "wheel>=0.37.0", "setuptools_scm>=6.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "sqlshell"
-version = "0.1.9"
+version = "0.2.0"
 description = "A powerful SQL shell with GUI interface for data analysis"
 readme = "README.md"
 authors = [
@@ -12,7 +12,7 @@ authors = [
 ]
 requires-python = ">=3.8"
 keywords = ["sql", "data analysis", "gui", "duckdb"]
-license = {text = "MIT"}
+license = "MIT"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
@@ -30,11 +30,41 @@ dependencies = [
     "openpyxl>=3.1.0",
     "pyarrow>=14.0.1",
     "fastparquet>=2023.10.1",
-    "xlrd>=2.0.1"
+    "xlrd>=2.0.1",
+    "deltalake",
+    "Pillow>=10.0.0"
 ]
 
 [project.urls]
 Homepage = "https://github.com/oyvinrog/SQLShell"
 
 [project.scripts]
-sqls = "sqlshell.main:main" 
+sqls = "sqlshell.main:main"
+
+[tool.setuptools]
+packages = [
+    "sqlshell",
+    "sqlshell.data",
+    "sqlshell.db",
+    "sqlshell.resources",
+    "sqlshell.sqlshell",
+    "sqlshell.ui",
+    "sqlshell.utils"
+]
+
+[tool.setuptools.package-data]
+sqlshell = [
+    "*.db",
+    "resources/*.png",
+    "resources/*.gif",
+    "data/*.py",
+    "*.png",
+    "*.ico"
+]
+
+[tool.setuptools.exclude-package-data]
+sqlshell = [
+    "tests/*",
+    "*/tests/*",
+    "tests/data/*"
+] 

sqlshell-0.2.0/requirements.txt

@@ -0,0 +1,10 @@
+pandas>=2.0.0
+numpy>=1.24.0
+PyQt6>=6.4.0
+duckdb>=0.9.0
+openpyxl>=3.1.0  # For Excel support
+pyarrow  # For parquet support
+fastparquet>=2023.10.1  # Alternative parquet engine
+xlrd>=2.0.1  # For old .xls files 
+deltalake  # For Delta Lake table support
+Pillow>=10.0.0  # For image processing (used in splash screen and icon creation) 

sqlshell-0.2.0/run.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+"""
+SQLShell - A powerful SQL shell with GUI interface for data analysis
+
+This is the main entry point for the application. You can start SQLShell in two ways:
+
+1. Normal way (if 'sqls' command works):
+   sqls
+
+2. Alternative way (if 'sqls' command leads to "access denied" on Windows):
+   python -c "import sqlshell; sqlshell.start()"
+"""
+
+import sys
+import os
+
+# Add the project root directory to Python path
+project_root = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, project_root)
+
+from sqlshell.main import main
+
+def start():
+    """Start the SQLShell application.
+    This function is provided for Windows compatibility when the 'sqls' command doesn't work."""
+    main()
+
+if __name__ == '__main__':
+    main() 

sqlshell-0.2.0/sqlshell/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SQLShell Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

sqlshell-0.2.0/sqlshell/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include MANIFEST.in
+include README.md
+include sqlshell_demo.png
+recursive-include sqlshell *.py
+recursive-include sqlshell *.db 

sqlshell-0.2.0/sqlshell/README.md

@@ -0,0 +1,59 @@
+# SQLShell
+
+A powerful SQL shell with GUI interface for data analysis. SQLShell provides an intuitive interface for working with various data formats (CSV, Excel, Parquet) using SQL queries powered by DuckDB.
+
+![SQLShell Interface](sqlshell_demo.png)
+
+## Features
+
+- Load and analyze data from CSV, Excel (.xlsx, .xls), and Parquet files
+- Interactive GUI with syntax highlighting
+- Real-time query results
+- Table preview functionality
+- Built-in test data generation
+- Support for multiple concurrent table views
+
+## Installation
+
+You can install SQLShell using pip:
+
+```bash
+pip install sqlshell
+```
+
+refer to 
+
+For development installation:
+
+```bash
+git clone https://github.com/oyvinrog/SQLShell.git
+cd sqlshell
+pip install -e .
+```
+
+## Usage
+
+After installation, you can start SQLShell from anywhere in your terminal by running:
+
+```bash
+sqls
+```
+
+This will open the GUI interface where you can:
+1. Load data files using the "Load Files" button
+2. Write SQL queries in the query editor
+3. Execute queries using the "Execute" button or Ctrl+Enter
+4. View results in the table view below
+5. Load sample test data using the "Test" button
+
+## Requirements
+
+- Python 3.8 or higher
+- PyQt6
+- DuckDB
+- Pandas
+- Other dependencies will be automatically installed
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.