scitex-context

Execution-context detection (script vs Jupyter vs IPython) and output suppression helpers.

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

Quick Start

import scitex_context as ctx

if ctx.is_notebook():
    print("Running inside Jupyter")

with ctx.suppress_output():
    noisy_function()

Demo

flowchart LR
    A["import scitex_context as ctx"] --> B{ctx.detect_environment()}
    B -- "python foo.py" --> S["script"]
    B -- "jupyter" --> N["notebook"]
    B -- "ipython REPL" --> I["ipython"]
    S & N & I --> O["ctx.get_output_directory()"]
    N --> P["ctx.get_notebook_path()"]
    A --> Q["with ctx.suppress_output():<br/>    noisy_call()"]

_{Figure 1. Detect-then-adapt: one import reports the execution context, then output-directory and notebook helpers follow it.}

Installation

uv pip install "scitex-context[all]"

Through the umbrella: uv pip install "scitex[context]". Requires Python ≥ 3.10.

Architecture

flowchart LR
    U["user code"] --> D["_detect_environment.py"]
    D -- "script | notebook | ipython" --> S["_suppress_output.py"]
    D --> G["_get_notebook_path.py"]
    S --> P["public API: __init__.py"]
    G --> P

_{Figure 2. Module layout: environment detection feeds output suppression and notebook-path helpers, all re-exported from the public API.}

Pure-stdlib, zero-dep helpers. The umbrella scitex.context import path is preserved via a sys.modules-alias bridge installed at import time.

1 Interfaces

import scitex_context as ctx

# Environment detection
ctx.detect_environment()       # "script" | "notebook" | "ipython"
ctx.is_script()                # True if running under `python foo.py`
ctx.is_notebook()              # True under Jupyter
ctx.is_ipython()               # True under bare IPython
ctx.get_output_directory()     # Conventional output dir for current context

# Notebook helpers (no-op outside a notebook)
ctx.get_notebook_path()
ctx.get_notebook_directory()
ctx.get_notebook_name()
ctx.get_notebook_info_simple()

# Output suppression
with ctx.suppress_output():
    noisy_function()

with ctx.quiet():               # alias
    chatty_lib_call()

Status

Standalone fork of scitex.context. Pure stdlib — zero deps. The umbrella package's scitex.context import path is preserved via a sys.modules-alias bridge.

Part of SciTeX

scitex-context is part of SciTeX. Install via the umbrella with pip install scitex[context] to use as scitex.context (Python) or scitex context ... (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).