Skip to main content

Session-based screen capture (single screenshots, multi-frame GIFs, grid overlays, monitor info) — standalone module from the SciTeX ecosystem

Project description

scitex-capture

SciTeX

Session-based screen capture — single screenshots, multi-frame sessions → animated GIFs, grid overlays, monitor + cursor info. Optimised for WSL→Windows host and for AI agents that need a "what does my screen look like right now" tool.

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

PyPI Python Tests Coverage Docs License: AGPL v3


Architecture

scitex-capture/
├── src/scitex_capture/
│   ├── __init__.py              # snap, start, stop, gif, get_info
│   ├── _snap.py                 # one-shot screenshot (mss + Pillow)
│   ├── _session.py              # interval capture session manager
│   ├── _gif.py                  # multi-frame -> animated GIF / grid
│   ├── _info.py                 # monitor + cursor introspection
│   ├── _wsl.py                  # WSL -> Windows host bridge
│   ├── _cli/                    # scitex-capture entrypoint
│   ├── _mcp_tools/              # MCP server (opt-in)
│   └── playwright/              # browser-side capture (opt-in)
└── tests/                       # 146/146 pass

Installation

pip install scitex-capture
pip install "scitex-capture[mcp]"          # + MCP server
pip install "scitex-capture[playwright]"   # + browser capture
pip install "scitex-capture[all]"          # everything

2 Interfaces

Python API
import scitex_capture as cap

# One-shot screenshot
path = cap.snap("debug message")
path = cap.snap(capture_all=True)

# Inspect monitors / windows
info = cap.get_info()

# Continuous session capture
session_id = cap.start(interval=2)
# ... do work ...
cap.stop(session_id)
gif_path = cap.gif(session_id)

# Latest session
gif = cap.create_gif_from_latest_session()
CLI
scitex-capture --help
scitex-capture snap "debug message"
scitex-capture start --interval 2
scitex-capture stop <session-id>
scitex-capture gif <session-id>

Demo

sequenceDiagram
    participant U as user / agent
    participant C as scitex_capture
    participant M as mss + Pillow
    participant F as filesystem
    U->>C: cap.start(interval=2)
    loop every 2s
        C->>M: grab frame
        M-->>C: PNG bytes
        C->>F: write frame_NNN.png
    end
    U->>C: cap.stop(session_id)
    U->>C: cap.gif(session_id)
    C-->>F: session.gif (animated)

Status

Standalone fork of scitex.capture. Only deps are Pillow + mss (with playwright + mcp as opt-ins). The umbrella package's scitex.capture import path is preserved via a sys.modules-alias bridge. 146/146 tests pass.

Part of SciTeX

scitex-capture is part of SciTeX. Install via the umbrella with pip install scitex[capture] to use as scitex.capture (Python) or scitex capture ... (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_capture-0.1.4.tar.gz (61.6 kB view details)

Uploaded Source

Built Distribution

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

scitex_capture-0.1.4-py3-none-any.whl (71.7 kB view details)

Uploaded Python 3

File details

Details for the file scitex_capture-0.1.4.tar.gz.

File metadata

  • Download URL: scitex_capture-0.1.4.tar.gz
  • Upload date:
  • Size: 61.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_capture-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ab929530a9571e92ed66f7c6d1db5a2fae64d88a064c2bd46bd0e9e8b927976a
MD5 bde52971dc86a445dd3ea8c661544d27
BLAKE2b-256 6e32947751a2ff04e138507b3436bc72a448a8b431b3a4379ab8340b2a8e472c

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_capture-0.1.4.tar.gz:

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

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_capture-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: scitex_capture-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 71.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_capture-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 db81352edcddda0d96139bd318cb5a4399a36fb0122a47019e717cec2c8870df
MD5 18ab62e5375688e75823a4eaef05cdc5
BLAKE2b-256 4fa40b98c8593e11b00aaf65976d26771b66b677dc53e5444d8b71b46036e7e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_capture-0.1.4-py3-none-any.whl:

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

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