Skip to content

Installation

fsspeckit can be installed using pip, the Python package installer.

Prerequisites

  • Python 3.11 or higher is required.

Install with pip

To install fsspeckit using pip, run the following command:

1
pip install fsspeckit

Optional Cloud Provider Support

Install with support for specific cloud providers:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# AWS S3 support
pip install "fsspeckit[aws]"

# Google Cloud Storage support
pip install "fsspeckit[gcp]"

# Azure Storage support
pip install "fsspeckit[azure]"

# All cloud providers
pip install "fsspeckit[aws,gcp,azure]"

Upgrading

To upgrade fsspeckit to the latest version, use:

1
pip install --upgrade fsspeckit

Environment Management with uv and pixi

For robust dependency management and faster installations, we recommend using uv or pixi.

Using uv

uv is a fast Python package installer and resolver. To install fsspec-utils with uv:

1
uv pip install fsspeckit

Using pixi

pixi is a modern package manager for Python and other languages. To add fsspec-utils to your pixi project:

1
pixi add fsspeckit

Troubleshooting

If you encounter any issues during installation, consider the following:

  • Python Version: Ensure you are using Python 3.11 or higher. You can check your Python version with python --version.
  • Virtual Environments: It is highly recommended to use a virtual environment (e.g., venv, conda, uv, pixi) to avoid conflicts with system-wide packages.
  • Permissions: If you encounter permission errors, you might need to run the installation command with sudo (e.g., sudo pip install fsspec-utils), but this is generally not recommended in a virtual environment.
  • Network Issues: Check your internet connection if the installation fails to download packages.

For further assistance, please refer to the official fsspeckit GitHub repository or open an issue.