Skip to content

Commit 2f45921

Browse files
Add config examples to readme
1 parent a5ef92e commit 2f45921

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,33 @@ Optionally, the files definition can be provided by an external json file:
112112
| github.username | False | None | GitHub username |
113113
| github.token | False | None | GitHub token |
114114

115+
<details><summary>Example configuration</summary>
116+
<p>
117+
118+
```json
119+
{
120+
"add_metadata_columns": true,
121+
"filesystem": "github",
122+
"github": {
123+
"org": "MeltanoLabs",
124+
"repo": "tap-csv"
125+
},
126+
"files": [
127+
{
128+
"entity": "alphabet",
129+
"path": "tap_csv/tests/data/alphabet.csv",
130+
"keys": [
131+
"col1"
132+
]
133+
}
134+
]
135+
}
136+
```
137+
138+
</p>
139+
</details>
140+
141+
115142
#### Dropbox
116143

117144
| Setting | Required | Default | Description |
@@ -123,6 +150,31 @@ The token needs the `files.content.read` scope:
123150

124151
[![Dropbox scopes](img/dropbox_scopes.png)](https://www.dropbox.com/developers/apps)
125152

153+
<details><summary>Example configuration</summary>
154+
<p>
155+
156+
```json
157+
{
158+
"add_metadata_columns": true,
159+
"filesystem": "dropbox",
160+
"dropbox": {
161+
"token": "...."
162+
},
163+
"files": [
164+
{
165+
"entity": "alphabet",
166+
"path": "/alphabet.csv",
167+
"keys": [
168+
"col1"
169+
]
170+
}
171+
]
172+
}
173+
```
174+
175+
</p>
176+
</details>
177+
126178
### Built-in Singer SDK settings
127179

128180
The following settings are supported by the Singer SDK and are automatically handled by the tap:

0 commit comments

Comments
 (0)