fsspeckit API Reference

Welcome to the fsspeckit API reference documentation. This section provides detailed information on the various modules, classes, and functions available in the library.

Package Structure: fsspeckit is organized into domain-specific packages for better discoverability. See Architecture for details.

Domain Packages (Primary API)

Dataset Operations

• fsspeckit.datasets - Dataset-level operations (DuckDB & PyArrow helpers)

SQL Utilities

• fsspeckit.sql.filters - SQL-to-filter translation helpers

Common Utilities

• fsspeckit.common - Cross-cutting utilities (logging, parallelism, type conversion)

Core Infrastructure

Core Modules

• fsspeckit.core.base - Base classes and interfaces
• fsspeckit.core.ext - Extended filesystem methods
• fsspeckit.core.filesystem - Filesystem factory functions
• fsspeckit.core.maintenance - Dataset maintenance utilities
• fsspeckit.core.merge - Dataset merging operations

Storage Options

• fsspeckit.storage_options.base - Base storage options
• fsspeckit.storage_options.cloud - Cloud storage configurations
• fsspeckit.storage_options.core - Core storage utilities
• fsspeckit.storage_options.git - Git-based storage options

Backwards Compatibility (fsspeckit.utils)

The fsspeckit.utils module provides a backwards-compatible façade that re-exports selected helpers from the domain packages. New code should import directly from domain packages for better discoverability.

• fsspeckit.utils.datetime - Date and time utilities
• fsspeckit.utils.logging - Logging configuration and utilities
• fsspeckit.utils.misc - Miscellaneous utility functions
• fsspeckit.utils.polars - Polars DataFrame utilities
• fsspeckit.utils.pyarrow - PyArrow utilities and integrations
• fsspeckit.utils.sql - SQL query and filter utilities
• fsspeckit.utils.types - Type definitions and utilities

Migration Tip: For new code, prefer importing directly from domain packages: - from fsspeckit.datasets import DuckDBParquetHandler instead of from fsspeckit.utils import DuckDBParquetHandler - from fsspeckit.common.logging import setup_logging instead of from fsspeckit.utils import setup_logging