Metadata-Version: 2.4
Name: py-web-ssh
Version: 0.1.34
Summary: A Python web SSH client with xterm.js, reconnectable sessions, logs, and file transfer.
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.10
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
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: dev
Requires-Dist: fastapi (>=0.111.0)
Requires-Dist: httpx2 (>=2.4.0) ; extra == "dev"
Requires-Dist: paramiko (>=3.4.0)
Requires-Dist: pytest (>=8.2.0) ; extra == "dev"
Requires-Dist: python-multipart (>=0.0.9)
Requires-Dist: ruff (>=0.5.0) ; extra == "dev"
Requires-Dist: uvicorn[standard] (>=0.30.0)
Description-Content-Type: text/markdown

# py-web-ssh

English | [中文](README.zh-CN.md)

A Python web SSH client built with FastAPI, Paramiko, and xterm.js.

## Quick Start

Install from PyPI:

```bash
pip install py-web-ssh
```

Start the web SSH server:

```bash
py-web-ssh
```

Open <http://127.0.0.1:8022>.

Common startup options:

```bash
py-web-ssh --host 127.0.0.1 --auto-port --launch-browser
py-web-ssh --block-size 12KB
py-web-ssh --pin 123456
```

On Windows, the packaged one-file exe starts without arguments as if it was run with:

```bash
py-web-ssh.exe --host 127.0.0.1 --auto-port --launch-browser
```

## Documentation

- [Usage Guide](docs/usage.md)
- [SSH Algorithm Controls](docs/algorithms.md)
- [API Reference](docs/api.md)
- [Windows One-File Exe Build](docs/windows-build.md)

