sqlshell 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

sqlshell-0.3.0.dist-info/METADATA

@@ -0,0 +1,400 @@
+Metadata-Version: 2.4
+Name: sqlshell
+Version: 0.3.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
+Requires-Dist: xgboost
+Requires-Dist: scikit-learn
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: scipy>=1.15.0
+Requires-Dist: seaborn>=0.13.0
+Requires-Dist: nltk>=3.8.1
+
+# SQLShell
+
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/oyvinrog/SQLShell/main/assets/images/sqlshell_logo.png" alt="SQLShell Logo" width="180" height="auto">
+
+**A powerful SQL shell with GUI interface for data analysis**
+
+<img src="https://raw.githubusercontent.com/oyvinrog/SQLShell/main/assets/images/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 F5/F9 shortcuts and Ctrl+Enter for query execution
+- **Explain Column** - Analyze relationships between data columns directly from query results
+
+## ⚡ F5/F9 Quick Execution
+
+SQLShell includes powerful keyboard shortcuts for efficient SQL execution:
+
+- **F5**: Execute all SQL statements in the editor sequentially
+- **F9**: Execute only the current SQL statement (where your cursor is positioned)
+
+This allows for rapid testing and development - place your cursor in any statement and press F9 to execute just that query, or press F5 to run everything.
+
+## 📦 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
+
+7. **Column Analysis**
+   - Right-click on column headers in the results pane
+   - Access features like sorting, filtering, and the "Explain Column" analysis tool
+
+## 📝 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
+
+## 📊 Table Profiling
+
+SQLShell provides powerful table profiling tools to help you understand your data. These tools are accessible from the left-hand side table menu via right-click on any table:
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/oyvinrog/SQLShell/main/assets/images/column_profiler.png" alt="Column Profiler" width="80%" height="auto">
+</div>
+
+### Table Profiling Options
+
+Right-click on any table in the left panel to access these profiling tools:
+
+1. **Analyze Column Importance**
+   - Calculates entropy for each column to identify the most information-rich fields
+   - Visualizes column importance with color-coded bars
+   - Helps identify which columns are most useful for analysis and modeling
+
+2. **Profile Table Structure**
+   - Identifies candidate keys and functional dependencies
+   - Discovers potential primary keys and relationships between columns
+   - Suggests possible normalized table structures
+   - Helps understand table organization and optimize schema design
+
+3. **Analyze Column Distributions**
+   - Generates histograms, box plots, and other statistical visualizations
+   - Identifies the distribution pattern of each column (normal, uniform, etc.)
+   - Provides detailed statistics like min, max, mean, median, skewness
+   - Helps identify outliers and understand data patterns
+
+4. **Analyze Foreign Keys** (multi-table selection)
+   - Select multiple tables by holding Ctrl or Shift while clicking
+   - Right-click to access "Analyze Foreign Keys Between X Tables"
+   - Automatically discovers potential foreign key relationships between tables
+   - Identifies matching columns that could serve as join conditions
+   - Helps understand cross-table relationships in your data model
+
+### Using the Profilers
+
+1. **Access the Profilers**
+   - Right-click on any table in the schema browser
+   - Select the desired profiling option from the context menu
+   - For foreign key analysis, select multiple tables first
+
+2. **Interpret the Results**
+   - Each profiler provides interactive visualizations
+   - Hover over charts for detailed information
+   - Switch between different views using the tabs
+   - Sort and filter results to focus on specific columns
+
+3. **Benefits**
+   - Quickly understand data composition without writing queries
+   - Identify data quality issues and outliers
+   - Discover relationships between columns
+   - Make informed decisions about query optimization
+
+The table profiling tools are invaluable for exploratory data analysis, helping you gain insights before writing complex queries.
+
+## 📊 Column Analysis
+
+SQLShell provides powerful tools to analyze individual columns directly from your query results:
+
+### Explain Column Feature
+
+The "Explain Column" feature helps you understand the relationships between columns in your query results:
+
+1. **How to Access**:
+   - Right-click on any column header in the query results table
+   - Select "Explain Column" from the context menu
+
+2. **What It Does**:
+   - Analyzes the selected column's relationship with other columns in the result set
+   - Identifies correlations and dependencies between columns
+   - Provides visualizations to help understand the column's importance and distribution
+
+3. **Benefits**:
+   - Quickly identify which columns are most related to your target column
+   - Discover hidden patterns and relationships in your data
+   - Make data-driven decisions without writing complex analytical queries
+
+### Multivariate Analysis Feature
+
+The Column Profiler now offers in-depth multivariate analysis to explore relationships between columns:
+
+1. **How to Access**:
+   - In the Column Profiler, double-click on any feature in the importance table
+   - A detailed visualization window will appear showing the relationship between the selected feature and the target column
+
+2. **Smart Visualizations**:
+   - Automatically selects the most appropriate visualization based on data types:
+     - **Numeric vs. Numeric**: Scatter plot with regression line
+     - **Categorical vs. Numeric**: Bar chart showing average values
+     - **Numeric vs. Categorical**: Box plot showing distribution
+     - **Categorical vs. Categorical**: Heatmap showing relationship strength
+
+3. **Benefits**:
+   - Gain deeper insights into how features relate to your target variable
+   - Understand which features have strong predictive relationships
+   - Identify patterns and outliers in multivariate relationships
+   - Make better decisions about feature selection for analysis and modeling
+
+This feature is particularly useful for data scientists and analysts who need to understand variable relationships quickly without writing complex correlation queries.
+
+### One-hot encoding
+
+If you are working with text (i.e. job description or job title to analyze salary), you would want to 
+do 'one-hot encoding'. 
+
+1. **How to Access**:
+   - Right-click on any column header in the query results table
+   - Select "Encode text" from the context menu
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/oyvinrog/SQLShell/main/assets/images/column_encoding.png" alt="Column Profiler" width="80%" height="auto">
+</div>
+
+2. **How It Works**:
+   - SQLShell tokenizes the text into meaningful words and phrases
+   - Each unique token becomes a new binary feature (1 if present, 0 if absent)
+   - The system applies intelligent filtering to remove common words with low information value
+   - Results appear as a new query with encoded columns automatically added
+
+<!-- Screenshot 2: Encoding process/dialog showing options -->
+
+3. **Applications**:
+   - Analyze how specific keywords in job descriptions correlate with salary levels
+   - Identify which terms in product descriptions drive higher sales
+   - Extract features from unstructured text for further analysis
+   - Prepare text data for statistical modeling and machine learning
+
+4. **Using the Encoded Data**:
+   - After encoding, SQLShell presents a visualization showing top correlations
+   - Sort encoded features by correlation strength to identify key terms
+   - Use encoded columns in subsequent queries for deeper analysis
+   - Join encoded results with other tables for cross-dataset insights
+
+<!-- Screenshot 3: Results showing correlation between job descriptions and salary -->
+
+5. **Benefits**:
+   - Transform unstructured text into structured, analyzable data
+   - Discover hidden patterns between text content and numerical outcomes
+   - Identify specific terms that have the strongest relationship with target variables
+   - Perform advanced text analysis without specialized NLP knowledge
+
+This feature is particularly powerful for HR analytics, marketing text analysis, and any scenario where you need to extract insights from unstructured text data.
+
+## 📋 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.
+
+## 📁 Project Structure
+
+```
+SQLShell/
+├── sqlshell/                   # Main package
+│   ├── __init__.py
+│   ├── main.py                 # Main application entry point
+│   ├── execution_handler.py    # F5/F9 SQL execution functionality
+│   ├── editor_integration.py   # Editor integration utilities
+│   ├── query_tab.py           # Query tab implementation
+│   ├── splash_screen.py       # Application splash screen
+│   └── styles.py              # UI styling
+├── tests/                     # Test files
+│   ├── f5_f9_functionality/   # F5/F9 functionality tests and demos
+│   │   ├── README.md          # Documentation for F5/F9 tests
+│   │   ├── test_execution_handler.py  # Comprehensive test suite
+│   │   └── demo_f5_f9.py      # Interactive demo
+│   └── test_query_executor.py # Other test files
+├── docs/                      # Documentation
+│   ├── F5_F9_FUNCTIONALITY.md # Detailed F5/F9 documentation
+│   └── IMPLEMENTATION_SUMMARY.md # Implementation details
+├── assets/                    # Assets and resources
+│   └── images/               # Images and screenshots
+│       ├── sqlshell_logo.png
+│       ├── sqlshell_demo.png
+│       ├── column_profiler.png
+│       └── column_encoding.png
+├── sample_data/              # Sample data files
+│   ├── test_*.csv           # Test CSV files
+│   ├── california_housing_data.parquet
+│   └── pool.db              # Sample database
+├── main.py                  # Application launcher
+├── run.py                   # Alternative launcher
+├── README.md               # This file
+├── requirements.txt        # Python dependencies
+├── pyproject.toml         # Project configuration
+└── MANIFEST.in            # Package manifest
+```
+
+## 🧪 Testing
+
+The project includes comprehensive tests for the F5/F9 functionality:
+
+```bash
+# Run the interactive test suite
+cd tests/f5_f9_functionality
+python test_execution_handler.py
+
+# Try the interactive demo
+python demo_f5_f9.py
+```
+
+For complete documentation on F5/F9 functionality, see `docs/F5_F9_FUNCTIONALITY.md`.
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests if applicable
+5. Submit a pull request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

