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.1.tar.gz (52.6 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.1-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shell_session_manager-2.3.1.tar.gz
  • Upload date:
  • Size: 52.6 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.1.tar.gz
Algorithm Hash digest
SHA256 3b97b49cdb8c71577b0f0d26c737a7a2e3cb426859a9eac64618d80dd29f36a2
MD5 cfd7017e0ece310484a7d02cd85f7476
BLAKE2b-256 fb78dc7875a3f05cf0b862ba54170da3f412303611f697c2974d232b3f19e8ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for shell_session_manager-2.3.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for shell_session_manager-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c88e21ff9b4e54bf0352374b415ee009d1a792c11c2f0cae4bf34d409a251d3
MD5 edfeaa84094256af7da749462b72dede
BLAKE2b-256 1575a077bad4168b52c1b53f3f219c11843737aca77ce63c28a2f4b1e731dc88

See more details on using hashes here.

Provenance

The following attestation bundles were made for shell_session_manager-2.3.1-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