scitex-os

Host check + safe file move helpers — minimal deps.

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

Problem and Solution

Quick Start

import scitex_os as sxos

if sxos.is_host("compute-01"):
    sxos.mv(src, tgt)

Demo

flowchart LR
    A[script.py] -->|is_host| B{hostname<br/>matches?}
    B -- yes --> C[sxos.mv src → tgt<br/>auto mkdir parent]
    B -- no --> D[skip / raise]

_{Figure 1. Demo path. Host match gates the move; mismatch skips or raises before anything runs.}

import scitex_os as sxos

if sxos.is_host("compute-01"):
    sxos.mv("results/run.csv", "/shared/runs/2026-05-07/run.csv")
# parent dir is auto-created; cross-filesystem moves are handled.

$ python -c "import scitex_os; print(scitex_os.is_host('laptop'))"
True

Installation

uv pip install "scitex-os[all]"

uv pip install -e ".[dev]"               # editable install for contributors

flowchart LR
    H[keyword] --> C[check_host / is_host]
    C --> B{hostname<br/>matches?}
    B -- yes --> M[mv src to tgt]
    B -- no --> X[verify_host exits 1]
    M --> OK[moved + parent auto-created]

_{Figure 2. Helper flow. Host gating decides whether the move runs; moves auto-create parents and survive cross-filesystem targets.}

1 Interfaces

import scitex_os as sxos

sxos.is_host("hostname")          # bool
sxos.check_host("hostname")       # bool
sxos.verify_host("hostname")      # sys.exit(1) on mismatch

sxos.mv(src, tgt)                 # shutil.move with mkdir(tgt)

Status

Standalone fork of scitex.os. Minimal deps (scitex-logging for output). The umbrella package's scitex.os import path is preserved via a sys.modules-alias bridge.

Part of SciTeX

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