Python Demo Destination: KVDB

.github/workflows/publish-command.yml

@@ -79,6 +79,7 @@ jobs:
           BIGQUERY_INTEGRATION_TEST_CREDS: ${{ secrets.BIGQUERY_INTEGRATION_TEST_CREDS }}
           BRAINTREE_TEST_CREDS: ${{ secrets.BRAINTREE_TEST_CREDS }}
           DESTINATION_PUBSUB_TEST_CREDS: ${{ secrets.DESTINATION_PUBSUB_TEST_CREDS }}
+          DESTINATION_KVDB_TEST_CREDS: ${{ secrets.DESTINATION_KVDB_TEST_CREDS }}
           DRIFT_INTEGRATION_TEST_CREDS: ${{ secrets.DRIFT_INTEGRATION_TEST_CREDS }}
           EXCHANGE_RATES_TEST_CREDS: ${{ secrets.EXCHANGE_RATES_TEST_CREDS }}
           FACEBOOK_MARKETING_TEST_INTEGRATION_CREDS: ${{ secrets.FACEBOOK_MARKETING_TEST_INTEGRATION_CREDS }}

.github/workflows/test-command.yml

@@ -77,6 +77,7 @@ jobs:
           BIGQUERY_INTEGRATION_TEST_CREDS: ${{ secrets.BIGQUERY_INTEGRATION_TEST_CREDS }}
           BRAINTREE_TEST_CREDS: ${{ secrets.BRAINTREE_TEST_CREDS }}
           DESTINATION_PUBSUB_TEST_CREDS: ${{ secrets.DESTINATION_PUBSUB_TEST_CREDS }}
+          DESTINATION_KVDB_TEST_CREDS: ${{ secrets.DESTINATION_KVDB_TEST_CREDS }}
           DRIFT_INTEGRATION_TEST_CREDS: ${{ secrets.DRIFT_INTEGRATION_TEST_CREDS }}
           EXCHANGE_RATES_TEST_CREDS: ${{ secrets.EXCHANGE_RATES_TEST_CREDS }}
           FACEBOOK_MARKETING_TEST_INTEGRATION_CREDS: ${{ secrets.FACEBOOK_MARKETING_TEST_INTEGRATION_CREDS }}

airbyte-integrations/bases/base-normalization/build.gradle

@@ -12,8 +12,6 @@ dependencies {
 }
 
 installReqs.dependsOn(":airbyte-integrations:bases:airbyte-protocol:installReqs")
