fsspec-utils

⚠️ DEPRECATED - This package is no longer maintained

This package has been superseded by fsspeckit.

Action Required: Please migrate to fsspeckit for:

• Continued support and bug fixes
• New features and improvements
• Latest dependency updates

Migration Guide

Replace your imports:

# OLD - fsspec-utils (deprecated)
from fsspec_utils import filesystem
from fsspec_utils.storage_options import AwsStorageOptions

# NEW - fsspeckit (recommended)
from fsspeckit import filesystem
from fsspeckit.storage_options import AwsStorageOptions

Update installation:

pip uninstall fsspec-utils
pip install fsspeckit

All functionality from fsspec-utils is now available in fsspeckit with the same API for easy migration.

---

Enhanced utilities and extensions for fsspec filesystems with multi-format I/O support.

Overview

fsspec-utils is a comprehensive toolkit that extends fsspec with:

• Multi-cloud storage configuration - Easy setup for AWS S3, Google Cloud Storage, Azure Storage, GitHub, and GitLab
• Enhanced caching - Improved caching filesystem with monitoring and path preservation
• Extended I/O operations - Read/write operations for JSON, CSV, Parquet with Polars/PyArrow integration
• Utility functions - Type conversion, parallel processing, and data transformation helpers

Installation

⚠️ DEPRECATED: This package is deprecated. Use fsspeckit instead.

Recommended: Install fsspeckit

# Install fsspeckit instead (recommended)
pip install fsspeckit

# With specific cloud providers
pip install fsspeckit[aws]     # AWS S3 support
pip install fsspeckit[gcp]     # Google Cloud Storage
pip install fsspeckit[azure]   # Azure Storage

Legacy: Install fsspec-utils (if maintaining existing code)

# Basic installation
pip install fsspec-utils

# With all optional dependencies
pip install fsspec-utils[full]

# Specific cloud providers
pip install fsspec-utils[aws]     # AWS S3 support
pip install fsspec-utils[gcp]     # Google Cloud Storage
pip install fsspec-utils[azure]   # Azure Storage

See Migration Guide above for upgrading to fsspeckit.

Quick Start

⚠️ DEPRECATED: Code examples below use fsspec-utils. Please use fsspeckit instead. Replace fsspec_utils → fsspeckit in imports.

Basic Filesystem Operations

# NEW - Use fsspeckit (recommended)
from fsspeckit import filesystem

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils import filesystem

# Local filesystem
fs = filesystem("file")
files = fs.ls("/path/to/data")

# S3 with caching
fs = filesystem("s3://my-bucket/", cached=True)
data = fs.cat("data/file.txt")

Storage Configuration

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import AwsStorageOptions

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import AwsStorageOptions

# Configure S3 access
options = AwsStorageOptions(
    region="us-west-2",
    access_key_id="YOUR_KEY",
    secret_access_key="YOUR_SECRET"
)

fs = filesystem("s3", storage_options=options, cached=True)

Environment-based Configuration

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import AwsStorageOptions

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import AwsStorageOptions

# Load from environment variables
options = AwsStorageOptions.from_env()
fs = filesystem("s3", storage_options=options)

