From 7d8de194a2cbee1513bdd69e4ad6d639d5c46744 Mon Sep 17 00:00:00 2001 From: Joscha Feth Date: Wed, 20 Nov 2024 11:55:27 +0000 Subject: [PATCH] docs: add quickstart --- .../renderer/default/templates/README.md.j2 | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/dlt_init_openapi/renderer/default/templates/README.md.j2 b/dlt_init_openapi/renderer/default/templates/README.md.j2 index 39bcc3b..b53d558 100644 --- a/dlt_init_openapi/renderer/default/templates/README.md.j2 +++ b/dlt_init_openapi/renderer/default/templates/README.md.j2 @@ -5,6 +5,24 @@ Created with [dlt-init-openapi](https://github.com/dlt-hub/dlt-init-openapi) v. {% if config.spec_path %}Generated from local spec at `{{ config.spec_path }}`.{% endif %} {% if config.spec_url %}Generated from downloaded spec at `{{ config.spec_url }}`{% endif %} +## Quickstart + +### Set your credentials + +See [Credentials section](#credentials). + +### Run the pipeline +```sh +python {{ package_name}}_pipeline.py +``` + +### Look at the data +```sh +pip install streamlit +pip install watchdog +dlt pipeline {{ package_name}}_pipeline show +``` + ## Learn more at * https://dlthub.com