Skip to content

Commit dabb5fe

Browse files
committed
docs: add note on how to connect to s3
1 parent 3e4590c commit dabb5fe

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

pins/constructors.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,13 @@ def board_s3(path, versioned=True, cache=DEFAULT, allow_pickle_read=None):
372372
Path of form <bucket_name>/<optional>/<subdirectory>.
373373
**kwargs:
374374
Passed to the pins.board function.
375+
376+
Note
377+
----
378+
The s3 board uses the fsspec library (s3fs) to handle interacting with s3.
379+
In order to authenticate, set the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY,
380+
and (optionally) AWS_REGION environment variables.
381+
375382
"""
376383
# TODO: user should be able to specify storage options here?
377384
return board("s3", path, versioned, cache, allow_pickle_read)

0 commit comments

Comments
 (0)