Skip to main content

Async subprocess session manager with incremental stdin/stdout/stderr support

Project description

shell-session-manager

shell-session-manager provides async subprocess sessions that can be resumed across multiple calls. It drains stdout/stderr in background asyncio tasks, supports incremental stdin writes, exposes short session ids, and manages best-effort cleanup for long-lived command sessions.

Command construction is intentionally out of scope: callers should pass the exact command string they want to execute, including any shell, SSH, PTY, or environment bootstrap wrappers.

Usage

import anyio

from shell_session_manager import ShellSession, ShellSessionOptions


async def main() -> None:
    async with ShellSession(
        "python -u -c 'import sys; print(\"ready\"); line = sys.stdin.readline(); print(line.upper(), end=\"\")'",
        options=ShellSessionOptions(timeout_seconds=1),
    ) as session:
        stdout, stderr, code = await session.next()
        print(stdout.decode(), stderr.decode(), code)  # ready\n, "", None

        stdout, stderr, code = await session.next(b"hello\n")
        print(stdout.decode(), stderr.decode(), code)  # HELLO\n, "", 0


anyio.run(main)

For multiple long-lived sessions, use ShellSessionManager:

import anyio

from shell_session_manager import ShellSessionManager


async def main() -> None:
    async with ShellSessionManager() as manager:
        session_id = await manager.new_shell("python -c 'print(42)'")
        stdout, stderr, returncode = await manager.next(session_id)
        print(stdout.decode(), stderr.decode(), returncode)


anyio.run(main)

shellctl server

Run the HTTP API locally with:

pdm run shellctl serve --listen 127.0.0.1:8765

Pass --auth-token your-token when you want bearer auth enforced. shellctl serve also reads SHELLCTL_AUTH_TOKEN, so you can export the token instead of passing the flag. Leave the flag/env var unset or empty to start without requiring an Authorization header.

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

shell_session_manager-2.3.2.tar.gz (53.1 kB view details)

Uploaded Source

Built Distribution

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

shell_session_manager-2.3.2-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

Details for the file shell_session_manager-2.3.2.tar.gz.

File metadata

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

File hashes

Hashes for shell_session_manager-2.3.2.tar.gz
Algorithm Hash digest
SHA256 f6412c819d2dac29e0b6efb13c5d9d19e0d298d79046444e7a0f2540aaa51a97
MD5 87bac1c78f3cce865d20fae7de0263c8
BLAKE2b-256 230368938f01eeccaf26389ba4aea9566a047f11798bb7f07c33e0360dce233f

See more details on using hashes here.

Provenance

The following attestation bundles were made for shell_session_manager-2.3.2.tar.gz:

Publisher: shell-session-manager-release.yml on BeautyyuYanli/Kapybara

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shell_session_manager-2.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for shell_session_manager-2.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8b85ca5ef3764377948326996a5f53afa0c451bb979becd27bd473a7a8312a57
MD5 7a1c0086859a90a6c8ea221ddb597cb5
BLAKE2b-256 0c99ce0a8a1cf23dbc1a06d27cac2e3408459cbb6e06078809bb25667c8748fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for shell_session_manager-2.3.2-py3-none-any.whl:

Publisher: shell-session-manager-release.yml on BeautyyuYanli/Kapybara

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