diff --git a/catalog/justfile b/catalog/justfile index 1f0f713d93d..f1054d56f54 100644 --- a/catalog/justfile +++ b/catalog/justfile @@ -172,3 +172,7 @@ generate-docs doc="dag" fail_on_diff="false": # Generate files for a new provider add-provider provider_name endpoint +media_types="image": python3 templates/create_provider_ingester.py "{{ provider_name }}" "{{ endpoint }}" -m {{ media_types }} + +# Run bash in the container set in the SERVICE env-var +run: + just ../run {{ SERVICE }} bash diff --git a/documentation/catalog/guides/adding_a_new_provider.md b/documentation/catalog/guides/adding_a_new_provider.md index 3dc22390aa2..d3e8a04b83c 100644 --- a/documentation/catalog/guides/adding_a_new_provider.md +++ b/documentation/catalog/guides/adding_a_new_provider.md @@ -97,6 +97,19 @@ in the as well as a corresponding test file. Complete the TODOs detailed in the generated files to implement behavior specific to your API. +You can run the provider script directly from the command line via a just +recipe. This will open a bash shell inside the docker stack of the catalog. + +``` +just catalog/run +``` + +Now you can just run the script like so: + +``` +python catalog/dags/providers/provider_api_scripts/.py +``` + Some APIs may not fit perfectly into the established `ProviderDataIngester` pattern. For advanced use cases and examples of how to modify the ingestion flow, see the