jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-25 02:09:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

Source plaid: Migrate to manifest-only (#44086)

Browse Source
This commit is contained in:
Christo Grabowski
2024-08-15 20:16:24 -04:00
committed by GitHub
parent bb49428970
commit d26bc47771
11 changed files with 40 additions and 1497 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
airbyte-integrations/connectors/source-plaid/README.md
View File

@@ -1,89 +1,63 @@
# Plaid source connector
This directory contains the manifest-only connector for `source-plaid`.
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
This is the repository for the Plaid source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/plaid).
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/plaid).
## Local development
### Prerequisites
* Python (~=3.9)
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
We recommend using the Connector Builder to edit this connector.
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
### Installing the connector
From this connector directory, run:
```bash
poetry install --with dev
```
### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/plaid)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_plaid/spec.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See `sample_files/sample_config.json` for a sample config file.
### Locally running the connector
```
poetry run source-plaid spec
poetry run source-plaid check --config secrets/config.json
poetry run source-plaid discover --config secrets/config.json
poetry run source-plaid read --config secrets/config.json --catalog sample_files/configured_catalog.json
```
### Running unit tests
To run unit tests locally, from the connector directory run:
```
poetry run pytest unit_tests
```
If you prefer to develop locally, you can follow the instructions below.
### Building the docker image
You can build any manifest-only connector with `airbyte-ci`:
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:
```bash
airbyte-ci connectors --name=source-plaid build
```
An image will be available on your host with the tag `airbyte/source-plaid:dev`.
### Creating credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/plaid)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
### Running as a docker container
Then run any of the connector commands as follows:
```
Then run any of the standard source connector commands:
```bash
docker run --rm airbyte/source-plaid:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-plaid:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-plaid:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-plaid:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
### Running our CI test suite
### Running the CI test suite
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
```bash
airbyte-ci connectors --name=source-plaid test
```
### Customizing acceptance Tests
Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
### Dependency Management
All of your dependencies should be managed via Poetry.
To add a new dependency, run:
```bash
poetry add <package-name>
```
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
## 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 our test suite: `airbyte-ci connectors --name=source-plaid test`
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
If you want to contribute changes to `source-plaid`, here's how you can do that:
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-plaid test`
3. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
- bump the `dockerImageTag` value in in `metadata.yaml`
- bump the `version` value in `pyproject.toml`
3. Make sure the `metadata.yaml` content is up to date.
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/plaid.md`).
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.

2
airbyte-integrations/connectors/source-plaid/acceptance-test-config.yml
View File

@@ -4,7 +4,7 @@ connector_image: airbyte/source-plaid:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_plaid/spec.yaml"
- spec_path: "manifest.yaml"
connection:
tests:
- config_path: "secrets/config.json"

8
airbyte-integrations/connectors/source-plaid/main.py
View File

@@ -1,8 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
from source_plaid.run import run
if __name__ == "__main__":
run()

7
airbyte-integrations/connectors/source-plaid/source_plaid/manifest.yaml → airbyte-integrations/connectors/source-plaid/manifest.yaml
View File

@@ -1,4 +1,4 @@
version: 0.50.0
version: 4.3.0
type: DeclarativeSource
check:
type: CheckStream
@@ -70,26 +70,31 @@ streams:
- path:
- available
value: "{{record['balances']['available']}}"
type: AddedFieldDefinition
- type: AddFields
fields:
- path:
- current
value: "{{record['balances']['current']}}"
type: AddedFieldDefinition
- type: AddFields
fields:
- path:
- iso_currency_code
value: "{{record['balances']['iso_currency_code']}}"
type: AddedFieldDefinition
- type: AddFields
fields:
- path:
- limit
value: "{{record['balances']['limit']}}"
type: AddedFieldDefinition
- type: AddFields
fields:
- path:
- unofficial_currency_code
value: "{{record['balances']['unofficial_currency_code']}}"
type: AddedFieldDefinition
- type: RemoveFields
field_pointers:
- - balances

8
airbyte-integrations/connectors/source-plaid/metadata.yaml
View File

