jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-23 21:03:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

✨ Source Younium : Migrate to Manifest-only (#47281)

Browse Source 
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
This commit is contained in:
Tope Folorunso
2024-10-29 00:46:15 +01:00
committed by GitHub
parent 423d74529b
commit 3a6055d64d
14 changed files with 6262 additions and 4617 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
airbyte-integrations/connectors/source-younium/README.md
View File

@@ -1,49 +1,22 @@
# Younium source connector
This is the repository for the Younium source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/younium).
This directory contains the manifest-only connector for `source-younium`.
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/younium).
## Local development
### Prerequisites
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!
- 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/younium)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_younium/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-younium spec
poetry run source-younium check --config secrets/config.json
poetry run source-younium discover --config secrets/config.json
poetry run source-younium 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:
@@ -53,18 +26,24 @@ airbyte-ci connectors --name=source-younium build
An image will be available on your host with the tag `airbyte/source-younium:dev`.
### Creating credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/younium)
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-younium:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-younium:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-younium:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-younium: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):
@@ -72,33 +51,15 @@ You can run our full test suite locally using [`airbyte-ci`](https://github.com/
airbyte-ci connectors --name=source-younium 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-younium 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)):
- 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.
If you want to contribute changes to `source-younium`, 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-younium 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`
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/younium.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.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

3
airbyte-integrations/connectors/source-younium/__init__.py
View File

@@ -1,3 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#

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

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

0
airbyte-integrations/connectors/source-younium/source_younium/components.py → airbyte-integrations/connectors/source-younium/components.py
View File

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

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

6231
airbyte-integrations/connectors/source-younium/manifest.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

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

@@ -1,7 +1,7 @@
data:
remoteRegistries:
pypi:
enabled: true
enabled: false
packageName: airbyte-source-younium
registryOverrides:
oss:
@@ -12,11 +12,11 @@ data:
# 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:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
baseImage: docker.io/airbyte/source-declarative-manifest:5.15.0@sha256:09a84e0622f36393077332faf11cc239e77083fae5fa500592c049dca25888a7
connectorSubtype: api
connectorType: source
definitionId: 9c74c2d7-531a-4ebf-b6d8-6181f805ecdc
dockerImageTag: 0.3.22
dockerImageTag: 0.4.0
dockerRepository: airbyte/source-younium
githubIssueLabel: source-younium
icon: younium.svg
@@ -27,7 +27,7 @@ data:
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/younium
tags:
- language:python
- language:manifest-only
- cdk:low-code
connectorTestSuitesOptions:
- suite: liveTests

1475
airbyte-integrations/connectors/source-younium/poetry.lock generated
View File

File diff suppressed because it is too large Load Diff

28
airbyte-integrations/connectors/source-younium/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.3.22"
name = "source-younium"
description = "Source implementation for Younium."
authors = [ "Airbyte <contact@airbyte.io>",]
license = "MIT"
readme = "README.md"
documentation = "https://docs.airbyte.com/integrations/sources/younium"
homepage = "https://airbyte.com"
repository = "https://github.com/airbytehq/airbyte"
[[tool.poetry.packages]]
include = "source_younium"
[tool.poetry.dependencies]
python = "^3.9,<3.12"
airbyte-cdk = "1.0.0"
[tool.poetry.scripts]
source-younium = "source_younium.run:run"
[tool.poetry.group.dev.dependencies]
pytest-mock = "^3.6.1"
requests-mock = "^1.9.3"
pytest = "^6.2"

8
airbyte-integrations/connectors/source-younium/source_younium/__init__.py
View File

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

2994
airbyte-integrations/connectors/source-younium/source_younium/manifest.yaml
View File

File diff suppressed because it is too large Load Diff

14
airbyte-integrations/connectors/source-younium/source_younium/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_younium import SourceYounium
def run():
source = SourceYounium()
launch(source, sys.argv[1:])

18
airbyte-integrations/connectors/source-younium/source_younium/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 SourceYounium(YamlDeclarativeSource):
def __init__(self):
super().__init__(**{"path_to_yaml": "manifest.yaml"})

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

@@ -46,6 +46,7 @@ The Younium source connector supports the following [sync modes](https://docs.ai
| Version | Date | Pull Request | Subject |
| :------ | :--------- | :------------------------------------------------------- | :--------------------------------------------------------- |
| 0.4.0 | 2024-10-23 | [47281](https://github.com/airbytehq/airbyte/pull/47281) | Migrate to Manifest-only |
| 0.3.22 | 2024-10-05 | [46432](https://github.com/airbytehq/airbyte/pull/46432) | Update dependencies |
| 0.3.21 | 2024-09-28 | [46176](https://github.com/airbytehq/airbyte/pull/46176) | Update dependencies |
| 0.3.20 | 2024-09-21 | [45807](https://github.com/airbytehq/airbyte/pull/45807) | Update dependencies |