Snakemake storage plugin: sftp

Warning

No documentation found in repository https://github.com/snakemake/snakemake-storage-plugin-sftp. The plugin should provide a docs/intro.md with some introductory sentences and optionally a docs/further.md file with details beyond the auto-generated usage instractions presented in this catalog.

Installation

Install this plugin by installing it with pip or mamba, e.g.:

pip install snakemake-storage-plugin-sftp

Usage

Queries

Queries to this storage should have the following format:

Query type	Query	Description
any	sftp://ftpserver.com:22/myfile.txt	A file on an sftp server. The port is optional and defaults to 22.

As default provider

If you want all your input and output (which is not explicitly marked to come from another storage) to be written to and read from this storage, you can use it as a default provider via:

snakemake --default-storage-provider sftp --default-storage-prefix ...

with ... being the prefix of a query under which you want to store all your results. You can also pass custom settings via command line arguments:

snakemake --default-storage-provider sftp --default-storage-prefix ... \
    --storage-sftp-max-requests-per-second ... \        --storage-sftp-username ... \        --storage-sftp-password ... \        --storage-sftp-not-sync-mtime ...

Within the workflow

If you want to use this storage plugin only for specific items, you can register it inside of your workflow:

# register storage provider (not needed if no custom settings are to be defined here)
storage:
    provider="sftp",
    # optionally add custom settings here if needed
    # alternatively they can be passed via command line arguments
    # starting with --storage-sftp-..., see
    # snakemake --help
    # Maximum number of requests per second for this storage provider. If nothing is specified, the default implemented by the storage plugin is used.
    max_requests_per_second=...,
    # SFTP username
    username=...,
    # SFTP username
    password=...,
    # Do not synchronize mtime when storing files or dirs.
    not_sync_mtime=...,

rule example:
    input:
        storage.sftp(
            # define query to the storage backend here
            ...
        ),
    output:
        "example.txt"
    shell:
        "..."

Using multiple entities of the same storage plugin

In case you have to use this storage plugin multiple times, but with different settings (e.g. to connect to different storage servers), you can register it multiple times, each time providing a different tag:

# register shared settings
storage:
    provider="sftp",
    # optionally add custom settings here if needed
    # alternatively they can be passed via command line arguments
    # starting with --storage-sftp-..., see below
    # Maximum number of requests per second for this storage provider. If nothing is specified, the default implemented by the storage plugin is used.
    max_requests_per_second=...,
    # SFTP username
    username=...,
    # SFTP username
    password=...,
    # Do not synchronize mtime when storing files or dirs.
    not_sync_mtime=...,

# register multiple tagged entities
storage foo:
    provider="sftp",
    # optionally add custom settings here if needed
    # alternatively they can be passed via command line arguments
    # starting with --storage-sftp-..., see below.
    # To only pass a setting to this tagged entity, prefix the given value with
    # the tag name, i.e. foo:max_requests_per_second=...
    # Maximum number of requests per second for this storage provider. If nothing is specified, the default implemented by the storage plugin is used.
    max_requests_per_second=...,
    # SFTP username
    username=...,
    # SFTP username
    password=...,
    # Do not synchronize mtime when storing files or dirs.
    not_sync_mtime=...,

rule example:
    input:
        storage.foo(
            # define query to the storage backend here
            ...
        ),
    output:
        "example.txt"
    shell:
        "..."

Settings

The storage plugin has the following settings (which can be passed via command line, the workflow or environment variables, if provided in the respective columns):

CLI setting	Workflow setting	Envvar setting	Description	Default	Choices	Required	Type
--storage-sftp-max-requests-per-second VALUE	max_requests_per_second		Maximum number of requests per second for this storage provider. If nothing is specified, the default implemented by the storage plugin is used.	None		✗	str
--storage-sftp-username VALUE	username	SNAKEMAKE_STORAGE_SFTP_USERNAME	SFTP username	None		✗	str
--storage-sftp-password VALUE	password	SNAKEMAKE_STORAGE_SFTP_PASSWORD	SFTP username	None		✗	str
--storage-sftp-not-sync-mtime VALUE	not_sync_mtime		Do not synchronize mtime when storing files or dirs.	False		✗	str