Bookstore Client¶
The bookstore.client.store_client module¶
BookstoreClient¶
-
class
bookstore.client.store_client.BookstoreClient(s3_bucket=None)¶ Bases:
bookstore.client.nb_client.CurrentNotebookClientEXPERIMENTAL SUPPORT: A client that allows access to a Bookstore from within a notebook.
Parameters: s3_bucket (str) – (optional) Provide a default bucket for this bookstore client to clone from. -
default_bucket¶ The default bucket to be used for cloning.
Type: str
-
clone(s3_bucket='', s3_key='', target_path='')¶ Clone files via bookstore.
Parameters: - s3_bucket (str) – (optional) S3 bucket you wish to clone from; defaults to client’s bucket.
- s3_object_key (str) – The object key describing the object you wish to clone from S3.
- target_path (str) – (optional) The location you wish to clone the object to; defaults to s3_object_key.
-
clone_endpoint¶ Helper to refer to construct the clone endpoint for this notebook server.
-
publish(path=None)¶ Publish notebook to bookstore
Parameters: - path (str) – (optional) Path that you wish to publish; defaults to current notebook.
- s3_object_key (str) – The the path we wish to clone to.
-
publish_endpoint¶ Helper to refer to construct the publish endpoint for this notebook server.
-
