Python SDK API Reference

Modules

• lucidlink.client — LucidLink Python Library - Client.
  • Client
    • is_logged_in
    • close
    • get_workspace
    • list_workspaces
    • login
  • ClientConfig
• lucidlink.connect — LucidLink Connect - external file management.
  • ConnectManager
    • add_data_store
    • are_data_stores_available
    • count_external_files
    • get_data_store
    • link_file
    • link_http_file
    • list_data_stores
    • list_external_files
    • rekey_data_store
    • remove_data_store
    • unlink_file
    • update_http_file_url
• lucidlink.connect_models — Data models for LucidLink Connect (external files).
  • DataStoreInfo
    • from_dict
  • DataStoreKind
  • DataStoreRekeyState
  • LinkedFilesResult
  • S3Credentials
  • S3DataStoreConfig
• lucidlink.credentials — Service account credentials for LucidLink authentication.
  • ServiceAccountCredentials
• lucidlink.exceptions — LucidLink Python Library - Exception Classes
  • AuthenticationError
  • ClientError
  • ConfigurationError
  • DaemonError
  • FilespaceAlreadyLinkedError
  • FilespaceError
  • FilespaceInternalError
  • LucidLinkError
• lucidlink.filespace — Filespace context after successful link.
  • Filespace
    • connect
    • fs
    • full_name
    • id
    • is_linked
    • name
    • workspace_id
    • workspace_name
    • get_data_cache_size
    • get_metadata_cache_size
    • sync_all
    • unlink
• lucidlink.filesystem — Filesystem operations on a linked LucidLink filespace.
  • FileHandle
    • closed
    • mode
    • path
    • close
    • read
    • write
  • Filesystem
    • create
    • create_dir
    • create_symlink
    • delete
    • delete_dir
    • dir_exists
    • file_exists
    • get_entry
    • get_size
    • get_statistics
    • list_dir
    • lock_byte_range
    • move
    • open
    • open_legacy
    • read_dir
    • read_file
    • read_symlink
    • truncate
    • unlock_all_byte_ranges
    • unlock_byte_range
    • write_file
• lucidlink.fsspec — fsspec integration for LucidLink filesystem.
  • LucidLinkFileSystem
    • options
    • cat
    • cat_file
    • close
    • exists
    • get
    • info
    • isdir
    • isfile
    • ls
    • makedirs
    • mkdir
    • mv
    • put
    • rename
    • rm
    • rmdir
    • sync_all
• lucidlink.filespace_models — LucidLink Python Library - Filespace Type Definitions
  • CacheConfig
  • FilespaceInfo
  • SyncMode
• lucidlink.filesystem_models — LucidLink Python Library - Filesystem Type Definitions
  • DirEntry
    • is_dir
    • is_file
    • is_link
  • FilespaceSize
  • FilespaceStatistics
• lucidlink.storage — Storage configuration for the LucidLink Python client.
  • StorageConfig
    • get_root_path
    • should_cleanup
  • StorageMode
• lucidlink.stream — Streaming file interface for LucidLink files.
  • LucidFileStream
    • closed
    • mode
    • name
    • close
    • fileno
    • isatty
    • read
    • readable
    • readinto
    • seek
    • seekable
    • tell
    • truncate
    • writable
    • write
  • open_buffered
  • open_text
• lucidlink.workspace — Workspace context after successful authentication.
  • Workspace
    • id
    • linked_filespaces
    • name
    • link_filespace
    • list_filespaces
    • stop
    • unlink_filespace
• lucidlink.workspace_models — LucidLink Python Library - Workspace Type Definitions.
  • WorkspaceInfo
• lucidlink.daemon — LucidLink Python Library - Daemon Management
  • Daemon
    • authenticate
    • is_running
    • start
    • stop
• lucidlink.daemon_models — LucidLink Python Library - Daemon Type Definitions
  • DaemonStatus