Warning

This documentation is actively being updated as the project evolves and may not be complete in all areas.

Adapter API Reference

Warning

This project is still evolving, so these docs may be incomplete or out-of-date.

Adapters

class jumpstarter.client.adapters.ClientAdapter(*, client: jumpstarter.client.base.DriverClient)

class jumpstarter.client.adapters.FabricAdapter(*, client: jumpstarter.client.base.DriverClient, local_host: str = '127.0.0.1', local_port: int = 0, method: str = 'connect', user: str | None = None, config: fabric.config.Config | None = None, forward_agent: bool | None = None, connect_timeout: int | None = None, connect_kwargs: dict[str, Any] | None = None, inline_ssh_env: bool | None = None)

class jumpstarter.client.adapters.NovncAdapter(*, client: jumpstarter.client.base.DriverClient, local_host: str = '127.0.0.1', local_port: int = 0, method: str = 'connect')

class jumpstarter.client.adapters.OpendalAdapter(*, client: jumpstarter.client.base.DriverClient, operator: opendal.Operator, path: str, mode: Literal['rb', 'wb'] = 'rb')

class jumpstarter.client.adapters.PexpectAdapter(*, client: jumpstarter.client.base.DriverClient, local_host: str = '127.0.0.1', local_port: int = 0, method: str = 'connect')

class jumpstarter.client.adapters.PortforwardAdapter(*, client: jumpstarter.client.base.DriverClient, local_host: str = '127.0.0.1', local_port: int = 0, method: str = 'connect')