biolm.volumes

Intended API

When implemented, Volume will support:

• list() — enumerate available volumes

• create(name) — create a new volume

• get(name) — fetch volume metadata

API

class biolm.volumes.Volume(name: str | None = None, api_key: str | None = None)

Volume management interface (not yet implemented).

Use hub CLI and storage workflows today. This class defines the intended Python API: list, create, and get.

Args:

name: Volume name. If None, uses the default volume. api_key: Optional API token; defaults to BIOLM_TOKEN.

create(name: str, **kwargs) → Dict[str, Any]

Create a new volume.

Args:

name: Name of the volume to create. **kwargs: Additional volume parameters.

Returns:

Created volume information.

Note:

Volume creation is not yet implemented. This is a placeholder.

get(name: str | None = None) → Dict[str, Any]

Get volume information.

Args:

name: Volume name. If None, uses the volume name from initialization.

Returns:

Volume information dictionary.

Note:

Volume retrieval is not yet implemented. This is a placeholder.

list() → List[Dict[str, Any]]

List all available volumes.

Returns:

List of volume dictionaries.

Note:

Volume listing is not yet implemented. This is a placeholder.

See also

• biolm hub — hub and storage CLI

• biolm package — biolm.volumes module reference