-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Source klaus-api: Migrate to manifest-only (#44764)
- Loading branch information
1 parent
9259c7b
commit e59510f
Showing
16 changed files
with
756 additions
and
2,136 deletions.
There are no files selected for viewing
84 changes: 29 additions & 55 deletions
84
airbyte-integrations/connectors/source-klaus-api/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,91 +1,65 @@ | ||
# Klaus-Api source connector | ||
# Klaus API source connector | ||
|
||
This directory contains the manifest-only connector for `source-klaus-api`. | ||
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 Klaus-Api source connector, written in Python. | ||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/klaus-api). | ||
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/klaus-api). | ||
|
||
## 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! | ||
|
||
If you prefer to develop locally, you can follow the instructions below. | ||
|
||
### 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/klaus-api) | ||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_klaus_api/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-klaus-api spec | ||
poetry run source-klaus-api check --config secrets/config.json | ||
poetry run source-klaus-api discover --config secrets/config.json | ||
poetry run source-klaus-api read --config secrets/config.json --catalog sample_files/configured_catalog.json | ||
``` | ||
### Building the docker image | ||
|
||
### Running unit tests | ||
To run unit tests locally, from the connector directory run: | ||
``` | ||
poetry run pytest unit_tests | ||
``` | ||
You can build any manifest-only connector with `airbyte-ci`: | ||
|
||
### 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 | ||
airbyte-ci connectors --name=source-klaus-api build | ||
``` | ||
|
||
An image will be available on your host with the tag `airbyte/source-klaus-api:dev`. | ||
|
||
### Creating credentials | ||
|
||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/klaus-api) | ||
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-klaus-api:dev spec | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-klaus-api:dev check --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-klaus-api:dev discover --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-klaus-api:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
``` | ||
|
||
### 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-klaus-api test | ||
``` | ||
### Running the CI test suite | ||
|
||
### 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. | ||
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md): | ||
|
||
### 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-klaus-api 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-klaus-api 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-klaus-api`, 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-klaus-api 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/klaus-api.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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.