Skip to content
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

✨Source Public-Api : Migrate Python CDK to Low-code CDK #29391

Closed
Closed
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
4 changes: 2 additions & 2 deletions airbyte-integrations/connectors/source-public-apis/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM python:3.9.13-alpine3.15 as base
FROM python:3.9.11-alpine3.15 as base

# build and load all requirements
FROM base as builder
Expand Down Expand Up @@ -34,5 +34,5 @@ COPY source_public_apis ./source_public_apis
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.1.0
LABEL io.airbyte.version=0.2.0
LABEL io.airbyte.name=airbyte/source-public-apis
64 changes: 7 additions & 57 deletions airbyte-integrations/connectors/source-public-apis/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,10 @@
# Public Apis Source

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

## Local development

### Prerequisites
**To iterate on this connector, make sure to complete this prerequisites section.**

#### Minimum Python version required `= 3.9.0`

#### Build & Activate Virtual Environment and install dependencies
From this connector directory, create a virtual environment:
```
python -m venv .venv
```

This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
development environment of choice. To activate it from the terminal, run:
```
source .venv/bin/activate
pip install -r requirements.txt
pip install '.[tests]'
```
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.

Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
should work as you expect.

#### Building via Gradle
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.

Expand All @@ -39,22 +14,14 @@ To build using Gradle, from the Airbyte repository root, run:
```

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

**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source public-apis test creds`
and place them into `secrets/config.json`.

### Locally running the connector
```
python main.py spec
python main.py check --config secrets/config.json
python main.py discover --config secrets/config.json
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
```

### Locally running the connector docker image

#### Build
Expand All @@ -79,32 +46,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-public-apis:dev discov
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-public-apis:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing
Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
First install test dependencies into your virtual environment:
```
pip install .[tests]
```
### Unit Tests
To run unit tests locally, from the connector directory run:
```
python -m pytest unit_tests
```

### Integration Tests
There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all source connectors) and custom integration tests (which are specific to this connector).
#### Custom Integration tests
Place custom tests inside `integration_tests/` folder, then, from the connector root, run
```
python -m pytest integration_tests
```
#### Acceptance Tests
Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
Customize `acceptance-test-config.yml` file to configure 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.
To run your integration tests with acceptance tests, from the connector root, run

To run your integration tests with Docker, run:
```
python -m pytest integration_tests -p integration_tests.acceptance
./acceptance-test-docker.sh
```
To run your integration tests with docker

### Using gradle to run tests
All commands should be run from airbyte project root.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ acceptance_tests:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
status: "succeed"
discovery:
tests:
- config_path: "secrets/config.json"
Expand All @@ -19,7 +19,7 @@ acceptance_tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
incremental:
incremental:
bypass_reason: "This connector does not implement incremental sync"
full_refresh:
tests:
Expand Down
1 change: 1 addition & 0 deletions airbyte-integrations/connectors/source-public-apis/acceptance-test-docker.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
#!/usr/bin/env sh

source "$(git rev-parse --show-toplevel)/airbyte-integrations/bases/connector-acceptance-test/acceptance-test-docker.sh"
19 changes: 0 additions & 19 deletions airbyte-integrations/connectors/source-public-apis/bootstrap.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"todo-stream-name": {
"todo-field-name": "todo-abnormal-value"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"todo-stream-name": {
"todo-field-name": "value"
}
}
23 changes: 14 additions & 9 deletions airbyte-integrations/connectors/source-public-apis/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
data:
allowedHosts:
hosts:
- "*"
registries:
cloud:
enabled: true
oss:
enabled: true
ab_internal:
ql: 200
sl: 100
connectorSubtype: api
connectorType: source
definitionId: a4617b39-3c14-44cd-a2eb-6e720f269235
dockerImageTag: 0.1.0
dockerImageTag: 0.2.0
dockerRepository: airbyte/source-public-apis
documentationUrl: https://docs.airbyte.com/integrations/sources/public-apis
githubIssueLabel: source-public-apis
icon: publicapi.svg
icon: public-apis.svg
license: MIT
name: Public APIs
registries:
cloud:
enabled: true
oss:
enabled: true
name: Public Apis
releaseDate: TODO
releaseStage: alpha
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/public-apis
tags:
- language:python
- language:lowcode
metadataSpecVersion: "1.0"

This file was deleted.

This file was deleted.

This file was deleted.

5 changes: 3 additions & 2 deletions airbyte-integrations/connectors/source-public-apis/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
from setuptools import find_packages, setup

MAIN_REQUIREMENTS = [
"airbyte-cdk~=0.2",
"airbyte-cdk~=0.1",
]

TEST_REQUIREMENTS = [
"requests-mock~=1.9.3",
"pytest~=6.1",
"pytest~=6.2",
"pytest-mock~=3.6.1",
"connector-acceptance-test",
]

setup(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
from typing import Any, Iterable, Mapping
from airbyte_cdk.sources.streams.http import HttpStream
from airbyte_cdk.sources.declarative.extractors.record_extractor import RecordExtractor
from typing import Any, List
import requests


class CustomExtractor(RecordExtractor):

def extract_records(self, response: requests.Response, **kwargs) -> List[Mapping[str, Any]]:

return [{"name": cat} for cat in response.json()["categories"]]
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
version: "0.29.0"

definitions:
selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path: ["entries"]

selector_categories:
type: RecordSelector
extractor:
class_name: source_public_apis.components.CustomExtractor
requester:
type: HttpRequester
url_base: "https://api.publicapis.org/"
http_method: "GET"
authenticator:
type: NoAuth
retriever:
type: SimpleRetriever
record_selector:
$ref: "#/definitions/selector"
paginator:
type: NoPagination
requester:
$ref: "#/definitions/requester"
base_stream:
type: DeclarativeStream
retriever:
$ref: "#/definitions/retriever"

categories_stream:
$ref: "#/definitions/base_stream"
name: "categories"
primary_key: "name"
retriever:
$ref: "#/definitions/retriever"
record_selector:
$ref: "#/definitions/selector_categories"
$parameters:
path: "/categories"

services_stream:
$ref: "#/definitions/base_stream"
name: "services"
primary_key: "API"
$parameters:
path: "/entries"

streams:
- "#/definitions/categories_stream"
- "#/definitions/services_stream"

check:
type: CheckStream
stream_names:
- "categories"
Loading
Loading