mirror of
https://github.com/Unstructured-IO/unstructured.git
synced 2025-07-09 01:55:55 +00:00
9d81971fcb
### Description Updating the python version of the example docs to show how to run the same code that the CLI runs, but using python. Rather than copying the same command that would be run via the terminal and using the subprocess library to run it, this updates it to use the supported code exposed in the inference directory. For now only the wikipedia one has been updated to get some opinions on this before updating all other connector docs. Would close out https://github.com/Unstructured-IO/unstructured/issues/1445
96 lines
3.0 KiB
ReStructuredText
96 lines
3.0 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 \
|
|
--output-dir github-ingest-output \
|
|
--num-processes 2 \
|
|
--verbose
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
from unstructured.ingest.interfaces import PartitionConfig, ReadConfig
|
|
from unstructured.ingest.runner.github import github
|
|
|
|
if __name__ == "__main__":
|
|
github(
|
|
verbose=True,
|
|
read_config=ReadConfig(),
|
|
partition_config=PartitionConfig(
|
|
output_dir="github-ingest-output",
|
|
num_processes=2,
|
|
),
|
|
url="Unstructured-IO/unstructured",
|
|
git_branch="main",
|
|
)
|
|
|
|
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 \
|
|
--output-dir github-ingest-output \
|
|
--num-processes 2 \
|
|
--verbose \
|
|
--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.github import github
|
|
|
|
if __name__ == "__main__":
|
|
github(
|
|
verbose=True,
|
|
read_config=ReadConfig(),
|
|
partition_config=PartitionConfig(
|
|
output_dir="github-ingest-output",
|
|
num_processes=2,
|
|
partition_by_api=True,
|
|
api_key=os.getenv("UNSTRUCTURED_API_KEY"),
|
|
),
|
|
url="Unstructured-IO/unstructured",
|
|
git_branch="main",
|
|
)
|
|
|
|
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 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>`_.
|