mirror of
https://github.com/Unstructured-IO/unstructured.git
synced 2025-08-17 05:02:25 +00:00
333558494e
### Description Add delta table downstream destination connector Closes https://github.com/Unstructured-IO/unstructured/issues/1415
128 lines
4.2 KiB
ReStructuredText
128 lines
4.2 KiB
ReStructuredText
Reddit
|
|
==========
|
|
Connect Reddit 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 Reddit dependencies as shown here.
|
|
|
|
.. code:: shell
|
|
|
|
pip install "unstructured[reddit]"
|
|
|
|
Run Locally
|
|
-----------
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Shell
|
|
|
|
.. code:: shell
|
|
|
|
unstructured-ingest \
|
|
reddit \
|
|
--subreddit-name machinelearning \
|
|
--client-id "<client id here>" \
|
|
--client-secret "<client secret here>" \
|
|
--user-agent "Unstructured Ingest Subreddit fetcher by \u\..." \
|
|
--search-query "Unstructured" \
|
|
--num-posts 10 \
|
|
--output-dir reddit-ingest-output \
|
|
--num-processes 2 \
|
|
--verbose
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import subprocess
|
|
|
|
command = [
|
|
"unstructured-ingest",
|
|
"reddit",
|
|
"--subreddit-name", "machinelearning",
|
|
"--client-id", "<client id here>",
|
|
"--client-secret", "<client secret here>",
|
|
"--user-agent", "Unstructured Ingest Subreddit fetcher by \\u\\...",
|
|
"--search-query", "Unstructured",
|
|
"--num-posts", "10",
|
|
"--output-dir", "reddit-ingest-output",
|
|
"--num-processes", "2",
|
|
"--verbose"
|
|
]
|
|
|
|
# Run the command
|
|
process = subprocess.Popen(command, stdout=subprocess.PIPE)
|
|
output, error = process.communicate()
|
|
|
|
# Print output
|
|
if process.returncode == 0:
|
|
print('Command executed successfully. Output:')
|
|
print(output.decode())
|
|
else:
|
|
print('Command failed. Error:')
|
|
print(error.decode())
|
|
|
|
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 \
|
|
reddit \
|
|
--subreddit-name machinelearning \
|
|
--client-id "<client id here>" \
|
|
--client-secret "<client secret here>" \
|
|
--user-agent "Unstructured Ingest Subreddit fetcher by \u\..." \
|
|
--search-query "Unstructured" \
|
|
--num-posts 10 \
|
|
--output-dir reddit-ingest-output \
|
|
--num-processes 2 \
|
|
--verbose \
|
|
--partition-by-api \
|
|
--api-key "<UNSTRUCTURED-API-KEY>"
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import subprocess
|
|
|
|
command = [
|
|
"unstructured-ingest",
|
|
"reddit",
|
|
"--subreddit-name", "machinelearning",
|
|
"--client-id", "<client id here>",
|
|
"--client-secret", "<client secret here>",
|
|
"--user-agent", "Unstructured Ingest Subreddit fetcher by \\u\\...",
|
|
"--search-query", "Unstructured",
|
|
"--num-posts", "10",
|
|
"--output-dir", "reddit-ingest-output",
|
|
"--num-processes", "2",
|
|
"--verbose"
|
|
"--partition-by-api",
|
|
"--api-key", "<UNSTRUCTURED-API-KEY>",
|
|
]
|
|
|
|
# Run the command
|
|
process = subprocess.Popen(command, stdout=subprocess.PIPE)
|
|
output, error = process.communicate()
|
|
|
|
# Print output
|
|
if process.returncode == 0:
|
|
print('Command executed successfully. Output:')
|
|
print(output.decode())
|
|
else:
|
|
print('Command failed. Error:')
|
|
print(error.decode())
|
|
|
|
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 reddit --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>`_.
|