Skip to content

Commit 392dcaf

Browse files
authored
Source openweather: Migrate to manifest-only (#44772)
1 parent 29404cf commit 392dcaf

File tree

12 files changed

+38
-1197
lines changed

12 files changed

+38
-1197
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,22 @@
11
# Openweather source connector
22

3-
This is the repository for the Openweather source connector, written in Python.
4-
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/openweather).
3+
This directory contains the manifest-only connector for `source-openweather`.
4+
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
55

6-
## Local development
7-
8-
### Prerequisites
9-
10-
- Python (~=3.9)
11-
- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
12-
13-
### Installing the connector
14-
15-
From this connector directory, run:
16-
17-
```bash
18-
poetry install --with dev
19-
```
20-
21-
### Create credentials
6+
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/openweather).
227

23-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/openweather)
24-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_openweather/spec.yaml` file.
25-
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
26-
See `sample_files/sample_config.json` for a sample config file.
27-
28-
### Locally running the connector
29-
30-
```
31-
poetry run source-openweather spec
32-
poetry run source-openweather check --config secrets/config.json
33-
poetry run source-openweather discover --config secrets/config.json
34-
poetry run source-openweather read --config secrets/config.json --catalog sample_files/configured_catalog.json
35-
```
8+
## Local development
369

37-
### Running unit tests
10+
We recommend using the Connector Builder to edit this connector.
11+
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
12+
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!
3813

39-
To run unit tests locally, from the connector directory run:
40-
41-
```
42-
poetry run pytest unit_tests
43-
```
14+
If you prefer to develop locally, you can follow the instructions below.
4415

4516
### Building the docker image
4617

18+
You can build any manifest-only connector with `airbyte-ci`:
19+
4720
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
4821
2. Run the following command to build the docker image:
4922

@@ -53,52 +26,40 @@ airbyte-ci connectors --name=source-openweather build
5326

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

29+
### Creating credentials
30+
31+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/openweather)
32+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file.
33+
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
34+
5635
### Running as a docker container
5736

58-
Then run any of the connector commands as follows:
37+
Then run any of the standard source connector commands:
5938

60-
```
39+
```bash
6140
docker run --rm airbyte/source-openweather:dev spec
6241
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-openweather:dev check --config /secrets/config.json
6342
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-openweather:dev discover --config /secrets/config.json
6443
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-openweather:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
6544
```
6645

67-
### Running our CI test suite
46+
### Running the CI test suite
6847

6948
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
7049

7150
```bash
7251
airbyte-ci connectors --name=source-openweather test
7352
```
7453

75-
### Customizing acceptance Tests
76-
77-
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.
78-
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.
79-
80-
### Dependency Management
81-
82-
All of your dependencies should be managed via Poetry.
83-
To add a new dependency, run:
84-
85-
```bash
86-
poetry add <package-name>
87-
```
88-
89-
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
90-
9154
## Publishing a new version of the connector
9255

93-
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
94-
95-
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-openweather test`
96-
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)):
97-
- bump the `dockerImageTag` value in in `metadata.yaml`
98-
- bump the `version` value in `pyproject.toml`
99-
3. Make sure the `metadata.yaml` content is up to date.
56+
If you want to contribute changes to `source-openweather`, here's how you can do that:
57+
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
58+
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-openweather test`
59+
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)):
60+
- bump the `dockerImageTag` value in in `metadata.yaml`
10061
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/openweather.md`).
10162
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).
10263
6. Pat yourself on the back for being an awesome contributor.
10364
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
104-
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
65+
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

airbyte-integrations/connectors/source-openweather/__init__.py

-3
This file was deleted.

airbyte-integrations/connectors/source-openweather/acceptance-test-config.yml

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
# for more information about how to configure these tests
33
connector_image: airbyte/source-openweather:dev
44
acceptance_tests:
5+
spec:
6+
tests:
7+
- spec_path: "manifest.yaml"
58
connection:
69
tests:
710
- config_path: "secrets/config.json"

airbyte-integrations/connectors/source-openweather/main.py

-8
This file was deleted.

airbyte-integrations/connectors/source-openweather/source_openweather/manifest.yaml airbyte-integrations/connectors/source-openweather/manifest.yaml

+5-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 0.79.1
1+
version: 4.5.4
22

33
type: DeclarativeSource
44

@@ -135,22 +135,22 @@ spec:
135135
order: 1
136136
lat:
137137
type: string
138-
pattern: ^[-]?\d{1,2}(\.\d+)?$
139138
description: >-
140139
Latitude, decimal (-90; 90). If you need the geocoder to automatic
141140
convert city names and zip-codes to geo coordinates and the other way
142141
around, please use our Geocoding API
142+
pattern: ^[-]?\d{1,2}(\.\d+)?$
143143
examples:
144144
- "45.7603"
145145
- "-21.249107858038816"
146146
order: 2
147147
lon:
148148
type: string
149-
pattern: ^[-]?\d{1,2}(\.\d+)?$
150149
description: >-
151150
Longitude, decimal (-180; 180). If you need the geocoder to automatic
152151
convert city names and zip-codes to geo coordinates and the other way
153152
around, please use our Geocoding API
153+
pattern: ^[-]?\d{1,2}(\.\d+)?$
154154
examples:
155155
- "4.835659"
156156
- "-70.39482074115321"
@@ -178,10 +178,6 @@ spec:
178178
order: 5
179179
additionalProperties: true
180180

181-
metadata:
182-
autoImportSchema:
183-
onecall: false
184-
185181
schemas:
186182
onecall:
187183
type: object
@@ -193,8 +189,8 @@ schemas:
193189
description: Weather alerts for the requested location
194190
current:
195191
type: object
196-
additionalProperties: true
197192
description: Contains current weather data
193+
additionalProperties: true
198194
properties:
199195
clouds:
200196
type: number
@@ -216,8 +212,8 @@ schemas:
216212
description: Atmospheric pressure on the sea level
217213
rain:
218214
type: object
219-
additionalProperties: true
220215
description: Information about precipitation in the last hour
216+
additionalProperties: true
221217
properties:
222218
1h:
223219
type: number

airbyte-integrations/connectors/source-openweather/metadata.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ data:
33
hosts:
44
- api.openweathermap.org
55
connectorBuildOptions:
6-
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
6+
baseImage: docker.io/airbyte/source-declarative-manifest:4.5.4@sha256:b07a521add11f987c63c0db68c1b57e90bec0c985f1cb6f3c5a1940cde628a70
77
connectorSubtype: api
88
connectorType: source
99
definitionId: 561d7787-b45e-4f3b-af58-0163c3ba9d5a
10-
dockerImageTag: 0.2.17
10+
dockerImageTag: 0.3.0
1111
dockerRepository: airbyte/source-openweather
1212
documentationUrl: https://docs.airbyte.com/integrations/sources/openweather
1313
githubIssueLabel: source-openweather
@@ -22,12 +22,12 @@ data:
2222
releaseStage: alpha
2323
remoteRegistries:
2424
pypi:
25-
enabled: true
25+
enabled: false
2626
packageName: airbyte-source-openweather
2727
supportLevel: community
2828
tags:
29-
- language:python
3029
- cdk:low-code
30+
- language:manifest-only
3131
connectorTestSuitesOptions:
3232
- suite: liveTests
3333
testConnections:

0 commit comments

Comments
 (0)