Skip to content

Commit

Permalink
Source pokeapi: Migrate to manifest-only (#44791)
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristoGrab authored Aug 27, 2024
1 parent 49e9bc9 commit 5dafd52
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 1,577 deletions.
88 changes: 25 additions & 63 deletions airbyte-integrations/connectors/source-pokeapi/README.md
Original file line number Diff line number Diff line change
@@ -1,101 +1,63 @@
# Pokeapi Source
# Pokeapi source connector

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

## 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-pokeapi build
```

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

### Create credentials
### Creating credentials

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


### Locally running the connector

```
poetry run source-pokeapi spec
poetry run source-pokeapi check --config secrets/config.json
poetry run source-pokeapi discover --config secrets/config.json
poetry run source-pokeapi 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-pokeapi build
```

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


### Running as a docker container

Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-pokeapi:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-pokeapi:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-pokeapi:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-pokeapi: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-pokeapi 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-pokeapi 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-pokeapi 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-pokeapi`, 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-pokeapi 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/pokeapi.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-pokeapi/__init__.py

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ connector_image: airbyte/source-pokeapi:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_pokeapi/spec.yaml"
- spec_path: "manifest.yaml"
backward_compatibility_tests_config:
disable_for_version: "0.1.5"
connection:
Expand Down
8 changes: 0 additions & 8 deletions airbyte-integrations/connectors/source-pokeapi/main.py

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.78.5
version: 4.5.4

type: DeclarativeSource

Expand Down Expand Up @@ -46,8 +46,8 @@ spec:
properties:
pokemon_name:
type: string
title: Pokemon Name
description: Pokemon requested from the API.
title: Pokemon Name
pattern: ^[a-z0-9_\-]+$
enum:
- bulbasaur
Expand Down
8 changes: 4 additions & 4 deletions airbyte-integrations/connectors/source-pokeapi/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ data:
enabled: true
remoteRegistries:
pypi:
enabled: true
enabled: false
packageName: airbyte-source-pokeapi
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:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
baseImage: docker.io/airbyte/source-declarative-manifest:4.5.4@sha256:b07a521add11f987c63c0db68c1b57e90bec0c985f1cb6f3c5a1940cde628a70
connectorSubtype: api
connectorType: source
definitionId: 6371b14b-bc68-4236-bfbd-468e8df8e968
dockerImageTag: 0.2.15
dockerImageTag: 0.3.0
dockerRepository: airbyte/source-pokeapi
githubIssueLabel: source-pokeapi
icon: pokeapi.svg
Expand All @@ -30,8 +30,8 @@ data:
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/pokeapi
tags:
- language:python
- cdk:low-code
- language:manifest-only
connectorTestSuitesOptions:
- suite: liveTests
testConnections:
Expand Down
Loading

0 comments on commit 5dafd52

Please sign in to comment.