sqlit-tui 0.4.2__tar.gz → 1.0.0__tar.gz

{sqlit_tui-0.4.2 → sqlit_tui-1.0.0}/.github/workflows/ci.yml

@@ -34,6 +34,39 @@ jobs:
         run: |
           python -c "from sqlit.cli import main; print('CLI import OK')"
 
+  test-unit:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]"
+
+      - name: Run unit tests
+        run: |
+          pytest tests/ -v --timeout=60 \
+            --ignore=tests/test_sqlite.py \
+            --ignore=tests/test_mssql.py \
+            --ignore=tests/test_postgresql.py \
+            --ignore=tests/test_mysql.py \
+            --ignore=tests/test_oracle.py \
+            --ignore=tests/test_mariadb.py \
+            --ignore=tests/test_duckdb.py \
+            --ignore=tests/test_cockroachdb.py \
+            --ignore=tests/test_turso.py \
+            --ignore=tests/test_ssh.py
+
   test-sqlite:
     runs-on: ubuntu-latest
     strategy:
@@ -448,3 +481,48 @@ jobs:
           docker stop sshserver postgres || true
           docker rm sshserver postgres || true
           docker network rm ssh-test-net || true
+
+  test-turso:
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]"
+          pip install libsql-client
+
+      - name: Start Turso (libsql-server)
+        run: |
+          docker run -d --name turso \
+            -p 8080:8080 \
+            ghcr.io/tursodatabase/libsql-server:latest
+          # Wait for Turso to be ready
+          for i in {1..30}; do
+            if curl -sf http://localhost:8080/health > /dev/null 2>&1; then
+              echo "Turso is ready"
+              break
+            fi
+            echo "Waiting for Turso... ($i/30)"
+            sleep 2
+          done
+
+      - name: Run Turso integration tests
+        env:
+          TURSO_URL: http://localhost:8080
+        run: |
+          pytest tests/test_turso.py -v --timeout=120
+
+      - name: Cleanup
+        if: always()
+        run: |
+          docker stop turso || true
+          docker rm turso || true

sqlit_tui-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,146 @@
+name: Release and Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release (e.g., 0.4.2)'
+        required: true
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract version from tag
+        id: version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          name: ${{ steps.version.outputs.VERSION }}
+          generate_release_notes: true
+          draft: false
+          prerelease: false
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract version from tag
+        id: version
+        run: |
+          if [ -n "${{ github.event.inputs.version }}" ]; then
+            echo "VERSION=${{ github.event.inputs.version }}" >> $GITHUB_OUTPUT
+          else
+            # Strip the 'v' prefix from the tag
+            echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Update version in pyproject.toml
+        run: |
+          VERSION=${{ steps.version.outputs.VERSION }}
+          echo "Setting version to $VERSION"
+          sed -i "s/^version = .*/version = \"$VERSION\"/" pyproject.toml
+          echo "Updated pyproject.toml:"
+          grep "^version" pyproject.toml
+
+      - name: Install build tools
+        run: python -m pip install --upgrade build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  aur:
+    needs: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract version
+        id: version
+        run: |
+          if [ -n "${{ github.event.inputs.version }}" ]; then
+            echo "VERSION=${{ github.event.inputs.version }}" >> $GITHUB_OUTPUT
+          else
+            echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Setup SSH for AUR
+        run: |
+          mkdir -p ~/.ssh
+          echo "${{ secrets.AUR_SSH_KEY }}" > ~/.ssh/aur
+          chmod 600 ~/.ssh/aur
+          echo "Host aur.archlinux.org" >> ~/.ssh/config
+          echo "  IdentityFile ~/.ssh/aur" >> ~/.ssh/config
+          echo "  User aur" >> ~/.ssh/config
+          ssh-keyscan aur.archlinux.org >> ~/.ssh/known_hosts
+
+      - name: Clone AUR repo
+        run: git clone ssh://aur@aur.archlinux.org/python-sqlit-tui.git aur-repo
+
+      - name: Update PKGBUILD
+        run: |
+          cd aur-repo
+          VERSION=${{ steps.version.outputs.VERSION }}
+
+          # Wait for PyPI to have the package available
+          sleep 30
+
+          # Download new tarball and get checksum
+          curl -sL "https://files.pythonhosted.org/packages/source/s/sqlit-tui/sqlit_tui-${VERSION}.tar.gz" -o /tmp/pkg.tar.gz
+          CHECKSUM=$(sha256sum /tmp/pkg.tar.gz | cut -d' ' -f1)
+
+          # Update version and checksum in PKGBUILD
+          sed -i "s/^pkgver=.*/pkgver=${VERSION}/" PKGBUILD
+          sed -i "s/^pkgrel=.*/pkgrel=1/" PKGBUILD
+          sed -i "s/^sha256sums=.*/sha256sums=('${CHECKSUM}')/" PKGBUILD
+
+          # Update .SRCINFO
+          sed -i "s/pkgver = .*/pkgver = ${VERSION}/" .SRCINFO
+          sed -i "s/sqlit_tui-[0-9.]*/sqlit_tui-${VERSION}/g" .SRCINFO
+          sed -i "s/sha256sums = .*/sha256sums = ${CHECKSUM}/" .SRCINFO
+
+      - name: Push to AUR
+        run: |
+          cd aur-repo
+          git config user.email "peter.w.adams96@gmail.com"
+          git config user.name "Peter"
+          git add PKGBUILD .SRCINFO
+          git diff --staged --quiet || git commit -m "Update to v${{ steps.version.outputs.VERSION }}"
+          git push

