{"id":18369595,"url":"https://github.com/unstructured-io/unstructured-platform-plugins","last_synced_at":"2026-03-03T10:09:24.991Z","repository":{"id":243116198,"uuid":"811512626","full_name":"Unstructured-IO/unstructured-platform-plugins","owner":"Unstructured-IO","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-02T11:08:23.000Z","size":457,"stargazers_count":6,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-03-02T14:37:48.714Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Unstructured-IO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-06T18:34:34.000Z","updated_at":"2026-03-02T11:08:26.000Z","dependencies_parsed_at":"2024-06-24T15:57:08.284Z","dependency_job_id":"7662571e-b96d-4b8c-80b1-b19f15c0cfe9","html_url":"https://github.com/Unstructured-IO/unstructured-platform-plugins","commit_stats":null,"previous_names":["unstructured-io/unstructured-platform-plugins"],"tags_count":39,"template":false,"template_full_name":null,"purl":"pkg:github/Unstructured-IO/unstructured-platform-plugins","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Unstructured-IO%2Funstructured-platform-plugins","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Unstructured-IO%2Funstructured-platform-plugins/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Unstructured-IO%2Funstructured-platform-plugins/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Unstructured-IO%2Funstructured-platform-plugins/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Unstructured-IO","download_url":"https://codeload.github.com/Unstructured-IO/unstructured-platform-plugins/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Unstructured-IO%2Funstructured-platform-plugins/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30040445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T06:58:30.252Z","status":"ssl_error","status_checked_at":"2026-03-03T06:58:15.329Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T23:29:54.627Z","updated_at":"2026-03-03T10:09:24.926Z","avatar_url":"https://github.com/Unstructured-IO.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unstructured Platform Plugins\n ![CI](https://github.com/Unstructured-IO/unstructured-platform-plugins/actions/workflows/ci.yml/badge.svg?branch=main)\n\nInformation about how to build custom plugins to integrate with Unstructured Platform.\n\n## Plugin Development\nAny plugin must be published in a dedicated docker image with all required dependencies that when run, exposes an api \non port 8000 with the required endpoints to interact with the Unstructured Platform product:\n* `/invoke`: A `POST` endpoint which gets all data to run the underlying logic in the request body and expects a json serializable response. \n* `/schema`: A `GET` endpoint which publishes a json schema formatted response with the schema of the input and output expected by the plugin.\n* `/id`: A `GET` endpoint which publishes a string unique identifier for this instance of the plugin. Will default to a hash of the schema \nresponse if one is not set explicitly.\n\n\n## Utility CLI\nWhen installing this repo, it also installs the cli `etl-uvicorn`. This takes a pointer to any generic python \nfunction and wraps it in a FastApi application to conform to the patterns that are expected by the api hosting the \nplugin logic. This cli extends the existing `uvicorn` cli which takes in a pointer to a fastapi instance or factory but \ninstead takes in a pointer to a python function/class which gets wrapped with a FastApi application. \n\n## Example usage\nFor all following commands, make sure you have the local repo in your `PYTHONPATH`:\n```shell\nexport PYTHONPATH=.\n```\n\nWrapping a basic function with a typed dict response\n```shell\netl-uvicorn test.assets.typed_dict_response:sample_function\n```\n\nWrapping a basic async function with a typed dict response\n```shell\netl-uvicorn test.assets.async_typed_dict_response:async_sample_function\n```\n\nWrapping a class. For this to work, the class must be self instantiating. When passing a class in, a method needs to \nbe passed in as well, otherwise `__call__` is used. The following example returns a pydantic BaseModel\n```shell\netl-uvicorn test.assets.pydantic_response_class_method:SampleClass --method-name sample_method\n```\n\nWrapping an instance of a class.\n```shell\netl-uvicorn test.assets.pydantic_response_class_method:sample_class --method-name sample_method\n```\n\nThe CLI does some validation on the wrapped function, which must have explicit inputs and outputs, meaning *args \nand **kwargs are not supported. These will cause the cli to fail fast.\n```shell\netl-uvicorn test.assets.improper_function:sample_improper_function\n```\n\n### /id requirements\nAll the the above examples caused the CLI to autogenerate the `/id` endpoint with a hash of the generated schema. \nHowever, you can also provide it a reference to use for the id value. This can be a reference to a concrete \nvalue (i.e. `plugin_id=\"my_plugin_id\"`) or a function in the same way that one was passed in to be wrapped above. \n\nWill populate the response of `/id` with the static value of `hash_value`:\n```shell\netl-uvicorn test.assets.typed_dict_response:sample_function --plugin-id test.assets.simple_hash_value:hash_value\n```\n\nCan populate it using a lambda:\n```shell\netl-uvicorn test.assets.typed_dict_response:sample_function --plugin-id test.assets.simple_hash_lambda:hash_lambda_fn\n```\n\nSimilar to the function being wrapped, can also use a class:\n```shell\netl-uvicorn test.assets.typed_dict_response:sample_function --plugin-id test.assets.simple_hash_class:GetHash --plugin-id-method my_hash\n```\n\nOr the instantiated class:\n```shell\netl-uvicorn test.assets.typed_dict_response:sample_function --plugin-id test.assets.simple_hash_class:get_hash_class_instance --plugin-id-method my_hash\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funstructured-io%2Funstructured-platform-plugins","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funstructured-io%2Funstructured-platform-plugins","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funstructured-io%2Funstructured-platform-plugins/lists"}