Install

Warning

datashuttle is currently in the beta release phase. Please get in contact if you encounter any bugs or unexpected behaviour.

datashuttle requires Python to run (see this guide on managing Python with conda).

The easiest way to install datashuttle is through the Python package manager conda. However, installation with pip is also supported.

Installation instructions

Conda

If you do not already have conda on your system, first download and install conda.

If you are on Windows, the easiest way to use conda is through the Anaconda Prompt.

Next, create and activate an environment. You can call your environment whatever you like, we’ve used datashuttle-env:

conda create -n datashuttle-env
conda activate datashuttle-env

Next, install datashuttle and all dependencies with:

conda install -c conda-forge datashuttle

Pip

datashuttle depends on RClone, which is not available through pip. Rclone must be installed separately.

Once Rclone is installed, datashuttle and all other dependencies can be installed in a pipenv or virtualenv environment with:

pip install datashuttle

Developers

pip must be used to install developer dependencies. As Rclone is not available through pip, you can install Rclone with Conda

conda install -c conda-forge rclone

or using the RClone’s standalone installer.

Next, clone the datashuttle GitHub repository to get the latest development version.

To install datashuttle and its developer dependencies, run the following command from inside the repository:

pip install -e .[dev]  # works on most shells
pip install -e '.[dev]'  # works on zsh (the default shell on macOS)

This will install an ‘editable’ version of datashuttle, meaning any changes you make to the cloned code will be immediately reflected in the installed package.

Check the installation

To check datashuttle has successfully installed, launch the graphical interface with:

datashuttle launch

Before using the graphical interface, you may want to choose the best terminal for your operating system.