Workspaces group BioLM resources (runs, data, and configuration) under a named
scope. The intended Python API surface is list, create, and get on
Workspace.
Note
Python SDK workspace management is coming soon. The Workspace class in
biolm.workspaces is not yet implemented. Use biolm workspace today.
Intended API
When implemented, Workspace will support:
list()— enumerate available workspacescreate(name)— create a new workspaceget(name)— fetch workspace metadata
API
- class biolm.workspaces.Workspace(name: str | None = None, api_key: str | None = None)
Workspace management interface (not yet implemented).
Use
biolm workspaceCLI commands today. This class defines the intended Python API:list,create, andget.- Args:
name: Workspace name. If
None, uses the default workspace. api_key: Optional API token; defaults toBIOLM_TOKEN.
- create(name: str, **kwargs) → Dict[str, Any]
Create a new workspace.
- Args:
name: Name of the workspace to create.
**kwargs: Additional workspace parameters.- Returns:
Created workspace information.
- Note:
Workspace creation is not yet implemented. This is a placeholder.
- get(name: str | None = None) → Dict[str, Any]
Get workspace information.
- Args:
name: Workspace name. If None, uses the workspace name from initialization.
- Returns:
Workspace information dictionary.
- Note:
Workspace retrieval is not yet implemented. This is a placeholder.
- list() → List[Dict[str, Any]]
List all available workspaces.
- Returns:
List of workspace dictionaries.
- Note:
Workspace listing is not yet implemented. This is a placeholder.
See also
biolm workspace — workspace CLI (supported today)
biolm package —
biolm.workspacesmodule reference