Skip to content

docs: add quickstart #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

docs: add quickstart #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions dlt_init_openapi/renderer/default/templates/README.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down