mirror of
https://github.com/Unstructured-IO/unstructured.git
synced 2025-07-22 16:37:33 +00:00
a35ff890e0
Documentation Overhaul - Added documentation hierarchy - Added options for Bash vs Python for API & Upstream Connectors - Added Introduction section (Overview, Key Concepts, Getting Started) - Redid connectors section - Installation is now broken up (needs further work)
111 lines
3.3 KiB
ReStructuredText
111 lines
3.3 KiB
ReStructuredText
Github
|
|
==========
|
|
Connect Github 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 Github dependencies as shown here.
|
|
|
|
.. code:: shell
|
|
|
|
pip install "unstructured[github]"
|
|
|
|
Run Locally
|
|
-----------
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Shell
|
|
|
|
.. code:: shell
|
|
|
|
unstructured-ingest \
|
|
github \
|
|
--url Unstructured-IO/unstructured \
|
|
--git-branch main \
|
|
--structured-output-dir github-ingest-output \
|
|
--num-processes 2 \
|
|
--verbose
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import subprocess
|
|
|
|
command = [
|
|
"unstructured-ingest",
|
|
"github",
|
|
"--url", "Unstructured-IO/unstructured",
|
|
"--git-branch", "main",
|
|
"--structured-output-dir", "github-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 \
|
|
github \
|
|
--url Unstructured-IO/unstructured \
|
|
--git-branch main \
|
|
--structured-output-dir github-ingest-output \
|
|
--num-processes 2 \
|
|
--verbose \
|
|
--partition-by-api \
|
|
--api-key "<UNSTRUCTURED-API-KEY>"
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import subprocess
|
|
|
|
command = [
|
|
"unstructured-ingest",
|
|
"github",
|
|
"--url", "Unstructured-IO/unstructured",
|
|
"--git-branch", "main",
|
|
"--structured-output-dir", "github-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())
|
|
|
|
Additionaly, 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 github --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>`_. |