scitex-repl

Interactive-REPL helpers (`embed`, `less`, `paste`) — clipboard-aware IPython workflows.

Full Documentation · uv pip install scitex-repl[all]

Problem and Solution

Quick Start

import scitex_repl

# Exec the current clipboard contents (dedented first).
scitex_repl.paste()

# Pipe a string through the system `less` pager.
scitex_repl.less("a very long string ...")

# Drop into an IPython shell, optionally pre-executing the clipboard.
scitex_repl.embed()

Demo

sequenceDiagram
    participant U as user code
    participant C as clipboard
    participant P as paste()
    participant W as diagnostics
    U->>C: copy indented snippet
    C->>P: pyperclip.paste()
    P->>P: textwrap.dedent()
    P->>U: exec in current scope
    Note over P,W: on failure: log an error diagnostic, do not propagate

_{Figure 1. Copy-paste-run loop: the clipboard is dedented, executed in scope, and failures surface as diagnostics.}

Installation

uv pip install "scitex-repl[all]"

Through the umbrella: uv pip install "scitex[repl]". Requires Python ≥ 3.9.

Architecture

flowchart LR
    U["user code"] --> E["_embed.py: embed()"]
    U --> L["_less.py: less(output)"]
    U --> P["_paste.py: paste()"]
    E --> IP["IPython.embed + pyperclip"]
    L --> PG["less via get_ipython().system"]
    P --> EX["textwrap.dedent + exec"]
    EX --> LG["scitex-logging diagnostics"]

_{Figure 2. Three thin helpers over IPython and pyperclip: embed, page, and exec-with-diagnostics.}

3 Interfaces

import scitex_repl

# Drop into an IPython shell, optionally pre-executing the clipboard.
scitex_repl.embed()

# Pipe a string through the system `less` pager.
scitex_repl.less("a very long string ...")

# Exec the current clipboard contents.
scitex_repl.paste()

Status

• less and paste are functional thin wrappers over IPython / pyperclip.
• embed is preserved from the upstream — the upstream file was mostly commented-out scaffolding around a single small helper. A richer REPL bootstrapper can be layered on later if there's demand.

Ported out of scitex_gen._ipython as part of the scitex-gen full retirement wave.

Part of SciTeX

scitex-repl is part of SciTeX. Install via the umbrella with pip install scitex[repl] to use as scitex.repl (Python) or scitex repl ... (CLI).

Four Freedoms for Research

0. The freedom to run your research anywhere — your machine, your terms.
1. The freedom to study how every step works — from raw data to final manuscript.
2. The freedom to redistribute your workflows, not just your papers.
3. The freedom to modify any module and share improvements with the community.

AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

License

AGPL-3.0-only (see LICENSE).