{sqlshell-0.2.2.dist-info → sqlshell-0.3.0.dist-info}/RECORD

@@ -1,22 +1,25 @@
 sqlshell/LICENSE,sha256=YFVzvqHDVzBVtEZoKwcHhashVdNy4P7tDEQ561jAdyo,1070
 sqlshell/MANIFEST.in,sha256=UautKSW4Kzjsy1Ti05-P58qRgM4ct4mmG3aserBGaX0,144
-sqlshell/README.md,sha256=UoWQzdsYThrOoajT40iOtpI73g5ANB7w12vll0eH0Ck,1357
-sqlshell/__init__.py,sha256=b6LUBF2u6U5_gyecqlSyGG4dww9-MxdgP5ThYlTyN7g,263
+sqlshell/README.md,sha256=_FPMDx0xcXt00Qpodw3JwwNeptE2qT0LUBCdNhEtRsA,1739
+sqlshell/__init__.py,sha256=dCODXgb9N7uXAJ_m7E_HlzZC69WSY7eikF6ABOG1Uhc,1439
 sqlshell/context_suggester.py,sha256=OdfSBqwKWtf6yGj-_cNjf9RZG9cc70TWZ_7ieAVKJqk,33970
-sqlshell/create_test_data.py,sha256=uJSFyqm8zYWpyERPd29iMu-EbtvKiwK5WV0N-LibNOc,5385
+sqlshell/create_test_data.py,sha256=3LzUEbAn7cNgahuivXB7XTnb3osE-n-VPJeoaFBP8tE,6595
 sqlshell/editor.py,sha256=iWSYUtsNCud7HWZrcqD9Ef7FEa0nt7ekeUHV6CmCgao,39635
