Metadata-Version: 2.4
Name: scitex-etc
Version: 0.1.6
Summary: Interactive keyboard input utilities (wait_key, count)
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-etc
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-etc
Project-URL: Issues, https://github.com/ywatanabe1989/scitex-etc/issues
Author: Yusuke Watanabe
License-Expression: AGPL-3.0-only
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: readchar
Requires-Dist: tomli; python_version < '3.11'
Provides-Extra: all
Requires-Dist: myst-parser>=2.0; extra == 'all'
Requires-Dist: pytest; extra == 'all'
Requires-Dist: pytest-cov; extra == 'all'
Requires-Dist: ruff; extra == 'all'
Requires-Dist: scitex-dev; extra == 'all'
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == 'all'
Requires-Dist: sphinx-copybutton>=0.5; extra == 'all'
Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'all'
Requires-Dist: sphinx>=7.0; extra == 'all'
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: scitex-dev; extra == 'dev'
Provides-Extra: docs
Requires-Dist: myst-parser>=2.0; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == 'docs'
Requires-Dist: sphinx-copybutton>=0.5; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
Requires-Dist: sphinx>=7.0; extra == 'docs'
Description-Content-Type: text/markdown

# scitex-etc

<!-- scitex-badges:start -->
[![PyPI](https://img.shields.io/pypi/v/scitex-etc.svg)](https://pypi.org/project/scitex-etc/)
[![Python](https://img.shields.io/pypi/pyversions/scitex-etc.svg)](https://pypi.org/project/scitex-etc/)
[![Tests](https://github.com/ywatanabe1989/scitex-etc/actions/workflows/test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-etc/actions/workflows/test.yml)
[![Install Test](https://github.com/ywatanabe1989/scitex-etc/actions/workflows/install-test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-etc/actions/workflows/install-test.yml)
[![Coverage](https://codecov.io/gh/ywatanabe1989/scitex-etc/graph/badge.svg)](https://codecov.io/gh/ywatanabe1989/scitex-etc)
[![Docs](https://readthedocs.org/projects/scitex-etc/badge/?version=latest)](https://scitex-etc.readthedocs.io/en/latest/)
[![License: AGPL v3](https://img.shields.io/badge/license-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
<!-- scitex-badges:end -->

<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>Interactive keyboard input utilities for the SciTeX ecosystem.</b></p>

<p align="center">
  <a href="https://scitex-etc.readthedocs.io/">Full Documentation</a> · <code>pip install scitex-etc</code>
</p>

---

## Problem and Solution

| # | Problem | Solution |
|---|---------|----------|
| 1 | **Scripts that pause for a keypress need raw-stdin + termios gymnastics** — 15 lines of OS-dependent boilerplate | **`wait_key()` / `count()`** — one import; handles Linux/macOS/Windows; falls back cleanly when stdin isn't a TTY |

## Installation

```bash
pip install scitex-etc
```

## Quick Start

```python
from scitex_etc import wait_key, count

key = wait_key()  # Wait for a single keypress
count(5)          # Countdown timer
```

## 1 Interfaces

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

<br>

```python
from scitex_etc import wait_key, count

# Block until a single key is pressed; returns the key as a string.
key = wait_key()

# Countdown helper — prints "5… 4… 3…" and waits a second between each.
count(5)
```

</details>

## Part of SciTeX

`scitex-etc` is part of [**SciTeX**](https://scitex.ai).

>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

---

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