Skip to main content

Host check + safe file mv — standalone module from the SciTeX ecosystem

Project description

scitex-os

SciTeX

Host check + safe file move helpers — zero-dep, pure stdlib.

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

pypi python docs

tests install-check cov


Problem and Solution

# Problem Solution
1 Host-specific scripts use socket.gethostname() == 'X' -- different style across every repo; no consistent error message when the check fails scitex_os.check_host / is_host / verify_host -- single canonical helper triple; check_host and is_host return bool, verify_host calls sys.exit(1) on mismatch
2 os.rename(src, dst) breaks across filesystems -- "Invalid cross-device link" when the target is on a different mount scitex_os.mv(src, dst) -- atomic when same filesystem, copy+unlink fallback otherwise; auto-creates parent dir

Installation

pip install scitex-os

Quick Start

import scitex_os as sxos

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

1 Interfaces

Python API
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. Pure stdlib — zero deps. The umbrella package's scitex.os import path is preserved via a sys.modules-alias bridge.

Architecture

scitex_os/
├── _check_host.py        ← is_host / check_host / verify_host
├── _mv.py                ← `mv` (shutil.move + mkdir(target.parent))
└── __init__.py           ← public surface (zero deps beyond stdlib)

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]
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

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

  1. The freedom to run your research anywhere — your machine, your terms.
  2. The freedom to study how every step works — from raw data to final manuscript.
  3. The freedom to redistribute your workflows, not just your papers.
  4. 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).


SciTeX

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scitex_os-0.1.8.tar.gz (7.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scitex_os-0.1.8-py3-none-any.whl (7.7 MB view details)

Uploaded Python 3

File details

Details for the file scitex_os-0.1.8.tar.gz.

File metadata

  • Download URL: scitex_os-0.1.8.tar.gz
  • Upload date:
  • Size: 7.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_os-0.1.8.tar.gz
Algorithm Hash digest
SHA256 c83076d075e9fbcd032273f8da0ebcbcaa3f4d3adc287ecb25ec53777081fcd7
MD5 45a19b78daba3aa72565ef16dbfe99a1
BLAKE2b-256 fbfd01ed691ef80d0b918844fa3e4e3814dc1fa36f5b45012223dc82e40a42a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_os-0.1.8.tar.gz:

Publisher: pypi-publish-and-github-release-on-tag.yml on ywatanabe1989/scitex-os

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scitex_os-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: scitex_os-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 7.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_os-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7f6faf4b9ae24abd3678ca0000d77993330a26366f2888a1b2b3e1c7eeb0b429
MD5 bf3ad142c25cc53e0ae313254026b61c
BLAKE2b-256 792250dbe9036f54212eecff32d354ba5a7a95fe8a439cb436156e87a6ac82f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_os-0.1.8-py3-none-any.whl:

Publisher: pypi-publish-and-github-release-on-tag.yml on ywatanabe1989/scitex-os

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page