Skip to content

Source clazar: Migrate to manifest-only #44523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 25 additions & 63 deletions airbyte-integrations/connectors/source-clazar/README.md
Original file line number Diff line number Diff line change
@@ -1,101 +1,63 @@
# Clazar Source
# Clazar source connector

This is the repository for the Clazar configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/clazar).
This directory contains the manifest-only connector for `source-clazar`.
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/clazar).

## 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)
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`:

### Installing the connector
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:

From this connector directory, run:
```bash
poetry install --with dev
airbyte-ci connectors --name=source-clazar build
```

An image will be available on your host with the tag `airbyte/source-clazar:dev`.

### Create credentials
### Creating credentials

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/clazar)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_clazar/spec.yaml` file.
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.
See `sample_files/sample_config.json` for a sample config file.


### Locally running the connector

```
poetry run source-clazar spec
poetry run source-clazar check --config secrets/config.json
poetry run source-clazar discover --config secrets/config.json
poetry run source-clazar read --config secrets/config.json --catalog sample_files/configured_catalog.json
```

### Running tests

To run tests locally, from the connector directory run:

```
poetry run pytest tests
```
### Running as a docker container

### Building the docker image
Then run any of the standard source connector commands:

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-clazar build
```

An image will be available on your host with the tag `airbyte/source-clazar:dev`.


### Running as a docker container

Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-clazar:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-clazar:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-clazar:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-clazar: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-clazar 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>
airbyte-ci connectors --name=source-clazar test
```

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-clazar 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-clazar`, 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-clazar 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/clazar.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.
Expand Down
3 changes: 0 additions & 3 deletions airbyte-integrations/connectors/source-clazar/__init__.py

This file was deleted.

13 changes: 0 additions & 13 deletions airbyte-integrations/connectors/source-clazar/main.py

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 2.4.0
version: 4.3.0

type: DeclarativeSource

Expand Down
8 changes: 4 additions & 4 deletions airbyte-integrations/connectors/source-clazar/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ data:
enabled: true
remoteRegistries:
pypi:
enabled: true
enabled: false
packageName: airbyte-source-clazar
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
baseImage: docker.io/airbyte/source-declarative-manifest:4.5.2@sha256:efe8a454f740dc6a07252c4a457777e7c81d95f0d2ea8e9d68114d3610e9a602
connectorSubtype: api
connectorType: source
definitionId: d7df7b64-6266-45b5-ad83-e1515578f371
dockerImageTag: 0.2.6
dockerImageTag: 0.3.0
dockerRepository: airbyte/source-clazar
githubIssueLabel: source-clazar
icon: clazar.svg
Expand All @@ -27,6 +27,6 @@ data:
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/clazar
tags:
- language:python
- cdk:low-code
- language:manifest-only
metadataSpecVersion: "1.0"
Loading
Loading