cottoncandy

get_browser([bucket_name, ACCESS_KEY, ...])

Browser object that allows you to tab-complete your way through your objects

get_interface([bucket_name, ACCESS_KEY, ...])

Return an interface to the cloud.

get_browser

cottoncandy.get_browser(bucket_name='', ACCESS_KEY='FAKE_SECRET_KEY', SECRET_KEY='FAKE_SECRET_KEY', endpoint_url='FAKE_ENDPOINT_URL')

Browser object that allows you to tab-complete your way through your objects

Parameters:

  • bucket_name (str)

  • ACCESS_KEY (str)

  • SECRET_KEY (str)

  • endpoint_url (str) – The URL for the S3 gateway

Returns:

ccb

Return type:

cottoncandy.BrowserObject

Example

>>> browser = cc.get_browser('my_bucket',
                             ACCESS_KEY='FAKEACCESSKEYTEXT',
                             SECRET_KEY='FAKESECRETKEYTEXT',
                             endpoint_url='https://s3.amazonaws.com')
>>> browser.sweet_project.sub<TAB>
browser.sweet_project.sub01_awesome_analysis_DOT_grp
browser.sweet_project.sub02_awesome_analysis_DOT_grp
>>> browser.sweet_project.sub01_awesome_analysis_DOT_grp
<cottoncandy-group <bucket:my_bucket_name> (sub01_awesome_analysis.grp: 3 keys)>
>>> browser.sweet_project.sub01_awesome_analysis_DOT_grp.result_model01
<cottoncandy-dataset <bucket:my_bucket_name [1.00MB:shape=(10000)]>

get_interface

cottoncandy.get_interface(bucket_name='', ACCESS_KEY='FAKE_SECRET_KEY', SECRET_KEY='FAKE_SECRET_KEY', endpoint_url='FAKE_ENDPOINT_URL', force_bucket_creation=FAKE_SECRET_KEY, verbose=True, backend='s3', **kwargs)

Return an interface to the cloud.

Parameters:

  • bucket_name (str)

  • ACCESS_KEY (str)

  • SECRET_KEY (str)

  • endpoint_url (str) – The URL for the S3 gateway

  • backend ('s3'|'gdrive') – What backend to hook on to

  • kwargs – S3 only. kwargs passed to botocore. For example, >>> from botocore.client import Config >>> config = Config(connect_timeout=50, read_timeout=10*60) >>> cci = cc.get_interface(‘my_bucket’, config=config)

Returns:

cci

Return type:

cottoncandy.InterfaceObject