Zealpy 🚀

Zealpy is a lightweight, zero-dependency offline documentation browser and CLI for Dash and Zeal docsets.

Written in pure standard library Python, it runs anywhere without compiling C++ code, launches in milliseconds, and provides both a lightning-fast terminal CLI and a modern Dark Mode Web UI.

✨ Features

• ⚡ Zero External Dependencies: Runs entirely on Python's standard library (sqlite3, http.server, urllib, tarfile, plistlib). No heavy frameworks or compiler issues.
• 🔍 Instant Terminal Search: Query functions, methods, and classes right from your shell with colorized output.
• 🎨 Modern Dark Mode Web UI: Built-in responsive SPA interface with live search autocomplete, type filter pills, and embedded HTML documentation reader.
• 📦 Official Docset Downloader: Download and unpack documentation sets for Python, Qt, PyQt, Pandas, NumPy, Flask, Django, PostgreSQL, and 20+ other popular stacks directly from official mirrors.
• 🔄 Auto-detection of Existing Zeal Docsets: Automatically discovers docsets already installed by desktop Zeal (%LOCALAPPDATA%/Zeal/Zeal/docsets on Windows, ~/.local/share/Zeal/Zeal/docsets on Linux).
• 🛡️ Clean & Exam Safe: Perfect for offline environments, coding competitions, and exams where external GUI binaries might raise questions, but Python packages are fully permitted.

🚀 Quick Start

Installation

pip install zealpy

Or install locally in editable mode:

git clone https://github.com/RuttiTuttii/zealpy.git
cd zealpy
pip install -e .

💻 CLI Usage

1. Launch Documentation Server & Browser

zealpy serve

Starts the local documentation server at http://127.0.0.1:8080 and opens your browser.

Custom port or no browser popup:

zealpy serve --port 9090 --no-browser

2. Search Symbols Directly in Terminal

# Search across all installed docsets
zealpy search QComboBox

# Filter by docset
zealpy search groupby -d Pandas

# Filter by symbol type (Class, Method, Function, Module)
zealpy search connect -t Method

3. List Installed Docsets

zealpy list

4. Download Official Docsets

Check available docsets:

zealpy available

Download and install:

zealpy download Python
zealpy download Qt
zealpy download Pandas
zealpy download Flask

5. Import Local Docset Archive

zealpy add path/to/MyDocset.docset
# Or archives:
zealpy add path/to/Python.tgz

🐍 Python Library API

Zealpy can also be imported directly inside your Python scripts:

import zealpy

# Quick symbol search
results = zealpy.search("DataFrame.groupby")
for r in results:
    print(f"[{r.type}] {r.name} -> {r.url}")

# Manage docsets programmatically
manager = zealpy.DocsetManager()
python_docs = manager.get("Python_3")
if python_docs:
    print(f"Total symbols: {python_docs.count_entries()}")
    entries = python_docs.search("os.path.join")
    print(entries[0].path)

# Start web server programmatically
zealpy.serve(port=8080)

⌨️ Web UI Keyboard Shortcuts

📜 License

This project is licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later), preserving the license and open-source heritage of the original Zeal project created by Oleg Shparber.