Package: airbyte-cdk
Connector Development Kit (Python)The Airbyte Python CDK is a framework for rapidly developing production-grade Airbyte connectors.The CDK currently offers helpers specific for creating Airbyte source connectors for:HTTP APIs (REST APIs, GraphQL, etc..)Generic Python sources (anything not covered by the above)The CDK provides an improved developer experience by providing basic implementation structure and abstracting away low-level glue boilerplate.This document is a general introduction to the CDK. Readers should have basic familiarity with theAirbyte Specificationbefore proceeding.Getting StartedGenerate an empty connector using the code generator. First clone the Airbyte repository then from the repository root runcdairbyte-integrations/connector-templates/generator
./generate.shthen follow the interactive prompt. Next, find allTODOs in the generated project directory -- they're accompanied by lots of comments explaining what you'll need to do in order to implement your connector. Upon completing all TODOs properly, you should have a functioning connector.Additionally, you can followthis tutorialfor a complete walkthrough of creating an HTTP connector using the Airbyte CDK.Concepts & DocumentationSee theconcepts docsfor a tour through what the API offers.Example ConnectorsHTTP Connectors:StripeSlackSimple Python connectors using the barebonesSourceabstraction:Google SheetsMailchimpContributingFirst time setupWe assumepythonpoints to Python 3.9 or higher.Setup a virtual env:python-mvenv.venvsource.venv/bin/activate
pipinstall-e".[dev]"# [dev] installs development-only dependenciesIterationIterate on the code locallyRun tests viapython -m pytest -s unit_testsPerform static type checks usingmypy airbyte_cdk.MyPyconfiguration is inmypy.ini.Runmypy <files to check>to only check specific files. This is useful as the CDK still contains code that is not compliant.Thetype_check_and_test.shscript bundles both type checking and testing in one convenient command. Feel free to use it!Autogenerated filesIf the iteration you are working on includes changes to the models, you might want to regenerate them. In order to do that, you can run:cdairbyte-cdk/python
./gradlewbuildThis will generate the files based on the schemas, add the license information and format the code. If you want to only do the former and rely on
pre-commit to the others, you can run the appropriate generation command i.e../gradlew generateComponentManifestClassFiles.TestingAll tests are located in theunit_testsdirectory. Runpython -m pytest --cov=airbyte_cdk unit_tests/to run them. This also presents a test coverage report.Building and testing a connector with your local CDKWhen developing a new feature in the CDK, you may find it helpful to run a connector that uses that new feature. You can test this in one of two ways:Running a connector locallyBuilding and running a source via DockerInstalling your local CDK into a local Python connectorIn order to get a local Python connector running your local CDK, do the following.First, make sure you have your connector's virtual environment active:# from the `airbyte/airbyte-integrations/connectors/<connector-directory>` directorysource.venv/bin/activate# if you haven't installed dependencies for your connector alreadypipinstall-e.Then, navigate to the CDK and install it in editable mode:cd../../../airbyte-cdk/python
pipinstall-e.You should see thatpiphas uninstalled the version ofairbyte-cdkdefined by your connector'ssetup.pyand installed your local CDK. Any changes you make will be immediately reflected in your editor, so long as your editor's interpreter is set to your connector's virtual environment.Building a Python connector in Docker with your local CDK installedPre-requisite: Install theairbyte-ciCLIYou can build your connector image with the local CDK using# from the airbytehq/airbyte base directoryairbyte-ciconnectors--use-local-cdk--name=<CONNECTOR>buildNote that the local CDK is injected at build time, so if you make changes, you will have to run the build command again to see them reflected.Running Connector Acceptance Tests for a single connector in Docker with your local CDK installedPre-requisite: Install theairbyte-ciCLITo run acceptance tests for a single connectors using the local CDK, from the connector directory, runairbyte-ciconnectors--use-local-cdk--name=<CONNECTOR>testWhen you don't have access to the APIThere can be some time where you do not have access to the API (either because you don't have the credentials, network access, etc...) You will probably still want to do end-to-end testing at least once. In order to do so, you can emulate the server you would be reaching using a server stubbing tool.For example, usingmockserver, you can set up an expectation file like this:{"httpRequest":{"method":"GET","path":"/data"},"httpResponse":{"body":"{\"data\": [{\"record_key\": 1}, {\"record_key\": 2}]}"}}Assuming this file has been created atsecrets/mock_server_config/expectations.json, running the following command will allow to match any requests on path/datato return the response defined in the expectation file:dockerrun-d--rm-v$(pwd)/secrets/mock_server_config:/config-p8113:8113--envMOCKSERVER_LOG_LEVEL=TRACE--envMOCKSERVER_SERVER_PORT=8113--envMOCKSERVER_WATCH_INITIALIZATION_JSON=true--envMOCKSERVER_PERSISTED_EXPECTATIONS_PATH=/config/expectations.json--envMOCKSERVER_INITIALIZATION_JSON_PATH=/config/expectations.jsonmockserver/mockserver:5.15.0HTTP requests tolocalhost:8113/datashould now return the body defined in the expectations file. To test this, the implementer either has to change the code which defines the base URL for Python source or update theurl_basefrom low-code. With the Connector Builder running in docker, you will have to use domainhost.docker.internalinstead oflocalhostas the requests are executed within docker.Publishing a new version to PyPiOpen a PROnce it is approved andmerged, an Airbyte member must run thePublish CDK Manuallyworkflow from master usingrelease-type=major|manor|patchand setting the changelog message.