API Reference

• cottoncandy
  • get_browser
    • get_browser()
  • get_interface
    • get_interface()
• browser
  • BrowserObject
    • BrowserObject
      • BrowserObject.__init__()
  • S3Directory
    • S3Directory
      • S3Directory.__init__()
  • S3FSLike
    • S3FSLike
      • S3FSLike.__init__()
  • S3HDF5
    • S3HDF5
      • S3HDF5.__init__()
      • S3HDF5.keys()
      • S3HDF5.load()
• interfaces
  • ArrayInterface
    • ArrayInterface
      • ArrayInterface.__init__()
      • ArrayInterface.cloud2dataset()
      • ArrayInterface.cloud2dict()
      • ArrayInterface.dict2cloud()
      • ArrayInterface.download_dask_array()
      • ArrayInterface.download_npy_array()
      • ArrayInterface.download_raw_array()
      • ArrayInterface.download_sparse_array()
      • ArrayInterface.upload_dask_array()
      • ArrayInterface.upload_npy_array()
      • ArrayInterface.upload_raw_array()
      • ArrayInterface.upload_sparse_array()
  • BasicInterface
    • BasicInterface
      • BasicInterface.__init__()
      • BasicInterface.bucket_name
      • BasicInterface.create_bucket()
      • BasicInterface.download_json()
      • BasicInterface.download_object()
      • BasicInterface.download_pickle()
      • BasicInterface.download_stream()
      • BasicInterface.download_to_file()
      • BasicInterface.exists_bucket()
      • BasicInterface.exists_object()
      • BasicInterface.get_bucket()
      • BasicInterface.get_bucket_objects()
      • BasicInterface.get_bucket_size()
      • BasicInterface.get_object()
      • BasicInterface.get_objects()
      • BasicInterface.get_size()
      • BasicInterface.pathjoin()
      • BasicInterface.rm_bucket()
      • BasicInterface.set_bucket()
      • BasicInterface.show_buckets()
      • BasicInterface.show_objects()
      • BasicInterface.upload_from_directory()
      • BasicInterface.upload_from_file()
      • BasicInterface.upload_json()
      • BasicInterface.upload_object()
      • BasicInterface.upload_pickle()
  • DefaultInterface
    • DefaultInterface
      • DefaultInterface.__init__()
  • FileSystemInterface
    • FileSystemInterface
      • FileSystemInterface.__init__()
      • FileSystemInterface.cp()
      • FileSystemInterface.download_directory()
      • FileSystemInterface.get_browser()
      • FileSystemInterface.get_object_owner()
      • FileSystemInterface.glob()
      • FileSystemInterface.glob_google_drive()
      • FileSystemInterface.glob_s3()
      • FileSystemInterface.ls()
      • FileSystemInterface.lsdir()
      • FileSystemInterface.mv()
      • FileSystemInterface.rm()
      • FileSystemInterface.search()
  • InterfaceObject
    • InterfaceObject
      • InterfaceObject.__init__()
• localclient
  • LocalClient
    • LocalClient
      • LocalClient.__init__()
      • LocalClient.check_file_exists()
      • LocalClient.copy()
      • LocalClient.delete()
      • LocalClient.download_stream()
      • LocalClient.download_to_file()
      • LocalClient.get_object_metadata()
      • LocalClient.get_object_size()
      • LocalClient.list_directory()
      • LocalClient.list_objects()
      • LocalClient.move()
      • LocalClient.size
      • LocalClient.upload_file()
      • LocalClient.upload_stream()
  • auto_makedirs
    • auto_makedirs()
• utils
  • GzipInputStream
    • GzipInputStream
      • GzipInputStream.__init__()
      • GzipInputStream.next()
      • GzipInputStream.read()
      • GzipInputStream.readline()
      • GzipInputStream.readlines()
      • GzipInputStream.seek()
      • GzipInputStream.tell()
  • bytes2human
    • bytes2human()
  • clean_object_name
    • clean_object_name()
  • generate_ndarray_chunks
    • generate_ndarray_chunks()
  • get_fileobject_size
    • get_fileobject_size()
  • get_key_from_environ
    • get_key_from_environ()
  • get_key_from_s3fs
    • get_key_from_s3fs()
  • get_keys
    • get_keys()
  • get_object_size
    • get_object_size()
  • has_magic
    • has_magic()
  • has_real_magic
    • has_real_magic()
  • has_start_digit
    • has_start_digit()
  • has_trivial_magic
    • has_trivial_magic()
  • mk_aws_path
    • mk_aws_path()
  • objects2names
    • objects2names()
  • pathjoin
    • pathjoin()
  • print_objects
    • print_objects()
  • read_buffered
    • read_buffered()
  • remove_root
    • remove_root()
  • remove_trivial_magic
    • remove_trivial_magic()
  • sanitize_metadata
    • sanitize_metadata()
  • split_uri
    • split_uri()
  • string2bool
    • string2bool()
  • unquote_names
    • unquote_names()