unstructured/docs/source/source_connectors/sharepoint.rst

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

First you'll need to install the Sharepoint dependencies as shown here.

.. code:: shell

  pip install "unstructured[sharepoint]"

Run Locally
-----------

.. tabs::

   .. tab:: Shell

      .. code:: shell

        unstructured-ingest \
          sharepoint \
          --client-id "<Microsoft Sharepoint app client-id>" \
          --client-cred "<Microsoft Sharepoint app client-secret>" \
          --site "<e.g https://contoso.sharepoint.com or https://contoso.admin.sharepoint.com to process all sites within tenant>" \
          --files-only "Flag to process only files within the site(s)" \
          --output-dir sharepoint-ingest-output \
          --num-processes 2 \
          --path "Shared Documents" \
          --verbose

   .. tab:: Python

      .. code:: python

        from unstructured.ingest.interfaces import PartitionConfig, ReadConfig
        from unstructured.ingest.runner.sharepoint import sharepoint

        if __name__ == "__main__":
            sharepoint(
                verbose=True,
                read_config=ReadConfig(),
                partition_config=PartitionConfig(
                    output_dir="sharepoint-ingest-output",
                    num_processes=2,
                ),
                client_id="<Microsoft Sharepoint app client-id>",
                client_cred="<Microsoft Sharepoint app client-secret>",
                site="<e.g https://contoso.sharepoint.com to process all sites within tenant>",
                # Flag to process only files within the site(s)
                files_only=True,
                path="Shared Documents",
                recursive=False,
            )

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 \
          sharepoint \
          --client-id "<Microsoft Sharepoint app client-id>" \
          --client-cred "<Microsoft Sharepoint app client-secret>" \
          --site "<e.g https://contoso.sharepoint.com or https://contoso.admin.sharepoint.com to process all sites within tenant>" \
          --files-only "Flag to process only files within the site(s)" \
          --output-dir sharepoint-ingest-output \
          --num-processes 2 \
          --verbose \
          --path "Shared Documents" \
          --partition-by-api \
          --api-key "<UNSTRUCTURED-API-KEY>"

   .. tab:: Python

      .. code:: python

        import os

        from unstructured.ingest.interfaces import PartitionConfig, ReadConfig
        from unstructured.ingest.runner.sharepoint import sharepoint

        if __name__ == "__main__":
            sharepoint(
                verbose=True,
                read_config=ReadConfig(),
                partition_config=PartitionConfig(
                    output_dir="sharepoint-ingest-output",
                    num_processes=2,
                    partition_by_api=True,
                    api_key=os.getenv("UNSTRUCTURED_API_KEY"),
                ),
                client_id="<Microsoft Sharepoint app client-id>",
                client_cred="<Microsoft Sharepoint app client-secret>",
                site="<e.g https://contoso.sharepoint.com to process all sites within tenant>",
                # Flag to process only files within the site(s)
                files_only=True,
                path="Shared Documents",
                recursive=False,
            )

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 sharepoint --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>`_.