Metadata-Version: 2.4
Name: docker2ssh
Version: 0.0.4
Summary: Precompiled Python wheel for the d2s docker2ssh binary
Project-URL: Homepage, https://github.com/PannenetsF/docker2ssh
Author: docker2ssh contributors
License: MIT
License-File: LICENSE
Keywords: container,devops,docker,remote,ssh
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# docker2ssh Python Package

`docker2ssh` is the primary CLI exposed by the Python package.

It does not reimplement the SSH server in Python. Instead, it:

- discovers the bundled runtime executable
- exposes a small Python API
- provides a `docker2ssh` console script

## Install

```bash
python3 -m pip install -U pip
python3 -m pip install -U docker2ssh
```

Published Linux wheels bundle the runtime directly. Set `D2S_BIN` only if you want to override
the bundled executable:

```bash
export D2S_BIN=/usr/local/bin/d2s
```

Notes:

- `pip install -U docker2ssh` also works as the update command
- Upgrading `pip` first is recommended on older Linux systems
- Published wheels currently target Linux `x86_64` and `aarch64`

## Python API

```python
from docker2ssh import D2S

client = D2S(config="/etc/d2s/config.toml")
print(client.show())
client.config_set(2222, "my-container")
```

## CLI Wrapper

```bash
docker2ssh show
docker2ssh config set 2222 my-container
docker2ssh serve
docker2ssh stop
```
