Skip to content

livMatS/dtool-smb

Repository files navigation

Add Server Message Block (SMB) storage support to dtool

PyPi package

Features

  • Copy datasets to and from SMB storage
  • List all the datasets in an SMB share
  • Create datasets directly to an SMB share

Installation

To install the dtool-smb package:

pip install dtool-smb

Configuration

Then create the file .config/dtool/dtool.json and add the SMB account using the format below:

```
{
  "DTOOL_SMB_USERNAME_jicinformatics": "<username>",
  "DTOOL_SMB_PASSWORD_jicinformatics": "<password>",
  "DTOOL_SMB_SERVER_NAME_jicinformatics": "<server-name>",
  "DTOOL_SMB_SERVER_PORT_jicinformatics": <server-port>,
  "DTOOL_SMB_DOMAIN_jicinformatics": "<smb-domain>",
  "DTOOL_SMB_SERVICE_NAME_jicinformatics": "<smb-share>",
  "DTOOL_SMB_PATH_jicinformatics": "<path-within-share>"
}
```

Note that <server-port> is typically 445. The name of the 'share' is specified through the DTOOL_SMB_SERVICE_NAME_* key.

Usage

To copy a dataset from local disk (my-dataset) to an SMB storage account (jicinformatics) one can use the command below:

dtool cp ./my-dataset smb://jicinformatics/

To list all the datasets in an SMB share one can use the command below:

dtool ls smb://jicinformatics/

See the dtool documentation for more detail.

Related packages