Skip to content

Commit

Permalink
Add config examples to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
edgarrmondragon committed Sep 5, 2024
1 parent a5ef92e commit 2f45921
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

<details><summary>Example configuration</summary>
<p>

```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"
]
}
]
}
```

</p>
</details>


#### Dropbox

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

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

<details><summary>Example configuration</summary>
<p>

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

</p>
</details>

### Built-in Singer SDK settings

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

0 comments on commit 2f45921

Please sign in to comment.