openduck-cli 0.1.0__tar.gz → 0.1.2__tar.gz

{openduck_cli-0.1.0 → openduck_cli-0.1.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: openduck-cli
-Version: 0.1.0
-Summary: The Modern, Lightning-Fast Terminal SQL IDE & Data Explorer for DuckDB
+Version: 0.1.2
+Summary: A flat file SQL client based on DuckDB
 Author: Bertatron
 License-Expression: MIT
 Requires-Python: >=3.10
@@ -19,7 +19,7 @@ Requires-Dist: pymssql; extra == "db"
 # 🦆 OpenDuck
 
 <p align="center">
-  <b>The Modern, Lightning-Fast Terminal SQL IDE & Data Explorer for DuckDB</b>
+  <b>A flat file SQL client based on DuckDB</b>
 </p>
 
 <p align="center">
@@ -35,7 +35,7 @@ Requires-Dist: pymssql; extra == "db"
   <img width="100%" alt="OpenDuck Interface" src="https://github.com/user-attachments/assets/4aea9df6-6f00-494d-a171-d76a9a3b8133" />
 </p>
 
-**OpenDuck** brings the power and speed of **DuckDB** straight to your terminal in an intuitive, multi-tab Text User Interface (TUI). Effortlessly browse files, inspect datasets, write queries with full syntax highlighting, sort and filter millions of rows in milliseconds, and export results — all without leaving your shell.
+**OpenDuck** is a terminal-based flat file SQL client based on DuckDB. Effortlessly browse files, inspect datasets, write queries with full syntax highlighting, sort and filter millions of rows in milliseconds, and export results — all without leaving your shell.
 
 ---
 
@@ -82,33 +82,59 @@ OpenDuck automatically recognises and formats queries for:
 
 ### 1. Installation
 
-**Via PyPI:**
+**Recommended: Install via `pip3` from PyPI**
 ```bash
-pip install openduck-cli
+pip3 install openduck-cli
+```
+
+> **Tip:** If your system manages Python externally (e.g., Debian/Ubuntu PEP 668), install into a virtual environment or use `pipx`:
+> ```bash
+> python3 -m venv ~/.openduck-venv
+> ~/.openduck-venv/bin/pip3 install openduck-cli
+> # Create a symlink to run it from anywhere:
+> sudo ln -s ~/.openduck-venv/bin/openduck /usr/local/bin/openduck
+> ```
+
+**Via Docker (Zero local setup):**
+```bash
+# Run directly with Docker mounting your current data directory:
+docker run -it --rm -v "$(pwd):/data" python:3.12-slim sh -c "pip3 install --no-cache-dir openduck-cli && openduck"
+
+# Or build the included Dockerfile:
+docker build -t openduck .
+docker run -it --rm -v "$(pwd):/data" openduck
 ```
 
 **From source:**
 ```bash
 git clone https://github.com/klandermans/openduck.git
 cd openduck
-pip install -r requirements.txt
-# or: pip install -e .
+pip3 install -r requirements.txt
+# or install in editable mode:
+pip3 install -e .
 ```
 
 > **Note:** `textual[syntax]` installs the required `tree-sitter` and `tree-sitter-sql` engines for syntax highlighting out of the box.
 
+---
+
 ### 2. Run OpenDuck
 
+After installing with `pip3`, run it directly from any directory:
+
 ```bash
-python openduck.py
+openduck
 ```
+*(or `openduck-cli`)*
 
-Or make it available system-wide as a command:
+If you cloned the source repository:
 
 ```bash
-chmod +x openduck.sh
-sudo cp openduck.sh /usr/local/bin/openduck
-openduck
+python3 openduck.py
+# or
+python3 -m openduck
+# or with the shell wrapper:
+./openduck.sh
 ```
 
 ---

{openduck_cli-0.1.0 → openduck_cli-0.1.2}/README.md

@@ -1,7 +1,7 @@
 # 🦆 OpenDuck
 
 <p align="center">
-  <b>The Modern, Lightning-Fast Terminal SQL IDE & Data Explorer for DuckDB</b>
+  <b>A flat file SQL client based on DuckDB</b>
 </p>
 
 <p align="center">
@@ -17,7 +17,7 @@
   <img width="100%" alt="OpenDuck Interface" src="https://github.com/user-attachments/assets/4aea9df6-6f00-494d-a171-d76a9a3b8133" />
 </p>
 
-**OpenDuck** brings the power and speed of **DuckDB** straight to your terminal in an intuitive, multi-tab Text User Interface (TUI). Effortlessly browse files, inspect datasets, write queries with full syntax highlighting, sort and filter millions of rows in milliseconds, and export results — all without leaving your shell.
+**OpenDuck** is a terminal-based flat file SQL client based on DuckDB. Effortlessly browse files, inspect datasets, write queries with full syntax highlighting, sort and filter millions of rows in milliseconds, and export results — all without leaving your shell.
 
 ---
 
@@ -64,33 +64,59 @@ OpenDuck automatically recognises and formats queries for:
 
 ### 1. Installation
 
-**Via PyPI:**
+**Recommended: Install via `pip3` from PyPI**
 ```bash
-pip install openduck-cli
+pip3 install openduck-cli
+```
+
+> **Tip:** If your system manages Python externally (e.g., Debian/Ubuntu PEP 668), install into a virtual environment or use `pipx`:
+> ```bash
+> python3 -m venv ~/.openduck-venv
+> ~/.openduck-venv/bin/pip3 install openduck-cli
+> # Create a symlink to run it from anywhere:
+> sudo ln -s ~/.openduck-venv/bin/openduck /usr/local/bin/openduck
+> ```
+
+**Via Docker (Zero local setup):**
+```bash
+# Run directly with Docker mounting your current data directory:
+docker run -it --rm -v "$(pwd):/data" python:3.12-slim sh -c "pip3 install --no-cache-dir openduck-cli && openduck"
+
+# Or build the included Dockerfile:
+docker build -t openduck .
+docker run -it --rm -v "$(pwd):/data" openduck
 ```
 
 **From source:**
 ```bash
 git clone https://github.com/klandermans/openduck.git
 cd openduck
-pip install -r requirements.txt
-# or: pip install -e .
+pip3 install -r requirements.txt
+# or install in editable mode:
+pip3 install -e .
 ```
 
 > **Note:** `textual[syntax]` installs the required `tree-sitter` and `tree-sitter-sql` engines for syntax highlighting out of the box.
 
+---
+
 ### 2. Run OpenDuck
 
+After installing with `pip3`, run it directly from any directory:
+
 ```bash
-python openduck.py
+openduck
 ```
+*(or `openduck-cli`)*
 
-Or make it available system-wide as a command:
+If you cloned the source repository:
 
 ```bash
-chmod +x openduck.sh
-sudo cp openduck.sh /usr/local/bin/openduck
-openduck
+python3 openduck.py
+# or
+python3 -m openduck
+# or with the shell wrapper:
+./openduck.sh
 ```
 
 ---

{openduck_cli-0.1.0 → openduck_cli-0.1.2}/openduck/__init__.py

@@ -1,6 +1,6 @@
-"""OpenDuck - The Modern Terminal SQL IDE & Data Explorer for DuckDB."""
+"""OpenDuck - A flat file SQL client based on DuckDB."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.2"
 
 from openduck.core.config import (
     CWD,

{openduck_cli-0.1.0 → openduck_cli-0.1.2}/openduck/gui/app.py

@@ -54,7 +54,7 @@ logger = logging.getLogger(__name__)
 
 
 class DuckCLI(App):
-    """The OpenDuck Terminal SQL IDE application."""
+    """OpenDuck - A flat file SQL client based on DuckDB."""
 
     ENABLE_MOUSE_SUPPORT = True
     ALLOW_SELECT = False

{openduck_cli-0.1.0 → openduck_cli-0.1.2}/openduck_cli.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: openduck-cli
-Version: 0.1.0
-Summary: The Modern, Lightning-Fast Terminal SQL IDE & Data Explorer for DuckDB
+Version: 0.1.2
+Summary: A flat file SQL client based on DuckDB
 Author: Bertatron
 License-Expression: MIT
 Requires-Python: >=3.10
@@ -19,7 +19,7 @@ Requires-Dist: pymssql; extra == "db"
 # 🦆 OpenDuck
 
 <p align="center">
-  <b>The Modern, Lightning-Fast Terminal SQL IDE & Data Explorer for DuckDB</b>
+  <b>A flat file SQL client based on DuckDB</b>
 </p>
 
 <p align="center">
@@ -35,7 +35,7 @@ Requires-Dist: pymssql; extra == "db"
   <img width="100%" alt="OpenDuck Interface" src="https://github.com/user-attachments/assets/4aea9df6-6f00-494d-a171-d76a9a3b8133" />
 </p>
 
-**OpenDuck** brings the power and speed of **DuckDB** straight to your terminal in an intuitive, multi-tab Text User Interface (TUI). Effortlessly browse files, inspect datasets, write queries with full syntax highlighting, sort and filter millions of rows in milliseconds, and export results — all without leaving your shell.
+**OpenDuck** is a terminal-based flat file SQL client based on DuckDB. Effortlessly browse files, inspect datasets, write queries with full syntax highlighting, sort and filter millions of rows in milliseconds, and export results — all without leaving your shell.
 
 ---
 
@@ -82,33 +82,59 @@ OpenDuck automatically recognises and formats queries for:
 
 ### 1. Installation
 
-**Via PyPI:**
+**Recommended: Install via `pip3` from PyPI**
 ```bash
-pip install openduck-cli
+pip3 install openduck-cli
+```
+
+> **Tip:** If your system manages Python externally (e.g., Debian/Ubuntu PEP 668), install into a virtual environment or use `pipx`:
+> ```bash
+> python3 -m venv ~/.openduck-venv
+> ~/.openduck-venv/bin/pip3 install openduck-cli
+> # Create a symlink to run it from anywhere:
+> sudo ln -s ~/.openduck-venv/bin/openduck /usr/local/bin/openduck
+> ```
+
+**Via Docker (Zero local setup):**
+```bash
+# Run directly with Docker mounting your current data directory:
+docker run -it --rm -v "$(pwd):/data" python:3.12-slim sh -c "pip3 install --no-cache-dir openduck-cli && openduck"
+
+# Or build the included Dockerfile:
+docker build -t openduck .
+docker run -it --rm -v "$(pwd):/data" openduck
 ```
 
 **From source:**
 ```bash
 git clone https://github.com/klandermans/openduck.git
 cd openduck
-pip install -r requirements.txt
-# or: pip install -e .
+pip3 install -r requirements.txt
+# or install in editable mode:
+pip3 install -e .
 ```
 
 > **Note:** `textual[syntax]` installs the required `tree-sitter` and `tree-sitter-sql` engines for syntax highlighting out of the box.
 
+---
+
 ### 2. Run OpenDuck
 
+After installing with `pip3`, run it directly from any directory:
+
 ```bash
-python openduck.py
+openduck
 ```
+*(or `openduck-cli`)*
 
-Or make it available system-wide as a command:
+If you cloned the source repository:
 
 ```bash
-chmod +x openduck.sh
-sudo cp openduck.sh /usr/local/bin/openduck
-openduck
+python3 openduck.py
+# or
+python3 -m openduck
+# or with the shell wrapper:
+./openduck.sh
 ```
 
 ---

{openduck_cli-0.1.0 → openduck_cli-0.1.2}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "openduck-cli"
-version = "0.1.0"
-description = "The Modern, Lightning-Fast Terminal SQL IDE & Data Explorer for DuckDB"
+version = "0.1.2"
+description = "A flat file SQL client based on DuckDB"
 readme = "README.md"
 authors = [{ name = "Bertatron" }]
 license = "MIT"