-sqlshell/main.py,sha256=vt7s6dXmY6iw-Y3jr2YtPNMwwvdqPu1zqNRNidtIRN0,150575
+sqlshell/editor_integration.py,sha256=sZSSwd0vsuV2qlRG1IUlw67y7902Hm75U63YbjKvmWo,4531
+sqlshell/execution_handler.py,sha256=7IwVQz1GiMlXERmdP7CNLtH3SPcjzWon_ywi7vpecz0,15466
+sqlshell/main.py,sha256=d6d_wXergwC-Mx50fi4N2rX-ULidAMvP1l9qoQtlueI,183623
 sqlshell/menus.py,sha256=hiT1CXXnsRKkai7oJlPi94du_GKtIhl5X5LOGvqcOqs,5684
-sqlshell/query_tab.py,sha256=9Yu_7MRikZXrQ003N2HOvjFEBdiz_J9ZLWgTzXPiumc,8404
+sqlshell/query_tab.py,sha256=CjY1B4V7aY0wrFncOevzWWb3G-d_Cl5fgeTD9NG4de8,36820
 sqlshell/splash_screen.py,sha256=K0Ku_nXJWmWSnVEh2OttIthRZcnUoY_tmjIAWIWLm7Y,17604
 sqlshell/sqlshell_demo.png,sha256=dPp9J1FVqQVfrh-gekosuha2Jw2p2--wxbOmt2kr7fg,133550
 sqlshell/styles.py,sha256=EGA_Ow-XerPEQgj82ts3fnqkEPMcjSlJPblbPu9L__s,7135
 sqlshell/suggester_integration.py,sha256=w3fKuSq5ex5OHxSBzZunyq3mbGvX06-7nxgLClnK5Kw,13232
 sqlshell/syntax_highlighter.py,sha256=mPwsD8N4XzAUx0IgwlelyfjUhe0xmH0Ug3UI9hTcHz0,5861
-sqlshell/table_list.py,sha256=ET9UGxhRL2j42GC6WqocotvQIOUzRskH9BnmciVX_As,37670
+sqlshell/table_list.py,sha256=0V2vQXjah8uWdRaRcB0w9WzclaFX5HulCUmmJEjUW8k,41585
 sqlshell/data/create_test_data.py,sha256=sUTcf50V8-bVwYV2VNTLK65c-iHiU4wb99By67I10zM,5404