-
-project.task('integrationTest')
 integrationTest.dependsOn(build)
 
 task("customIntegrationTestPython", type: PythonTask, dependsOn: installTestReqs){

airbyte-integrations/connector-templates/destination-python/destination_{{snakeCase name}}/spec.json

@@ -1,6 +1,8 @@
 {
   "documentationUrl": "https://docs.airbyte.io/integrations/destinations/{{kebabCase name}}",
-  "supported_destination_sync_modes": ["TODO, available options are: 'overwrite', 'append', and 'append_dedup'"],
+  "supported_destination_sync_modes": [
+    "TODO, available options are: 'overwrite', 'append', and 'append_dedup'"
+  ],
   "supportsIncremental": true,
   "supportsDBT": false,
   "supportsNormalization": false,

airbyte-integrations/connector-templates/destination-python/requirements.txt

@@ -0,0 +1 @@
+-e .

airbyte-integrations/connector-templates/generator/build.gradle

@@ -41,5 +41,6 @@ def addScaffoldTemplateTask(name, packageName,scaffoldParams=[]) {
 addScaffoldTemplateTask('Python Source', 'scaffold-source-python')
 addScaffoldTemplateTask('Python HTTP API Source', 'scaffold-source-http')
 addScaffoldTemplateTask('Java JDBC Source', 'scaffold-java-jdbc')
+addScaffoldTemplateTask('Python Destination', 'scaffold-destination-python')
 // TODO: enable Singer template testing
 //addScaffoldTask('source-python-singer', ['tap-exchangeratesapi'])

airbyte-integrations/connector-templates/generator/plopfile.js

@@ -32,6 +32,7 @@ module.exports = function (plop) {
   const genericJdbcSourceInputRoot = '../source-java-jdbc';
   const httpApiInputRoot = '../source-python-http-api';
   const javaDestinationInput = '../destination-java';
+  const pythonDestinationInputRoot = '../destination-python';
 
   const outputDir = '../../connectors';
   const pythonSourceOutputRoot = `${outputDir}/source-{{dashCase name}}`;
@@ -40,11 +41,35 @@ module.exports = function (plop) {
   const genericJdbcSourceOutputRoot = `${outputDir}/source-{{dashCase name}}`;
   const httpApiOutputRoot = `${outputDir}/source-{{dashCase name}}`;
   const javaDestinationOutputRoot = `${outputDir}/destination-{{dashCase name}}`;
+  const pythonDestinationOutputRoot = `${outputDir}/destination-{{dashCase name}}`;
 
   plop.setActionType('emitSuccess', function(answers, config, plopApi){
       console.log(getSuccessMessage(answers.name, plopApi.renderString(config.outputPath, answers), config.message));
   });
 
+  plop.setGenerator('Python Destination', {
+    description: 'Generate a destination connector written in Python',
+    prompts: [{type:'input', name:'name', 'message': 'Connector name e.g: redis'}],
+    actions: [
+      {
+        abortOnFail: true,
+        type:'addMany',
+        destination: pythonDestinationOutputRoot,
+        base: pythonDestinationInputRoot,
+        templateFiles: `${pythonDestinationInputRoot}/**/**`,
+      },
+      // plop doesn't add dotfiles by default so we manually add them
+      {
+        type:'add',
+        abortOnFail: true,
+        templateFile: `${pythonDestinationInputRoot}/.dockerignore`,
+        path: `${pythonDestinationOutputRoot}/.dockerignore`
+      },
+      {type: 'emitSuccess', outputPath: pythonDestinationOutputRoot}
+    ]
+
+  })
+
   plop.setGenerator('Python HTTP API Source', {
     description: 'Generate a Source that pulls data from a synchronous HTTP API.',
     prompts: [{type: 'input', name: 'name', message: 'Source name e.g: "google-analytics"'}],
@@ -110,12 +135,6 @@ module.exports = function (plop) {
                 base: pythonSourceInputRoot,
                 templateFiles: `${pythonSourceInputRoot}/**/**`,
             },
-            {
-                type:'add',
-                abortOnFail: true,
-                templateFile: `${pythonSourceInputRoot}/.gitignore.hbs`,
-                path: `${pythonSourceOutputRoot}/.gitignore`
-            },
             {
                 type:'add',
                 abortOnFail: true,

airbyte-integrations/connectors/destination-kvdb/.dockerignore

@@ -0,0 +1,5 @@
+*
+!Dockerfile
+!main.py
+!destination_kvdb
+!setup.py

airbyte-integrations/connectors/destination-kvdb/Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.7.11-alpine3.14
+
+# Bash is installed for more convenient debugging.
+RUN apt-get update && apt-get install -y bash && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /airbyte/integration_code
+COPY destination_kvdb ./destination_kvdb
+COPY main.py ./
+COPY setup.py ./
+RUN pip install .
+
+ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
+ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
+
+LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.name=airbyte/destination-kvdb

airbyte-integrations/connectors/destination-kvdb/README.md

@@ -0,0 +1,125 @@
+# Kvdb Destination
+
+This is the repository for the [Kvdb](kvdb.io) destination connector, written in Python. It is intended to be an example for how to write a Python destination. KvDB is a very simple key value store, which makes it great for the purposes of illustrating how to write a Python destination connector. 
+
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/destinations/kvdb).
+
+
+## Local development
+
+### Prerequisites
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+#### Minimum Python version required `= 3.7.0`
+
+#### Build & Activate Virtual Environment and install dependencies
+From this connector directory, create a virtual environment:
+```
+python -m venv .venv
+```
+
+This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
+development environment of choice. To activate it from the terminal, run:
+```
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
+
+Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
+used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
+If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
+should work as you expect.
+
+#### Building via Gradle
+From the Airbyte repository root, run:
+```
+./gradlew :airbyte-integrations:connectors:destination-kvdb:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/destinations/kvdb)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `destination_kvdb/spec.json` file.
+Note that the `secrets` directory is gitignored by default, so there is no danger of accidentally checking in sensitive information.
+See `integration_tests/sample_config.json` for a sample config file.
+
+**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `destination kvdb test creds`
+and place them into `secrets/config.json`.
+
+### Locally running the connector
+```
+python main.py spec
+python main.py check --config secrets/config.json
+python main.py discover --config secrets/config.json
+python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
+```
+
+### Locally running the connector docker image
+
+#### Build
+First, make sure you build the latest Docker image:
+```
+docker build . -t airbyte/destination-kvdb:dev
+```
+
+You can also build the connector image via Gradle:
+```
+./gradlew :airbyte-integrations:connectors:destination-kvdb:airbyteDocker
+```
+When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
+the Dockerfile.
+
+#### Run
+Then run any of the connector commands as follows:
+```
+docker run --rm airbyte/destination-kvdb:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-kvdb:dev check --config /secrets/config.json
+# messages.jsonl is a file containing line-separated JSON representing AirbyteMessages
+cat messages.jsonl | docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-kvdb:dev write --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+```
+## Testing
+   Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
+First install test dependencies into your virtual environment:
+```
+pip install .[tests]
+```
+### Unit Tests
+To run unit tests locally, from the connector directory run:
+```
+python -m pytest unit_tests
+```
+
+### Integration Tests
+There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all destination connectors) and custom integration tests (which are specific to this connector).
+#### Custom Integration tests
+Place custom tests inside `integration_tests/` folder, then, from the connector root, run
+```
+python -m pytest integration_tests
+```
+#### Acceptance Tests
+Coming soon: 
+
+### Using gradle to run tests
+All commands should be run from airbyte project root.
+To run unit tests:
+```
+./gradlew :airbyte-integrations:connectors:destination-kvdb:unitTest
+```
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:destination-kvdb:integrationTest
+```
+
+## Dependency Management
+All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
+We split dependencies between two groups, dependencies that are:
+* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
+* required for the testing need to go to `TEST_REQUIREMENTS` list
+
+### Publishing a new version of the connector
+You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
+1. Make sure your changes are passing unit and integration tests.
+1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
+1. Create a Pull Request.
+1. Pat yourself on the back for being an awesome contributor.
+1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

airbyte-integrations/connectors/destination-kvdb/build.gradle

@@ -0,0 +1,8 @@
+plugins {
+    id 'airbyte-python'
+    id 'airbyte-docker'
+}
+
+airbytePython {
+    moduleDirectory 'destination_kvdb'
+}

airbyte-integrations/connectors/destination-kvdb/destination_kvdb/__init__.py

@@ -0,0 +1,26 @@
+# MIT License
+#
+# Copyright (c) 2020 Airbyte
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+from .destination import DestinationKvdb
+
+__all__ = ["DestinationKvdb"]

airbyte-integrations/connectors/destination-kvdb/destination_kvdb/client.py

@@ -0,0 +1,98 @@
+#
+# MIT License
+#
+# Copyright (c) 2020 Airbyte
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+from typing import Any, Iterable, List, Mapping, Tuple, Union
+
+import requests
+
+
+class KvDbClient:
+    base_url = "https://kvdb.io"
+    PAGE_SIZE = 1000
+
+    def __init__(self, bucket_id: str, secret_key: str = None):
+        self.secret_key = secret_key
+        self.bucket_id = bucket_id
+
+    def write(self, key: str, value: Mapping[str, Any]):
+        return self.batch_write([(key, value)])
+
+    def batch_write(self, keys_and_values: List[Tuple[str, Mapping[str, Any]]]):
+        """
+        https://kvdb.io/docs/api/#execute-transaction
+        """
+        request_body = {"txn": [{"set": key, "value": value} for key, value in keys_and_values]}
+        return self._request("POST", json=request_body)
+
+    def list_keys(self, list_values: bool = False, prefix: str = None) -> Iterable[Union[str, List]]:
+        """
+        https://kvdb.io/docs/api/#list-keys
+        """
+        # TODO handle rate limiting
+        pagination_complete = False
+        offset = 0
+
+        while not pagination_complete:
+            response = self._request(
+                "GET",
+                params={
+                    "limit": self.PAGE_SIZE,
+                    "skip": offset,
+                    "format": "json",
+                    "prefix": prefix or "",
+                    "values": "true" if list_values else "false",
+                },
+                endpoint="/",  # the "list" endpoint doesn't work without adding a trailing slash to the URL
+            )
+
+            response_json = response.json()
+            yield from response_json
+
+            pagination_complete = len(response_json) < self.PAGE_SIZE
+            offset += self.PAGE_SIZE
+
+    def delete(self, key: Union[str, List[str]]):
+        """
+        https://kvdb.io/docs/api/#execute-transaction
+        """
+        key_list = key if isinstance(key, List) else [key]
+        request_body = {"txn": [{"delete": k} for k in key_list]}
+        return self._request("POST", json=request_body)
+
+    def _get_base_url(self) -> str:
+        return f"{self.base_url}/{self.bucket_id}"
+
+    def _get_auth_headers(self) -> Mapping[str, Any]:
+        return {"Authorization": f"Bearer {self.secret_key}"} if self.secret_key else {}
+
+    def _request(
+        self, http_method: str, endpoint: str = None, params: Mapping[str, Any] = None, json: Mapping[str, Any] = None
+    ) -> requests.Response:
+        url = self._get_base_url() + (endpoint or "")
+        headers = {"Accept": "application/json", **self._get_auth_headers()}
+
+        response = requests.request(method=http_method, params=params, url=url, headers=headers, json=json)
+
+        response.raise_for_status()
+        return response