Multiple Cloud Providers

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import (
    AwsStorageOptions, 
    GcsStorageOptions,
    GitHubStorageOptions
)
from fsspeckit import filesystem

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import (
#     AwsStorageOptions, 
#     GcsStorageOptions,
#     GitHubStorageOptions
# )
# from fsspec_utils import filesystem

# AWS S3
s3_fs = filesystem("s3", storage_options=AwsStorageOptions.from_env())

# Google Cloud Storage  
gcs_fs = filesystem("gs", storage_options=GcsStorageOptions.from_env())

# GitHub repository
github_fs = filesystem("github", storage_options=GitHubStorageOptions(
    org="microsoft",
    repo="vscode", 
    token="ghp_xxxx"
))

Storage Options

AWS S3

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import AwsStorageOptions

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import AwsStorageOptions

# Basic credentials
options = AwsStorageOptions(
    access_key_id="AKIAXXXXXXXX",
    secret_access_key="SECRET",
    region="us-east-1"
)

# From AWS profile
options = AwsStorageOptions.create(profile="dev")

# S3-compatible service (MinIO)
options = AwsStorageOptions(
    endpoint_url="http://localhost:9000",
    access_key_id="minioadmin",
    secret_access_key="minioadmin",
    allow_http=True
)

Google Cloud Storage

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import GcsStorageOptions

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import GcsStorageOptions

# Service account
options = GcsStorageOptions(
    token="path/to/service-account.json",
    project="my-project-123"
)

# From environment
options = GcsStorageOptions.from_env()

Azure Storage

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import AzureStorageOptions

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import AzureStorageOptions

# Account key
options = AzureStorageOptions(
    protocol="az",
    account_name="mystorageacct",
    account_key="key123..."
)

# Connection string
options = AzureStorageOptions(
    protocol="az",
    connection_string="DefaultEndpoints..."
)

GitHub

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import GitHubStorageOptions

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import GitHubStorageOptions

# Public repository
options = GitHubStorageOptions(
    org="microsoft",
    repo="vscode",
    ref="main"
)

# Private repository
options = GitHubStorageOptions(
    org="myorg",
    repo="private-repo",
    token="ghp_xxxx",
    ref="develop"
)

GitLab

# NEW - Use fsspeckit (recommended)
from fsspeckit.storage_options import GitLabStorageOptions

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.storage_options import GitLabStorageOptions

# Public project
options = GitLabStorageOptions(
    project_name="group/project",
    ref="main"
)

# Private project with token
options = GitLabStorageOptions(
    project_id=12345,
    token="glpat_xxxx",
    ref="develop"
)

Enhanced Caching

# NEW - Use fsspeckit (recommended)
from fsspeckit import filesystem

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils import filesystem

# Enable caching with monitoring
fs = filesystem(
    "s3://my-bucket/",
    cached=True,
    cache_storage="/tmp/my_cache",
    verbose=True
)

# Cache preserves directory structure
data = fs.cat("deep/nested/path/file.txt")
# Cached at: /tmp/my_cache/deep/nested/path/file.txt

Utilities

Parallel Processing

# NEW - Use fsspeckit (recommended)
from fsspeckit.utils import run_parallel

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.utils import run_parallel

# Run function in parallel
def process_file(path, multiplier=1):
    return len(path) * multiplier

results = run_parallel(
    process_file,
    ["/path1", "/path2", "/path3"],
    multiplier=2,
    n_jobs=4,
    verbose=True
)

Type Conversion

# NEW - Use fsspeckit (recommended)
from fsspeckit.utils import dict_to_dataframe, to_pyarrow_table

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.utils import dict_to_dataframe, to_pyarrow_table

# Convert dict to DataFrame
data = {"col1": [1, 2, 3], "col2": [4, 5, 6]}
df = dict_to_dataframe(data)

# Convert to PyArrow table
table = to_pyarrow_table(df)

Logging

# NEW - Use fsspeckit (recommended)
from fsspeckit.utils import setup_logging

# DEPRECATED - fsspec-utils (for reference only)
# from fsspec_utils.utils import setup_logging

# Configure logging
setup_logging(level="DEBUG", format_string="{time} | {level} | {message}")

Dependencies

Core Dependencies

• fsspec>=2023.1.0 - Filesystem interface
• msgspec>=0.18.0 - Serialization
• pyyaml>=6.0 - YAML support
• requests>=2.25.0 - HTTP requests
• loguru>=0.7.0 - Logging

Optional Dependencies

• orjson>=3.8.0 - Fast JSON processing
• polars>=0.19.0 - Fast DataFrames
• pyarrow>=10.0.0 - Columnar data
• pandas>=1.5.0 - Data analysis
• joblib>=1.3.0 - Parallel processing
• rich>=13.0.0 - Progress bars

Cloud Provider Dependencies

• boto3>=1.26.0, s3fs>=2023.1.0 - AWS S3
• gcsfs>=2023.1.0 - Google Cloud Storage
• adlfs>=2023.1.0 - Azure Storage

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Relationship to FlowerPower

This package was extracted from the FlowerPower workflow framework to provide standalone filesystem utilities that can be used independently or as a dependency in other projects.