LucidLink Python SDK

Contents:

  • Quick Start
    • Installation
      • Prerequisites
      • Install
    • Basic Usage
    • File Operations
      • Streaming File Access
      • fsspec Integration
      • Filesystem Operations
      • File Locking
    • LucidLink Connect
    • Workspace Operations
      • Discovering Filespaces
      • Context Managers
    • Configuration
      • Syncing Changes
      • Storage Modes
        • Sandboxed Mode (Default)
        • Physical Mode
      • Error Handling
  • API Reference
    • create_daemon()
    • connect
      • ConnectManager
        • ConnectManager.add_data_store()
        • ConnectManager.are_data_stores_available()
        • ConnectManager.count_external_files()
        • ConnectManager.get_data_store()
        • ConnectManager.link_file()
        • ConnectManager.list_data_stores()
        • ConnectManager.list_external_files()
        • ConnectManager.rekey_data_store()
        • ConnectManager.remove_data_store()
        • ConnectManager.unlink_file()
    • connect_models
      • DataStoreCredentials
      • DataStoreInfo
        • DataStoreInfo.access_key
        • DataStoreInfo.bucket_name
        • DataStoreInfo.endpoint
        • DataStoreInfo.from_dict()
        • DataStoreInfo.key_id
        • DataStoreInfo.kind
        • DataStoreInfo.name
        • DataStoreInfo.region
        • DataStoreInfo.rekey_state
        • DataStoreInfo.secret_key
        • DataStoreInfo.url_expiration_minutes
        • DataStoreInfo.use_virtual_addressing
      • DataStoreKind
        • DataStoreKind.S3
      • DataStoreRekeyState
        • DataStoreRekeyState.IN_PROGRESS
        • DataStoreRekeyState.NO_REKEY
      • LinkedFilesResult
        • LinkedFilesResult.cursor
        • LinkedFilesResult.file_ids
        • LinkedFilesResult.file_paths
        • LinkedFilesResult.has_more
      • S3Credentials
        • S3Credentials.access_key
        • S3Credentials.kind
        • S3Credentials.secret_key
      • S3DataStoreConfig
        • S3DataStoreConfig.access_key
        • S3DataStoreConfig.bucket_name
        • S3DataStoreConfig.endpoint
        • S3DataStoreConfig.region
        • S3DataStoreConfig.secret_key
        • S3DataStoreConfig.url_expiration_minutes
        • S3DataStoreConfig.use_virtual_addressing
    • credentials
      • ServiceAccountCredentials
    • daemon
      • Daemon
        • Daemon.authenticate()
        • Daemon.is_running()
        • Daemon.start()
        • Daemon.stop()
    • exceptions
      • AuthenticationError
      • ConfigurationError
      • DaemonError
      • FilespaceError
      • LucidLinkError
    • filespace
      • Filespace
        • Filespace.connect
        • Filespace.fs
        • Filespace.full_name
        • Filespace.id
        • Filespace.name
        • Filespace.sync_all()
        • Filespace.unlink()
        • Filespace.workspace_id
        • Filespace.workspace_name
    • filesystem
      • FileHandle
        • FileHandle.close()
        • FileHandle.closed
        • FileHandle.mode
        • FileHandle.path
        • FileHandle.read()
        • FileHandle.write()
      • Filesystem
        • Filesystem.create()
        • Filesystem.create_dir()
        • Filesystem.delete()
        • Filesystem.delete_dir()
        • Filesystem.dir_exists()
        • Filesystem.file_exists()
        • Filesystem.get_entry()
        • Filesystem.get_size()
        • Filesystem.get_statistics()
        • Filesystem.list_dir()
        • Filesystem.lock_byte_range()
        • Filesystem.move()
        • Filesystem.open()
        • Filesystem.open_legacy()
        • Filesystem.read_dir()
        • Filesystem.read_file()
        • Filesystem.truncate()
        • Filesystem.unlock_all_byte_ranges()
        • Filesystem.unlock_byte_range()
        • Filesystem.write_file()
    • fsspec
      • AbstractFileSystem
      • LucidLinkFileSystem
        • LucidLinkFileSystem.cat()
        • LucidLinkFileSystem.cat_file()
        • LucidLinkFileSystem.close()
        • LucidLinkFileSystem.exists()
        • LucidLinkFileSystem.get()
        • LucidLinkFileSystem.info()
        • LucidLinkFileSystem.isdir()
        • LucidLinkFileSystem.isfile()
        • LucidLinkFileSystem.ls()
        • LucidLinkFileSystem.makedirs()
        • LucidLinkFileSystem.mkdir()
        • LucidLinkFileSystem.mv()
        • LucidLinkFileSystem.options
        • LucidLinkFileSystem.protocol
        • LucidLinkFileSystem.put()
        • LucidLinkFileSystem.rename()
        • LucidLinkFileSystem.rm()
        • LucidLinkFileSystem.rmdir()
        • LucidLinkFileSystem.sync_all()
    • filespace_models
      • DaemonStatus
        • DaemonStatus.is_authenticated
        • DaemonStatus.is_linked
        • DaemonStatus.is_running
        • DaemonStatus.root_path
      • FilespaceInfo
        • FilespaceInfo.created
        • FilespaceInfo.id
        • FilespaceInfo.name
      • SyncMode
        • SyncMode.SYNC_ALL
        • SyncMode.SYNC_NONE
    • filesystem_models
      • DirEntry
        • DirEntry.ctime
        • DirEntry.file_id
        • DirEntry.file_id_external
        • DirEntry.is_dir()
        • DirEntry.is_file()
        • DirEntry.is_link()
        • DirEntry.mtime
        • DirEntry.name
        • DirEntry.size
        • DirEntry.type
      • FilespaceSize
        • FilespaceSize.data
        • FilespaceSize.entries
        • FilespaceSize.external_files_count
        • FilespaceSize.external_files_size
        • FilespaceSize.storage
      • FilespaceStatistics
        • FilespaceStatistics.data_size
        • FilespaceStatistics.directory_count
        • FilespaceStatistics.entries_size
        • FilespaceStatistics.external_files_count
        • FilespaceStatistics.external_files_size
        • FilespaceStatistics.file_count
        • FilespaceStatistics.storage_size
        • FilespaceStatistics.symlink_count
    • storage
      • IMPORTANT: Directory Structure
      • StorageConfig
        • StorageConfig.get_root_path()
        • StorageConfig.should_cleanup()
      • StorageMode
        • StorageMode.PHYSICAL
        • StorageMode.SANDBOXED
    • stream
      • LucidFileStream
        • LucidFileStream.close()
        • LucidFileStream.closed
        • LucidFileStream.fileno()
        • LucidFileStream.isatty()
        • LucidFileStream.mode
        • LucidFileStream.name
        • LucidFileStream.read()
        • LucidFileStream.readable()
        • LucidFileStream.readinto()
        • LucidFileStream.seek()
        • LucidFileStream.seekable()
        • LucidFileStream.tell()
        • LucidFileStream.truncate()
        • LucidFileStream.writable()
        • LucidFileStream.write()
      • open_buffered()
      • open_text()
    • workspace
      • Workspace
        • Workspace.id
        • Workspace.link_filespace()
        • Workspace.list_filespaces()
        • Workspace.name
        • Workspace.stop()
LucidLink Python SDK
  • Search

© Copyright 2026, LucidLink.

Built with Sphinx using a theme provided by Read the Docs.