Merge pull request #1 from harrystech/ynaim94/deng-2040/tap-api-gladly

DENG-2040: Implement TAP API conversions Gladly streams

.github/workflows/ci_workflow.yml

@@ -23,7 +23,7 @@ jobs:
     - name: Install Poetry
       uses: snok/install-poetry@v1
       with:
-        version: 1.1.8
+        version: 1.2.1
     - name: Install dependencies
       run: |
         poetry install
@@ -38,7 +38,7 @@ jobs:
       GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: [3.8, 3.9, 3.7]
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -24,20 +24,35 @@ pipx install git+https://github.com/ORG_NAME/tap-gladly.git@main
 
 -->
 
+## Capabilities
+
+* `catalog`
+* `state`
+* `discover`
+* `about`
+* `stream-maps`
+* `schema-flattening`
+
+## Settings
+
+| Setting             | Required | Default | Description |
+|:--------------------|:--------:|:-------:|:------------|
+| username            | True     | None    | The username to authenticate against the API service |
+| password            | True     | None    | The username to authenticate against the API service |
+| project_ids         | False    | None    | Project IDs to replicate |
+| start_date          | True     | None    | The earliest record date to sync, format %Y-%m-%dT%H:%M:%SZ |
+| api_url_base        | True     | None    | The url for the API service |
+| stream_maps         | False    | None    | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
+| stream_map_config   | False    | None    | User-defined config values to be used within map expressions. |
+| flattening_enabled  | False    | None    | 'True' to enable schema flattening and automatically expand nested properties. |
+| flattening_max_depth| False    | None    | The max depth to flatten schemas. |
+
+A full list of supported settings and capabilities is available by running: `tap-gladly --about`
+
 ## Configuration
 
 ### Accepted Config Options
 
-<!--
-Developer TODO: Provide a list of config options accepted by the tap.
-
-This section can be created by copy-pasting the CLI output from:
-
-```
-tap-gladly --about --format=markdown
-```
--->
-
 A full list of supported settings and capabilities for this
 tap is available by running:
 
@@ -77,6 +92,7 @@ Follow these instructions to contribute to this project.
 
 ```bash
 pipx install poetry
+poetry config virtualenvs.in-project true # Optional, to create a virtual env
 poetry install
 ```