Metadata-Version: 2.4
Name: scitex-capture
Version: 0.1.4
Summary: Session-based screen capture (single screenshots, multi-frame GIFs, grid overlays, monitor info) — standalone module from the SciTeX ecosystem
Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-capture
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-capture
Project-URL: Documentation, https://scitex-capture.readthedocs.io
Keywords: scitex,capture,screenshot,screencast,gif,wsl
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics :: Capture :: Screen Capture
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Pillow
Requires-Dist: click>=8.0
Requires-Dist: mss
Provides-Extra: mcp
Requires-Dist: mcp>=1.0.0; extra == "mcp"
Provides-Extra: playwright
Requires-Dist: playwright>=1.40.0; extra == "playwright"
Provides-Extra: dev
Requires-Dist: mcp>=1.0.0; extra == "dev"
Requires-Dist: numpy; extra == "dev"
Requires-Dist: playwright>=1.40.0; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: scitex-dev>=0.11.7; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
Provides-Extra: all
Requires-Dist: scitex-capture[mcp]; extra == "all"
Requires-Dist: scitex-capture[playwright]; extra == "all"
Dynamic: license-file

# scitex-capture

<p align="center">
  <a href="https://scitex.ai">
    <img src="docs/scitex-logo-blue-cropped.png" alt="SciTeX" width="400">
  </a>
</p>

<p align="center"><b>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.</b></p>

<p align="center">
  <a href="https://scitex-capture.readthedocs.io/">Full Documentation</a> · <code>uv pip install scitex-capture[all]</code>
</p>

<!-- scitex-badges:start -->
<p align="center">
  <a href="https://pypi.org/project/scitex-capture/"><img src="https://img.shields.io/pypi/v/scitex-capture.svg" alt="PyPI"></a>
  <a href="https://pypi.org/project/scitex-capture/"><img src="https://img.shields.io/pypi/pyversions/scitex-capture.svg" alt="Python"></a>
  <a href="https://github.com/ywatanabe1989/scitex-capture/actions/workflows/test.yml"><img src="https://github.com/ywatanabe1989/scitex-capture/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
  <a href="https://codecov.io/gh/ywatanabe1989/scitex-capture"><img src="https://codecov.io/gh/ywatanabe1989/scitex-capture/graph/badge.svg" alt="Coverage"></a>
  <a href="https://scitex-capture.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/scitex-capture/badge/?version=latest" alt="Docs"></a>
  <a href="https://www.gnu.org/licenses/agpl-3.0"><img src="https://img.shields.io/badge/license-AGPL_v3-blue.svg" alt="License: AGPL v3"></a>
</p>
<!-- scitex-badges:end -->

---

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

```bash
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

<details open>
<summary><strong>Python API</strong></summary>

<br>

```python
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()
```

</details>

<details>
<summary><strong>CLI</strong></summary>

<br>

```bash
scitex-capture --help
scitex-capture snap "debug message"
scitex-capture start --interval 2
scitex-capture stop <session-id>
scitex-capture gif <session-id>
```

</details>

## Demo

```mermaid
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**](https://scitex.ai). Install via
the umbrella with `pip install scitex[capture]` to use as
`scitex.capture` (Python) or `scitex capture ...` (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](./LICENSE)).

---

<p align="center">
  <a href="https://scitex.ai" target="_blank"><img src="docs/scitex-icon-navy-inverted.png" alt="SciTeX" width="40"/></a>
</p>
