From 2f45921822cbadcc37d099b5947b2f2218f46f36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez-Mondrag=C3=B3n?= Date: Thu, 5 Sep 2024 17:57:14 -0600 Subject: [PATCH] Add config examples to readme --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/README.md b/README.md index 9d598e1..67f1040 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,33 @@ Optionally, the files definition can be provided by an external json file: | github.username | False | None | GitHub username | | github.token | False | None | GitHub token | +
Example configuration +

+ +```json +{ + "add_metadata_columns": true, + "filesystem": "github", + "github": { + "org": "MeltanoLabs", + "repo": "tap-csv" + }, + "files": [ + { + "entity": "alphabet", + "path": "tap_csv/tests/data/alphabet.csv", + "keys": [ + "col1" + ] + } + ] +} +``` + +

+
+ + #### Dropbox | Setting | Required | Default | Description | @@ -123,6 +150,31 @@ The token needs the `files.content.read` scope: [![Dropbox scopes](img/dropbox_scopes.png)](https://www.dropbox.com/developers/apps) +
Example configuration +

+ +```json +{ + "add_metadata_columns": true, + "filesystem": "dropbox", + "dropbox": { + "token": "...." + }, + "files": [ + { + "entity": "alphabet", + "path": "/alphabet.csv", + "keys": [ + "col1" + ] + } + ] +} +``` + +

+
+ ### Built-in Singer SDK settings The following settings are supported by the Singer SDK and are automatically handled by the tap: