Sftp

Connect Sftp to your preprocessing pipeline, and batch process all your documents using unstructured-ingest to store structured outputs locally on your filesystem.

For downloading an individual file specifically, the filename must have an extension. Otherwise it will be treated as a directory.

First you’ll need to install the Sftp dependencies as shown below .

pip install "unstructured[sftp]"

Run Locally

#!/usr/bin/env bash

unstructured-ingest \
  sftp \
  --remote-url sftp://address:port/upload \
  --username foo \
  --password bar \
  --output-dir sftp-output \
  --num-processes 2 \
  --recursive \
  --verbose

import os

from unstructured.ingest.connector.fsspec.sftp import SftpAccessConfig, SimpleSftpConfig
from unstructured.ingest.interfaces import (
    PartitionConfig,
    ProcessorConfig,
    ReadConfig,
)
from unstructured.ingest.runner import SftpRunner

if __name__ == "__main__":
    runner = SftpRunner(
        processor_config=ProcessorConfig(
            verbose=True,
            output_dir="sftp-output",
            num_processes=2,
        ),
        read_config=ReadConfig(),
        partition_config=PartitionConfig(),
        connector_config=SimpleSftpConfig(
            access_config=SftpAccessConfig(
                username=os.getenv("SFTP_USERNAME"),
                password=os.getenv("SFTP_PASSWORD"),
            ),
            remote_url="sftp://address:port/upload",
            recursive=True,
        ),
    )
    runner.run()

Run via the API

You can also use upstream connectors with the unstructured API. For this you’ll need to use the --partition-by-api flag and pass in your API key with --api-key.

#!/usr/bin/env bash

unstructured-ingest \
  sftp \
  --remote-url sftp://address:port/upload \
  --username foo \
  --password bar \
  --output-dir sftp-output \
  --num-processes 2 \
  --recursive \
  --verbose \
  --partition-by-api \
  --api-key "<UNSTRUCTURED-API-KEY>"

import os

from unstructured.ingest.connector.fsspec.sftp import SftpAccessConfig, SimpleSftpConfig
from unstructured.ingest.interfaces import (
    PartitionConfig,
    ProcessorConfig,
    ReadConfig,
)
from unstructured.ingest.runner import SftpRunner

if __name__ == "__main__":
    runner = SftpRunner(
        processor_config=ProcessorConfig(
            verbose=True,
            output_dir="sftp-output",
            num_processes=2,
        ),
        read_config=ReadConfig(),
        partition_config=PartitionConfig(
            partition_by_api=True,
            api_key=os.getenv("UNSTRUCTURED_API_KEY"),
        ),
        connector_config=SimpleSftpConfig(
            access_config=SftpAccessConfig(
                username=os.getenv("SFTP_USERNAME"),
                password=os.getenv("SFTP_PASSWORD"),
            ),
            remote_url="sftp://address:port/upload",
            recursive=True,
        ),
    )
    runner.run()

Additionally, you will need to pass the --partition-endpoint if you’re running the API locally. You can find more information about the unstructured API here.

For a full list of the options the CLI accepts check unstructured-ingest sftp --help.

NOTE: Keep in mind that you will need to have all the appropriate extras and dependencies for the file types of the documents contained in your data storage platform if you’re running this locally. You can find more information about this in the installation guide.