Installation

This guide covers how to install datashard for different use cases.

Prerequisites

  • Python 3.7 or higher

  • pip package manager

Installing from PyPI

The easiest way to install datashard is using pip:

pip install datashard

For S3 storage support, install with the s3 extra:

pip install datashard[s3]

This includes the boto3 library required for S3-compatible storage backends.

Installing from Source

If you want to install from the source code:

git clone https://github.com/rodmena-limited/datashard.git
cd datashard
pip install .

Development Installation

For development purposes, you can install in editable mode with development dependencies:

git clone https://github.com/rodmena-limited/datashard.git
cd datashard
pip install -e ".[dev]"

Verification

To verify that datashard is installed correctly:

import datashard
print(datashard.__version__)

If this runs without error, datashard is properly installed.