mirror of
https://github.com/Unstructured-IO/unstructured.git
synced 2025-08-18 21:57:58 +00:00
cde11d1eb0
Adds source connector for SFTP which uses fsspec and paramiko via fsspec. Paramiko is the standard sftp package for python used in pysftp etc... ``` --username foo \ --password bar \ --remote-url sftp://localhost:47474/upload/ ``` Will only download a specifically requested file if it has an extension. (i.e. `--remote-url sftp://localhost:47474/upload/bob.zip`) It will treat any other remote_url as a folder path. This is intentional. --------- Co-authored-by: potter-potter <david.potter@gmail.com>
128 lines
3.9 KiB
ReStructuredText
128 lines
3.9 KiB
ReStructuredText
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 .
|
|
|
|
.. code:: shell
|
|
|
|
pip install "unstructured[sftp]"
|
|
|
|
Run Locally
|
|
-----------
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Shell
|
|
|
|
.. code:: shell
|
|
|
|
unstructured-ingest \
|
|
sftp \
|
|
--remote-url sftp://address:port/upload \
|
|
--username foo \
|
|
--password bar \
|
|
--output-dir sftp-output \
|
|
--num-processes 2 \
|
|
--recursive \
|
|
--verbose
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import os
|
|
|
|
from unstructured.ingest.interfaces import (
|
|
FsspecConfig,
|
|
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(),
|
|
fsspec_config=FsspecConfig(
|
|
remote_url="sftp://address:port/upload",
|
|
recursive=True,
|
|
),
|
|
)
|
|
runner.run(
|
|
username=os.getenv("SFTP_USERNAME"),
|
|
password=os.getenv("SFTP_PASSWORD"),
|
|
)
|
|
|
|
|
|
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``.
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Shell
|
|
|
|
.. code:: shell
|
|
|
|
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>"
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import os
|
|
|
|
from unstructured.ingest.interfaces import (
|
|
FsspecConfig,
|
|
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(),
|
|
fsspec_config=FsspecConfig(
|
|
remote_url="sftp://address:port/upload",
|
|
recursive=True,
|
|
),
|
|
)
|
|
runner.run(
|
|
username=os.getenv("SFTP_USERNAME"),
|
|
password=os.getenv("SFTP_PASSWORD"),
|
|
)
|
|
|
|
|
|
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 <https://github.com/Unstructured-IO/unstructured-api>`_.
|
|
|
|
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 <https://unstructured-io.github.io/unstructured/installing.html>`_.
|