tinyleaf 0.1.0__tar.gz

tinyleaf-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Oaklight
+
+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.

tinyleaf-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: tinyleaf
+Version: 0.1.0
+Summary: Lightweight web-based LaTeX editor powered by TeX Live
+Author-email: Oaklight <oaklight@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/Oaklight/tinyleaf
+Project-URL: Issues, https://github.com/Oaklight/tinyleaf/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: complexipy>=5.2.0; extra == "dev"
+Requires-Dist: ruff>=0.15.0; extra == "dev"
+Requires-Dist: ty>=0.0.31; extra == "dev"
+Requires-Dist: build>=1.2.2.post1; extra == "dev"
+Requires-Dist: twine>=6.1.0; extra == "dev"
+Dynamic: license-file
+
+# tinyleaf
+
+[中文版](./README_zh.md)
+
+Lightweight, zero-dependency web-based LaTeX editor. Powered by [TeX Live Docker images](https://github.com/Oaklight/texlive).
+
+## Features
+
+* **CLI-first** — `pip install tinyleaf && tinyleaf /path` to start editing
+* **Two modes** — Single project or multi-project with registry (`~/.config/tinyleaf/projects.json`)
+* **Two compilation backends** — Local `latexmk` (default) or Docker
+* **CodeMirror 6** editor with LaTeX syntax highlighting
+* **PDF.js** preview with live reload after compilation
+* **SSE** real-time compilation log streaming
+* **Git integration** — auto-detect `.git`, commit/push from UI
+* **Zero Python dependencies** — stdlib only (`http.server` + `threading` + `subprocess`)
+* **7 themes** with dark/light toggle
+* **i18n** — English and Chinese
+
+## Quick Start
+
+```bash
+pip install tinyleaf
+
+# Single project mode (local compilation)
+tinyleaf /path/to/my-thesis
+
+# Single project mode (Docker compilation)
+tinyleaf /path/to/my-thesis --docker
+
+# Multi-project mode (registry)
+tinyleaf
+```
+
+## Usage
+
+```
+usage: tinyleaf [-h] [--projects-dir DIR] [--config-dir DIR] [--docker]
+                [--image IMAGE] [--port PORT] [--host HOST] [--no-browser]
+                [project_path]
+
+positional arguments:
+  project_path          Single project directory to open
+
+options:
+  --config-dir DIR      Config directory for project registry
+                        (default: ~/.config/tinyleaf)
+  --projects-dir DIR    Legacy: migrate subdirs into registry
+  --docker              Use Docker for compilation (default: local latexmk)
+  --image IMAGE         Docker image to use (default: oaklight/texlive:latest)
+  --port PORT           Server port (default: 8080)
+  --host HOST           Server host (default: 127.0.0.1)
+  --no-browser          Don't auto-open browser on start
+```
+
+## Multi-Project Registry
+
+When launched without a `project_path`, tinyleaf enters **multi-project mode**. Projects are tracked in `~/.config/tinyleaf/projects.json` — each entry maps a name to an absolute path anywhere on the filesystem.
+
+From the project page you can:
+
+- **Open Folder** — browse the server filesystem and register an existing directory
+- **New Project** — create a new project at a chosen location
+- **Remove** — unregister a project (optionally delete files)
+
+## Keyboard Shortcuts
+
+| Shortcut | Action |
+|----------|--------|
+| `Ctrl+S` | Save current file |
+| `Ctrl+Enter` | Compile |
+| `Ctrl+Shift+C` | Git commit |
+| `Ctrl+Shift+P` | Git push |
+
+## Docker Compose
+
+For a self-contained setup with Docker compilation:
+
+```bash
+docker compose up
+```
+
+This starts the web editor on `http://localhost:8080` with a persistent TeX Live container for compilation.
+
+## License
+
+MIT

tinyleaf-0.1.0/README.md

@@ -0,0 +1,87 @@
+# tinyleaf
+
+[中文版](./README_zh.md)
+
+Lightweight, zero-dependency web-based LaTeX editor. Powered by [TeX Live Docker images](https://github.com/Oaklight/texlive).
+
+## Features
+
+* **CLI-first** — `pip install tinyleaf && tinyleaf /path` to start editing
+* **Two modes** — Single project or multi-project with registry (`~/.config/tinyleaf/projects.json`)
+* **Two compilation backends** — Local `latexmk` (default) or Docker
+* **CodeMirror 6** editor with LaTeX syntax highlighting
+* **PDF.js** preview with live reload after compilation
+* **SSE** real-time compilation log streaming
+* **Git integration** — auto-detect `.git`, commit/push from UI
+* **Zero Python dependencies** — stdlib only (`http.server` + `threading` + `subprocess`)
+* **7 themes** with dark/light toggle
+* **i18n** — English and Chinese
+
+## Quick Start
+
+```bash
+pip install tinyleaf
+
+# Single project mode (local compilation)
+tinyleaf /path/to/my-thesis
+
+# Single project mode (Docker compilation)
+tinyleaf /path/to/my-thesis --docker
+
+# Multi-project mode (registry)
+tinyleaf
+```
+
+## Usage
+
+```
+usage: tinyleaf [-h] [--projects-dir DIR] [--config-dir DIR] [--docker]
+                [--image IMAGE] [--port PORT] [--host HOST] [--no-browser]
+                [project_path]
+
+positional arguments:
+  project_path          Single project directory to open
+
+options:
+  --config-dir DIR      Config directory for project registry
+                        (default: ~/.config/tinyleaf)
+  --projects-dir DIR    Legacy: migrate subdirs into registry
+  --docker              Use Docker for compilation (default: local latexmk)
+  --image IMAGE         Docker image to use (default: oaklight/texlive:latest)
+  --port PORT           Server port (default: 8080)
+  --host HOST           Server host (default: 127.0.0.1)
+  --no-browser          Don't auto-open browser on start
+```
+
+## Multi-Project Registry
+
+When launched without a `project_path`, tinyleaf enters **multi-project mode**. Projects are tracked in `~/.config/tinyleaf/projects.json` — each entry maps a name to an absolute path anywhere on the filesystem.
+
+From the project page you can:
+
+- **Open Folder** — browse the server filesystem and register an existing directory
+- **New Project** — create a new project at a chosen location
+- **Remove** — unregister a project (optionally delete files)
+
+## Keyboard Shortcuts
+
+| Shortcut | Action |
+|----------|--------|
+| `Ctrl+S` | Save current file |
+| `Ctrl+Enter` | Compile |
+| `Ctrl+Shift+C` | Git commit |
+| `Ctrl+Shift+P` | Git push |
+
+## Docker Compose
+
+For a self-contained setup with Docker compilation:
+
+```bash
+docker compose up
+```
+
+This starts the web editor on `http://localhost:8080` with a persistent TeX Live container for compilation.
+
+## License
+
+MIT

tinyleaf-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tinyleaf"
+dynamic = ["version"]
+authors = [{ name = "Oaklight", email = "oaklight@users.noreply.github.com" }]
+description = "Lightweight web-based LaTeX editor powered by TeX Live"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+
+[project.urls]
+Repository = "https://github.com/Oaklight/tinyleaf"
+Issues = "https://github.com/Oaklight/tinyleaf/issues"
+
+[project.scripts]
+tinyleaf = "tinyleaf.cli:main"
+
+[project.optional-dependencies]
+dev = [
+    "complexipy>=5.2.0",
+    "ruff>=0.15.0",
+    "ty>=0.0.31",
+    "build>=1.2.2.post1",
+    "twine>=6.1.0",
+]
+
+[tool.setuptools.dynamic]
+version = { attr = "tinyleaf.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"tinyleaf" = ["static/*.html"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "UP"]
+ignore = ["UP007", "E501"]
+
+[tool.ty.environment]
+python-version = "3.10"
+
+[tool.ty.src]
+include = ["src"]
+
+[tool.ty.rules]
+unresolved-import = "ignore"

tinyleaf-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tinyleaf-0.1.0/src/tinyleaf/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

tinyleaf-0.1.0/src/tinyleaf/cli.py

@@ -0,0 +1,165 @@
+"""CLI entry point for tinyleaf."""
+
+import argparse
+import os
+import shutil
+import sys
+import webbrowser
+
+from tinyleaf import registry
+from tinyleaf.server import run_server
+
+DEFAULT_CONFIG_DIR = os.path.join(os.path.expanduser("~"), ".config", "tinyleaf")
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="tinyleaf",
+        description="Lightweight web-based LaTeX editor",
+    )
+    parser.add_argument(
+        "project_path",
+        nargs="?",
+        help="Single project directory to open",
+    )
+    parser.add_argument(
+        "--projects-dir",
+        metavar="DIR",
+        help="Legacy: migrate subdirs into registry, then use registry mode",
+    )
+    parser.add_argument(
+        "--config-dir",
+        metavar="DIR",
+        default=DEFAULT_CONFIG_DIR,
+        help=f"Config directory for project registry (default: {DEFAULT_CONFIG_DIR})",
+    )
+    parser.add_argument(
+        "--docker",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="Use Docker for compilation (default: enabled)",
+    )
+    parser.add_argument(
+        "--image",
+        default="oaklight/texlive:alpine-science-cn",
+        help="Docker image to use (default: oaklight/texlive:alpine-science-cn)",
+    )
+    parser.add_argument(
+        "--port",
+        type=int,
+        default=8080,
+        help="Server port (default: 8080)",
+    )
+    parser.add_argument(
+        "--host",
+        default="127.0.0.1",
+        help="Server host (default: 127.0.0.1)",
+    )
+    parser.add_argument(
+        "--no-browser",
+        action="store_true",
+        help="Don't auto-open browser on start",
+    )
+
+    args = parser.parse_args()
+
+    # Validate
+    if args.project_path and args.projects_dir:
+        parser.error("Cannot specify both project_path and --projects-dir")
+
+    # Determine mode
+    if args.project_path:
+        mode = "single"
+        project_path = os.path.abspath(args.project_path)
+        if not os.path.isdir(project_path):
+            print(f"Error: '{project_path}' is not a directory", file=sys.stderr)
+            sys.exit(1)
+        config_dir = None
+    else:
+        mode = "multi"
+        config_dir = os.path.abspath(args.config_dir)
+        registry.ensure_config_dir(config_dir)
+        project_path = None
+
+        # Backward compat: migrate --projects-dir subdirs into registry
+        if args.projects_dir:
+            projects_dir = os.path.abspath(args.projects_dir)
+            if os.path.isdir(projects_dir):
+                count = _migrate_projects_dir(config_dir, projects_dir)
+                if count:
+                    print(f"  Migrated {count} project(s) from {projects_dir}")
+
+        # Auto-download vendor JS modules on first start
+        from tinyleaf import vendor
+
+        vendor_dir = os.path.join(config_dir, "vendor")
+        if not vendor.is_vendor_ready(vendor_dir):
+            proxy = vendor.load_proxy(config_dir)
+            print("  Downloading JS modules...")
+            if proxy:
+                print(f"  Using proxy: {proxy}")
+            try:
+                vendor.download_vendor(vendor_dir, proxy=proxy)
+                print("  JS modules ready")
+            except Exception as e:
+                print(f"  Warning: failed to download JS modules: {e}", file=sys.stderr)
+                print("  Editor will try CDN as fallback", file=sys.stderr)
+
+    # Check compilation backend
+    use_docker = args.docker
+    if not use_docker and not shutil.which("latexmk"):
+        print(
+            "Warning: 'latexmk' not found in PATH. Add --docker to use Docker for compilation.",
+            file=sys.stderr,
+        )
+        print("Continuing anyway — compilation will fail without latexmk.", file=sys.stderr)
+
+    if use_docker and not shutil.which("docker"):
+        print("Error: --docker specified but 'docker' not found in PATH", file=sys.stderr)
+        sys.exit(1)
+
+    config = {
+        "mode": mode,
+        "project_path": project_path,
+        "config_dir": config_dir,
+        "use_docker": use_docker,
+        "docker_image": args.image,
+        "host": args.host,
+        "port": args.port,
+    }
+
+    url = f"http://{args.host}:{args.port}"
+    print(f"Starting tinyleaf ({mode} mode)")
+    if use_docker:
+        print(f"  Compiler: Docker ({args.image})")
+    else:
+        print("  Compiler: local latexmk")
+    if mode == "single":
+        print(f"  Project:  {project_path}")
+    else:
+        print(f"  Config:   {config_dir}")
+    print(f"  URL:      {url}")
+
+    if not args.no_browser:
+        webbrowser.open(url)
+
+    run_server(config)
+
+
+def _migrate_projects_dir(config_dir, projects_dir):
+    """Migrate subdirectories of a projects dir into the registry."""
+    count = 0
+    for entry in sorted(os.listdir(projects_dir)):
+        full = os.path.join(projects_dir, entry)
+        if not os.path.isdir(full) or entry.startswith("."):
+            continue
+        try:
+            registry.register_project(config_dir, entry, full)
+            count += 1
+        except ValueError:
+            pass  # name collision, skip
+    return count
+
+
+if __name__ == "__main__":
+    main()