Skip to content

Commit

Permalink
✨Source Omnisend: Make Connector Compatible with Builder (#38664)
Browse files Browse the repository at this point in the history
  • Loading branch information
pabloescoder committed Jun 27, 2024
1 parent 7dcfa69 commit d3d943d
Show file tree
Hide file tree
Showing 19 changed files with 1,007 additions and 758 deletions.
6 changes: 0 additions & 6 deletions airbyte-integrations/connectors/source-omnisend/.dockerignore

This file was deleted.

26 changes: 19 additions & 7 deletions airbyte-integrations/connectors/source-omnisend/README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,52 @@
# Omnisend source connector


This is the repository for the Omnisend source connector, written in Python.
This is the repository for the Omnisend configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/omnisend).

## Local development

### Prerequisites
* Python (~=3.9)
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)

* Python (`^3.9`)
* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)



### 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/omnisend)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_omnisend/spec.yaml` file.
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_omnisend/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-omnisend spec
poetry run source-omnisend check --config secrets/config.json
poetry run source-omnisend discover --config secrets/config.json
poetry run source-omnisend read --config secrets/config.json --catalog sample_files/configured_catalog.json
```

### Running unit tests
To run unit tests locally, from the connector directory run:
### Running tests

To run tests locally, from the connector directory run:

```
poetry run pytest unit_tests
```

### Building the docker image

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
Expand All @@ -50,6 +57,7 @@ An image will be available on your host with the tag `airbyte/source-omnisend:de


### Running as a docker container

Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-omnisend:dev spec
Expand All @@ -59,16 +67,19 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
```

### Running our 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-omnisend 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
Expand All @@ -78,6 +89,7 @@ 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-omnisend 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)):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
#
2 changes: 1 addition & 1 deletion airbyte-integrations/connectors/source-omnisend/main.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
#

from source_omnisend.run import run
Expand Down
30 changes: 17 additions & 13 deletions airbyte-integrations/connectors/source-omnisend/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,31 +1,37 @@
data:
registries:
oss:
enabled: true
cloud:
enabled: true
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-omnisend
connectorBuildOptions:
# Please update to the latest version of the connector base image.
# https://hub.docker.com/r/airbyte/python-connector-base
# Please use the full address with sha256 hash to guarantee build reproducibility.
baseImage: docker.io/airbyte/python-connector-base:1.2.2@sha256:57703de3b4c4204bd68a7b13c9300f8e03c0189bffddaffc796f1da25d2dbea0
connectorSubtype: api
connectorType: source
definitionId: e7f0c5e2-4815-48c4-90cf-f47124209835
dockerImageTag: 0.1.3
dockerImageTag: 0.1.4
dockerRepository: airbyte/source-omnisend
githubIssueLabel: source-omnisend
icon: omnisend.svg
license: MIT
name: Omnisend
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-omnisend
registries:
cloud:
enabled: true
oss:
enabled: true
releaseDate: 2022-10-25
releaseStage: alpha
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/omnisend
tags:
- language:python
- cdk:low-code
ab_internal:
sl: 100
ql: 100
supportLevel: community
connectorTestSuitesOptions:
- suite: acceptanceTests
testSecrets:
Expand All @@ -34,6 +40,4 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.2@sha256:57703de3b4c4204bd68a7b13c9300f8e03c0189bffddaffc796f1da25d2dbea0
metadataSpecVersion: "1.0"

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
build-backend = "poetry.core.masonry.api"

[tool.poetry]
version = "0.1.3"
version = "0.1.4"
name = "source-omnisend"
description = "Source implementation for Omnisend."
authors = [ "Airbyte <contact@airbyte.io>",]
Expand All @@ -12,8 +12,7 @@ readme = "README.md"
documentation = "https://docs.airbyte.com/integrations/sources/omnisend"
homepage = "https://airbyte.com"
repository = "https://github.com/airbytehq/airbyte"
[[tool.poetry.packages]]
include = "source_omnisend"
packages = [ { include = "source_omnisend" }, {include = "main.py" } ]

[tool.poetry.dependencies]
python = "^3.9,<3.12"
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
#


Expand Down
Loading

0 comments on commit d3d943d

Please sign in to comment.