-sqlshell/db/__init__.py,sha256=AJGRkywFCnJliwfOBvtE_ISXjdESkRea7lBFM5KjuTU,152
-sqlshell/db/database_manager.py,sha256=DRPoRYgY9DthD1YvLuMeo-aRfaAAcdAKZKXMPDmAcsg,35722
+sqlshell/db/__init__.py,sha256=ww-pZ0_ucFwXpR5KkkLI-heV06tU7FrO6TwuYaCuTKQ,222
+sqlshell/db/database_manager.py,sha256=RiJB42j0TJJocnHP8hvWXuSPqBYLBpg_9hazEcgHifg,52779
+sqlshell/db/export_manager.py,sha256=PpukqPZy68AMR6ds0o9cRK3r_zdBdP-M44neerIbwMs,7295
 sqlshell/resources/__init__.py,sha256=VLTJ_5pUHhctRiV8UZDvG-jnsjgT6JQvW-ZPzIJqBIY,44
 sqlshell/resources/create_icon.py,sha256=O7idVEKwmSXxLUsbeRn6zcYVQLPSdJi98nGamTgXiM4,4905
 sqlshell/resources/create_splash.py,sha256=t1KK43Y0pHKGcdRkbnZgV6_y1c1C0THHQl5_fmpC2gQ,3347
@@ -30,12 +33,16 @@ sqlshell/sqlshell/create_test_data.py,sha256=TFXgWeK1l3l_c4Dg38yS8Df4sBUfOZcBucX
 sqlshell/sqlshell/create_test_databases.py,sha256=oqryFJJahqLFsAjBFM4r9Fe1ea7djDcRpT9U_aBf7PU,3573
 sqlshell/ui/__init__.py,sha256=2CsTDAvRZJ99gkjs3-rdwkxyGVAKXX6ueOhPdP1VXQc,206
 sqlshell/ui/bar_chart_delegate.py,sha256=tbtIt2ZqPIcYWNJzpONpYa0CYURkLdjkg23TI7TmOKY,1881
-sqlshell/ui/filter_header.py,sha256=c4Mg1J1yTUfrnT9C-xDWHhcauRsgU3WNfvVInv1J814,16074
+sqlshell/ui/filter_header.py,sha256=s2PfqVTCrQjNOtTYfiR50HL6PIVwlL5kF7lO4PGPTko,18196
 sqlshell/utils/__init__.py,sha256=iPKvOsKcfnV7xvhQVOz8BiQ4kbFZ7PGUW8vg0vyMqvk,225
+sqlshell/utils/profile_column.py,sha256=QlnjyzFMUNHAKuggMYED0LkDs6BxWe9CnsLEr4rtEWE,113425
+sqlshell/utils/profile_distributions.py,sha256=1AcgubrouKYCiVoXtYz6RVX8kXSp6VaoEoJInXMU0RU,25379
 sqlshell/utils/profile_entropy.py,sha256=pJTcXlBkSEPzL3Fvxizf5gBkw6IsUjfa9Y6MjAqF1do,13238
+sqlshell/utils/profile_foreign_keys.py,sha256=kF4PeJLHXjVPpnLhM7ERlm3Z3r75QgX6a9gpMNWlgjA,23227
 sqlshell/utils/profile_keys.py,sha256=ajdBTqvZVmAlVaY-kDmv_D8D3sKASG75PLTzf8Y8nX4,14170
-sqlshell-0.2.2.dist-info/METADATA,sha256=CL9bP1ILqQPtblWIoEKxfAbxfIGFvPF4ZEAj1c5Xrws,6101
-sqlshell-0.2.2.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
-sqlshell-0.2.2.dist-info/entry_points.txt,sha256=Kd0fOvyOW7UiTgTVY7abVOmDIH2Y2nawGTp5kVadac4,44
-sqlshell-0.2.2.dist-info/top_level.txt,sha256=ahwsMFhvAqI97ZkT2xvHL5iZCO1p13mNiUOFkdSFwms,9
-sqlshell-0.2.2.dist-info/RECORD,,
+sqlshell/utils/profile_ohe.py,sha256=yXsYtHnyhtvdBpKvJEqu20e2t4qo0kJE8Rvl0bAogPs,24644
+sqlshell-0.3.0.dist-info/METADATA,sha256=IPsuPMIwGVLLGTGpFo2334uUHhZrWxJIpAOsC1-KAdc,15362
+sqlshell-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sqlshell-0.3.0.dist-info/entry_points.txt,sha256=Kd0fOvyOW7UiTgTVY7abVOmDIH2Y2nawGTp5kVadac4,44
+sqlshell-0.3.0.dist-info/top_level.txt,sha256=ahwsMFhvAqI97ZkT2xvHL5iZCO1p13mNiUOFkdSFwms,9
+sqlshell-0.3.0.dist-info/RECORD,,

{sqlshell-0.2.2.dist-info → sqlshell-0.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sqlshell-0.2.2.dist-info/METADATA

@@ -1,198 +0,0 @@
-Metadata-Version: 2.4
-Name: sqlshell
-Version: 0.2.2
-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.