Framework for Python

Publishing

publish_list()

Objects in the bucket (under its prefix): key, size, last_modified, and url.

Usage

publish_list(
    prefix: str | None = None,
    connection: str | None = None,
    max: int = 1000,
) -> pd.DataFrame

Arguments

Name Type Default Description
prefix str | None None

Only list objects under this path, which is added to the bucket's prefix. Default: everything under the bucket's prefix.

connection str | None None

A storage bucket name from the settings. Default: the project's default bucket, then one marked default: true, then the first.

max int 1000

The most objects to list. Default: 1000.

Value

A DataFrame with columns key, size, last_modified, and url.

Raises

  • FrameworkError: When no bucket is configured or listing fails.