@@ -2,7 +2,7 @@ data:
connectorSubtype: api
connectorType: source
definitionId: ed799e2b-2158-4c66-8da4-b40fe63bc72a
dockerImageTag: 0.4.13
dockerImageTag: 0.5.0
dockerRepository: airbyte/source-plaid
githubIssueLabel: source-plaid
icon: plaid.svg
@@ -10,7 +10,7 @@ data:
name: Plaid
remoteRegistries:
pypi:
enabled: true
enabled: false
packageName: airbyte-source-plaid
registryOverrides:
cloud:
@@ -20,8 +20,8 @@ data:
releaseStage: alpha
documentationUrl: https://docs.airbyte.com/integrations/sources/plaid
tags:
- language:python
- cdk:low-code
- language:manifest-only
ab_internal:
sl: 100
ql: 100
@@ -38,5 +38,5 @@ data:
# type: GSM
# alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
baseImage: docker.io/airbyte/source-declarative-manifest:4.4.1@sha256:a8c0f0d32782957beef2c65bac98756b04fff2f3ffc4568a6676d3c83a422a5b
metadataSpecVersion: "1.0"

1361
airbyte-integrations/connectors/source-plaid/poetry.lock generated
View File

File diff suppressed because it is too large Load Diff

28
airbyte-integrations/connectors/source-plaid/pyproject.toml
View File

@@ -1,28 +0,0 @@
[build-system]
requires = [ "poetry-core>=1.0.0",]
build-backend = "poetry.core.masonry.api"
[tool.poetry]
version = "0.4.13"
name = "source-plaid"
description = "Source implementation for Plaid."
authors = [ "Airbyte <contact@airbyte.io>",]
license = "MIT"
readme = "README.md"
documentation = "https://docs.airbyte.com/integrations/sources/plaid"
homepage = "https://airbyte.com"
repository = "https://github.com/airbytehq/airbyte"
[[tool.poetry.packages]]
include = "source_plaid"
[tool.poetry.dependencies]
python = "^3.9,<3.12"
airbyte-cdk = "^0"
[tool.poetry.scripts]
source-plaid = "source_plaid.run:run"
[tool.poetry.group.dev.dependencies]
pytest = "^6.2"
requests-mock = "^1.9.3"
pytest-mock = "^3.6.1"

8
airbyte-integrations/connectors/source-plaid/source_plaid/__init__.py
View File

@@ -1,8 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
from .source import SourcePlaid
__all__ = ["SourcePlaid"]

14
airbyte-integrations/connectors/source-plaid/source_plaid/run.py
View File

@@ -1,14 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
import sys
from airbyte_cdk.entrypoint import launch
from source_plaid import SourcePlaid
def run():
source = SourcePlaid()
launch(source, sys.argv[1:])

18
airbyte-integrations/connectors/source-plaid/source_plaid/source.py
View File

@@ -1,18 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource
"""
This file provides the necessary constructs to interpret a provided declarative YAML configuration file into
source connector.
WARNING: Do not modify this file.
"""
# Declarative Source
class SourcePlaid(YamlDeclarativeSource):
def __init__(self):
super().__init__(**{"path_to_yaml": "manifest.yaml"})

1
docs/integrations/sources/plaid.md
View File

@@ -73,6 +73,7 @@ This guide will walk through how to create the credentials you need to run this
| Version | Date | Pull Request | Subject |
| :------ | :--------- | :------------------------------------------------------- | :------------------------------------------------------------ |
| 0.5.0 | 2024-08-14 | [44086](https://github.com/airbytehq/airbyte/pull/44086) | Refactor connector to manifest-only format |
| 0.4.13 | 2024-08-12 | [43861](https://github.com/airbytehq/airbyte/pull/43861) | Update dependencies |
| 0.4.12 | 2024-08-10 | [43663](https://github.com/airbytehq/airbyte/pull/43663) | Update dependencies |
| 0.4.11 | 2024-08-03 | [43239](https://github.com/airbytehq/airbyte/pull/43239) | Update dependencies |