board_gcs

board_gcs(path, versioned=True, cache=DEFAULT, allow_pickle_read=None)

Create a board to read and write pins from a Google Cloud Storage bucket folder.

Parameters

Name Type Description Default
path Path of form <bucket_name>/<optional>/<subdirectory>. required
versioned Whether or not pins should be versioned. True
cache Whether to use a cache. By default, pins attempts to select the right cache directory, given your filesystem. If None is passed, then no cache will be used. You can set the cache using the PINS_CACHE_DIR environment variable. DEFAULT
allow_pickle_read Whether to allow reading pins that use the pickle protocol. Pickles are unsafe, and can execute arbitrary code. Only allow reading pickles if you trust the board to execute Python code on your computer. You can enable reading pickles by setting this to True, or by setting the environment variable PINS_ALLOW_PICKLE_READ. If both are set, this argument takes precedence. None

Notes

The gcs board uses the fsspec library (gcsfs) to handle interacting with Google Cloud Storage. Currently, its default mode of authentication is supported.

See https://gcsfs.readthedocs.io/#credentials