{sqlit_tui-0.4.2 → sqlit_tui-1.0.0}/.gitignore

@@ -19,6 +19,11 @@ venv/
 *.swp
 *.swo
 
+# Local caches
+.cache/
+.ruff_cache/
+.sqlit/
+
 # OS
 .DS_Store
 
@@ -26,3 +31,18 @@ venv/
 docker-compose.yml
 init.sql
 *.tape
+.tmp/
+demos/drafts/
+
+# Database files
+*.db
+
+# AUR build artifacts
+aur/*.tar.gz
+aur/src/
+aur/pkg/
+aur/*.pkg.tar.*
+sqlit-notifications/
+
+# Integration test artifacts
+tests/integration/python_packages/artifacts/

sqlit_tui-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: check-merge-conflict

sqlit_tui-1.0.0/.sqlit-config/settings.json

@@ -0,0 +1,4 @@
+{
+  "theme": "tokyo-night",
+  "expanded_nodes": []
+}

sqlit_tui-1.0.0/PKG-INFO

@@ -0,0 +1,282 @@
+Metadata-Version: 2.4
+Name: sqlit-tui
+Version: 1.0.0
+Summary: A terminal UI for SQL Server, PostgreSQL, MySQL, SQLite, and Oracle
+Project-URL: Homepage, https://github.com/Maxteabag/sqlit
+Project-URL: Repository, https://github.com/Maxteabag/sqlit
+Project-URL: Issues, https://github.com/Maxteabag/sqlit/issues
+Author: Peter
+License-Expression: MIT
+License-File: LICENSE
+Keywords: database,mssql,mysql,oracle,postgresql,server,sql,sqlite,terminal,tui
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Requires-Python: >=3.10
+Requires-Dist: keyring>=24.0.0
+Requires-Dist: paramiko<4.0.0,>=2.0.0
+Requires-Dist: pyperclip>=1.8.2
+Requires-Dist: sshtunnel>=0.4.0
+Requires-Dist: textual[syntax]>=6.10.0
+Provides-Extra: all
+Requires-Dist: duckdb>=0.9.0; extra == 'all'
+Requires-Dist: libsql-client>=0.1.0; extra == 'all'
+Requires-Dist: mariadb>=1.1.0; extra == 'all'
+Requires-Dist: mysql-connector-python>=8.0.0; extra == 'all'
+Requires-Dist: oracledb>=2.0.0; extra == 'all'
+Requires-Dist: psycopg2-binary>=2.9.0; extra == 'all'
+Requires-Dist: pyodbc>=5.0.0; extra == 'all'
+Requires-Dist: requests>=2.0.0; extra == 'all'
+Provides-Extra: cockroachdb
+Requires-Dist: psycopg2-binary>=2.9.0; extra == 'cockroachdb'
+Provides-Extra: d1
+Requires-Dist: requests>=2.0.0; extra == 'd1'
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Provides-Extra: duckdb
+Requires-Dist: duckdb>=0.9.0; extra == 'duckdb'
+Provides-Extra: mariadb
+Requires-Dist: mariadb>=1.1.0; extra == 'mariadb'
+Provides-Extra: mssql
+Requires-Dist: pyodbc>=5.0.0; extra == 'mssql'
+Provides-Extra: mysql
+Requires-Dist: mysql-connector-python>=8.0.0; extra == 'mysql'
+Provides-Extra: oracle
+Requires-Dist: oracledb>=2.0.0; extra == 'oracle'
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9.0; extra == 'postgres'
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest-timeout>=2.0; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Provides-Extra: turso
+Requires-Dist: libsql-client>=0.1.0; extra == 'turso'
+Description-Content-Type: text/markdown
+
+# sqlit
+
+**The lazygit of SQL databases.** Connect to Postgres, MySQL, SQL Server, SQLite, Supabase, Turso, and more from your terminal in seconds.
+
+A lightweight TUI for people who just want to run some queries fast.
+
+![Python](https://img.shields.io/badge/python-3.10+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+### Multi-database Support
+![Database Providers](demos/demo-providers.gif)
+
+### Query History
+![Query History](demos/demo-history.gif)
+
+
+## Features
+
+- **Connection manager UI** - Save connections, switch between databases without CLI args
+- **Just run `sqlit`** - No CLI config needed, pick a connection and go
+- **Multi-database out of the box** - SQL Server, PostgreSQL, MySQL, SQLite, MariaDB, Oracle, DuckDB, CockroachDB, Supabase, Turso - no adapters to install
+- **SSH tunnels built-in** - Connect to remote databases securely with password or key auth
+- **Vim-style editing** - Modal editing for terminal purists
+- **Query history** - Automatically saves queries per connection, searchable and sortable
+- Context-aware help (no need to memorize keybindings)
+- Browse databases, tables, views, and stored procedures
+- SQL autocomplete for tables, columns, and procedures
+- Multiple auth methods (Windows, SQL Server, Entra ID)
+- CLI mode for scripting and AI agents
+- Themes (Tokyo Night, Nord, and more)
+- Auto-detects and installs ODBC drivers (SQL Server)
+
+
+## Motivation
+I usually do my work in the terminal, but I found myself either having to boot up massively bloated GUI's like SSMS or Vscode for the simple task of merely browsing my databases and doing some queries toward them. For the vast majority of my use cases, I never used any of the advanced features for inspection and debugging that SSMS and other feature-rich clients provide.
+
+I had the unfortunate situation where doing queries became a pain-point due to the massive operation it is to open SSMS and it's lack of intuitive keyboard only navigation.
+
+The problem got severely worse when I switched to Linux and had to rely on VS CODE's SQL extension to access my database. Something was not right.
+
+I tried to use some existing TUI's for SQL, but they were not intuitive for me and I missed the immediate ease of use that other TUI's such as Lazygit provides.
+
+sqlit is a lightweight database TUI that is easy to use and beautiful to look at, just connect and query. It's for you that just wants to run queries toward your database without launching applications that eats your ram and takes time to load up. Sqlit supports SQL Server, PostgreSQL, MySQL, SQLite, MariaDB, Oracle, DuckDB, CockroachDB, Supabase, and Turso, and is designed to make it easy and enjoyable to access your data, not painful.
+
+
+## Installation
+
+### Method 1: `pipx` (Recommended)
+
+1.  **Install pipx:** If you don't have pipx, you can install it with:
+    ```bash
+    python3 -m pip install --user pipx
+    python3 -m pipx ensurepath
+    ```
+
+2.  **Install sqlit-tui:**
+    ```bash
+    pipx install sqlit-tui
+    ```
+
+### Method 2: `uv`
+
+`uv` is a fast, modern installer. This also keeps things isolated and makes optional drivers easy.
+
+```bash
+uv tool install sqlit-tui
+```
+
+### Method 3: `pip`
+
+```bash
+pip install "sqlit-tui"
+```
+
+## Usage
+
+```bash
+sqlit
+```
+
+The keybindings are shown at the bottom of the screen.
+
+### Try it without a database
+
+Want to explore the UI without connecting to a real database? Run with mock data:
+
+```bash
+sqlit --mock=sqlite-demo
+```
+
+### CLI
+
+```bash
+# Run a query
+sqlit query -c "MyConnection" -q "SELECT * FROM Users"
+
+# Output as CSV or JSON
+sqlit query -c "MyConnection" -q "SELECT * FROM Users" --format csv
+sqlit query -c "MyConnection" -f "script.sql" --format json
+
+# Create connections for different databases
+sqlit connections add mssql --name "MySqlServer" --server "localhost" --auth-type sql
+sqlit connections add postgresql --name "MyPostgres" --server "localhost" --username "user" --password "pass"
+sqlit connections add mysql --name "MyMySQL" --server "localhost" --username "user" --password "pass"
+sqlit connections add cockroachdb --name "MyCockroach" --server "localhost" --port "26257" --database "defaultdb" --username "root"
+sqlit connections add sqlite --name "MyLocalDB" --file-path "/path/to/database.db"
+sqlit connections add turso --name "MyTurso" --server "libsql://your-db.turso.io" --password "your-auth-token"
+
+# Connect via SSH tunnel
+sqlit connections add postgresql --name "RemoteDB" --server "db-host" --username "dbuser" --password "dbpass" \
+  --ssh-enabled --ssh-host "ssh.example.com" --ssh-username "sshuser" --ssh-auth-type password --ssh-password "sshpass"
+
+# Temporary (not saved) connection
+sqlit connect sqlite --file-path "/path/to/database.db"
+
+# Provider-specific CLI help
+sqlit connect -h
+sqlit connect supabase -h
+sqlit connections add -h
+sqlit connections add supabase -h
+
+# Manage connections
+sqlit connections list
+sqlit connections delete "MyConnection"
+```
+
+## Keybindings
+
+| Key | Action |
+|-----|--------|
+| `i` | Enter INSERT mode |
+| `Esc` | Back to NORMAL mode |
+| `e` / `q` / `r` | Focus Explorer / Query / Results |
+| `s` | SELECT TOP 100 from table |
+| `h` | Query history |
+| `d` | Clear query |
+| `n` | New query (clear all) |
+| `y` | Copy query (when query editor is focused) |
+| `v` / `y` / `Y` / `a` | View cell / Copy cell / Copy row / Copy all |
+| `Ctrl+Q` | Quit |
+| `?` | Help |
+
+### Commands Menu (`<space>`)
+
+| Key | Action |
+|-----|--------|
+| `<space>c` | Connect to database |
+| `<space>x` | Disconnect |
+| `<space>z` | Cancel running query |
+| `<space>e` | Toggle Explorer |
+| `<space>f` | Toggle Maximize |
+| `<space>t` | Change theme |
+| `<space>h` | Help |
+| `<space>q` | Quit |
+
+Autocomplete triggers automatically in INSERT mode. Use `Tab` to accept.
+
+You can also receive autocompletion on columns by typing the table name and hitting "."
+
+## Configuration
+
+Connections and settings are stored in `~/.sqlit/`.
+
+## FAQ
+
+### How are sensitive credentials stored?
+
+Connection details are stored in `~/.sqlit/connections.json`, but passwords are stored in your OS keyring when available (macOS Keychain, Windows Credential Locker, Linux Secret Service).
+
+If a keyring backend isn't available, `sqlit` will ask whether to store passwords as plaintext in `~/.sqlit/` (protected permissions). If you decline, you’ll be prompted when needed.
+
+### How does sqlit compare to Harlequin, Lazysql, etc.?
+
+sqlit is inspired by [lazygit](https://github.com/jesseduffield/lazygit) - you can just jump in and there's no need for external documentation. The keybindings are shown at the bottom of the screen and the UI is designed to be intuitive without memorizing shortcuts.
+
+Key differences:
+- **No need for external documentation** - Sqlit embrace the "lazy" approach in that a user should be able to jump in and use it right away intuitively. There should be no setup instructions. If python packages are required for certain adapters, sqlit will help you install them as you need them.
+- **No CLI config required** - Just run `sqlit` and pick a connection from the UI
+- **Lightweight** - While Lazysql or Harlequin offer more features, I experienced that for the vast majority of cases, all I needed was a simple and fast way to connect and run queries. Sqlit is focused on doing a limited amount of things really well.
+
+## Inspiration
+
+sqlit is built with [Textual](https://github.com/Textualize/textual) and inspired by:
+- [lazygit](https://github.com/jesseduffield/lazygit) - Simple  TUI for git
+- [lazysql](https://github.com/jorgerojas26/lazysql) - Terminal-based SQL client with connection manager
+
+## Contributing
+
+See `CONTRIBUTING.md` for development setup, testing, CI, and CockroachDB quickstart steps.
+
+### Driver Reference
+
+Most of the time you can just run `sqlit` and connect. If a Python driver is missing, `sqlit` will show (and often run) the right install command for your environment.
+
+| Database | Driver package | `pipx` | `pip` / venv |
+| :--- | :--- | :--- | :--- |
+| SQLite | *(built-in)* | *(built-in)* | *(built-in)* |
+| PostgreSQL / CockroachDB / Supabase | `psycopg2-binary` | `pipx inject sqlit-tui psycopg2-binary` | `python -m pip install psycopg2-binary` |
+| SQL Server | `pyodbc` | `pipx inject sqlit-tui pyodbc` | `python -m pip install pyodbc` |
+| MySQL | `mysql-connector-python` | `pipx inject sqlit-tui mysql-connector-python` | `python -m pip install mysql-connector-python` |
+| MariaDB | `mariadb` | `pipx inject sqlit-tui mariadb` | `python -m pip install mariadb` |
+| Oracle | `oracledb` | `pipx inject sqlit-tui oracledb` | `python -m pip install oracledb` |
+| DuckDB | `duckdb` | `pipx inject sqlit-tui duckdb` | `python -m pip install duckdb` |
+| Turso | `libsql-client` | `pipx inject sqlit-tui libsql-client` | `python -m pip install libsql-client` |
+| Cloudflare D1 | `requests` | `pipx inject sqlit-tui requests` | `python -m pip install requests` |
+
+**Note:** SQL Server also requires the platform-specific ODBC driver. On your first connection attempt, `sqlit` can help you install it if it's missing.
+
+## License
+
+MIT