Skip to content

Commit fee8ac3

Browse files
authored
✨Source Reply io: Make Connector Compatible with Builder (#38661)
1 parent 4ac9552 commit fee8ac3

File tree

18 files changed

+568
-434
lines changed

18 files changed

+568
-434
lines changed

airbyte-integrations/connectors/source-reply-io/.dockerignore

Lines changed: 0 additions & 6 deletions
This file was deleted.

airbyte-integrations/connectors/source-reply-io/README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,47 @@ For information about how to use this connector within Airbyte, see [the documen
77
## Local development
88

99
### Prerequisites
10-
* Python (~=3.9)
11-
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
10+
11+
* Python (`^3.9`)
12+
* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
13+
1214

1315

1416
### Installing the connector
17+
1518
From this connector directory, run:
1619
```bash
1720
poetry install --with dev
1821
```
1922

2023

2124
### Create credentials
25+
2226
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/reply-io)
23-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_reply_io/spec.yaml` file.
27+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_reply_io/spec.yaml` file.
2428
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
2529
See `sample_files/sample_config.json` for a sample config file.
2630

2731

2832
### Locally running the connector
33+
2934
```
3035
poetry run source-reply-io spec
3136
poetry run source-reply-io check --config secrets/config.json
3237
poetry run source-reply-io discover --config secrets/config.json
3338
poetry run source-reply-io read --config secrets/config.json --catalog sample_files/configured_catalog.json
3439
```
3540

36-
### Running unit tests
37-
To run unit tests locally, from the connector directory run:
41+
### Running tests
42+
43+
To run tests locally, from the connector directory run:
44+
3845
```
39-
poetry run pytest unit_tests
46+
poetry run pytest tests
4047
```
4148

4249
### Building the docker image
50+
4351
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
4452
2. Run the following command to build the docker image:
4553
```bash
@@ -50,6 +58,7 @@ An image will be available on your host with the tag `airbyte/source-reply-io:de
5058

5159

5260
### Running as a docker container
61+
5362
Then run any of the connector commands as follows:
5463
```
5564
docker run --rm airbyte/source-reply-io:dev spec
@@ -59,16 +68,19 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
5968
```
6069

6170
### Running our CI test suite
71+
6272
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
6373
```bash
6474
airbyte-ci connectors --name=source-reply-io test
6575
```
6676

6777
### Customizing acceptance Tests
78+
6879
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.
6980
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.
7081

7182
### Dependency Management
83+
7284
All of your dependencies should be managed via Poetry.
7385
To add a new dependency, run:
7486
```bash
@@ -78,6 +90,7 @@ poetry add <package-name>
7890
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
7991

8092
## Publishing a new version of the connector
93+
8194
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
8295
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-reply-io test`
8396
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)):
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#
2-
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
2+
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
33
#

airbyte-integrations/connectors/source-reply-io/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
2+
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
33
#
44

55
from source_reply_io.run import run
Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,43 @@
11
data:
2+
registries:
3+
oss:
4+
enabled: true
5+
cloud:
6+
enabled: false
7+
remoteRegistries:
8+
pypi:
9+
enabled: true
10+
packageName: airbyte-source-reply-io
11+
connectorBuildOptions:
12+
# Please update to the latest version of the connector base image.
13+
# https://hub.docker.com/r/airbyte/python-connector-base
14+
# Please use the full address with sha256 hash to guarantee build reproducibility.
15+
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
216
connectorSubtype: api
317
connectorType: source
418
definitionId: 8cc6537e-f8a6-423c-b960-e927af76116e
5-
dockerImageTag: 0.1.2
19+
dockerImageTag: 0.1.3
620
dockerRepository: airbyte/source-reply-io
721
githubIssueLabel: source-reply-io
822
icon: reply-io.svg
923
license: MIT
1024
name: Reply.io
11-
remoteRegistries:
12-
pypi:
13-
enabled: true
14-
packageName: airbyte-source-reply-io
15-
registries:
16-
cloud:
17-
enabled: false
18-
oss:
19-
enabled: true
25+
releaseDate: 2022-10-22
2026
releaseStage: alpha
27+
supportLevel: community
2128
documentationUrl: https://docs.airbyte.com/integrations/sources/reply-io
2229
tags:
2330
- language:python
2431
- cdk:low-code
2532
ab_internal:
2633
sl: 100
2734
ql: 100
28-
supportLevel: community
29-
# Disable acceptance tests for now
30-
# They are not passing
31-
# No Airbyte Cloud usage
32-
# connectorTestSuitesOptions:
33-
# - suite: acceptanceTests
34-
# testSecrets:
35-
# - name: SECRET_SOURCE-REPLY-IO__CREDS
36-
# fileName: config.json
37-
# secretStore:
38-
# type: GSM
39-
# alias: airbyte-connector-testing-secret-store
40-
connectorBuildOptions:
41-
baseImage: docker.io/airbyte/python-connector-base:1.2.2@sha256:57703de3b4c4204bd68a7b13c9300f8e03c0189bffddaffc796f1da25d2dbea0
35+
connectorTestSuitesOptions:
36+
- suite: acceptanceTests
37+
testSecrets:
38+
- name: SECRET_SOURCE-REPLY-IO__CREDS
39+
fileName: config.json
40+
secretStore:
41+
type: GSM
42+
alias: airbyte-connector-testing-secret-store
4243
metadataSpecVersion: "1.0"

0 commit comments

Comments
 (0)