forked from airbytehq/airbyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🎉 New Source: OpenWeather (airbytehq#7434)
- Loading branch information
1 parent
e6fac63
commit 369571c
Showing
35 changed files
with
1,034 additions
and
0 deletions.
There are no files selected for viewing
8 changes: 8 additions & 0 deletions
8
...ain/resources/config/STANDARD_SOURCE_DEFINITION/d8540a80-6120-485d-b7d6-272bca477d9b.json
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 |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "sourceDefinitionId": "d8540a80-6120-485d-b7d6-272bca477d9b", | ||
| "name": "OpenWeather", | ||
| "dockerRepository": "airbyte/source-openweather", | ||
| "dockerImageTag": "0.1.0", | ||
| "documentationUrl": "https://docs.airbyte.io/integrations/sources/openweather", | ||
| "icon": "openweather.svg" | ||
| } |
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 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 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
7 changes: 7 additions & 0 deletions
7
airbyte-integrations/connectors/source-openweather/.dockerignore
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| * | ||
| !Dockerfile | ||
| !Dockerfile.test | ||
| !main.py | ||
| !source_openweather | ||
| !setup.py | ||
| !secrets |
38 changes: 38 additions & 0 deletions
38
airbyte-integrations/connectors/source-openweather/Dockerfile
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 |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| FROM python:3.7.11-alpine3.14 as base | ||
|
|
||
| # build and load all requirements | ||
| FROM base as builder | ||
| WORKDIR /airbyte/integration_code | ||
|
|
||
| # upgrade pip to the latest version | ||
| RUN apk --no-cache upgrade \ | ||
| && pip install --upgrade pip \ | ||
| && apk --no-cache add tzdata build-base | ||
|
|
||
|
|
||
| COPY setup.py ./ | ||
| # install necessary packages to a temporary folder | ||
| RUN pip install --prefix=/install . | ||
|
|
||
| # build a clean environment | ||
| FROM base | ||
| WORKDIR /airbyte/integration_code | ||
|
|
||
| # copy all loaded and built libraries to a pure basic image | ||
| COPY --from=builder /install /usr/local | ||
| # add default timezone settings | ||
| COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime | ||
| RUN echo "Etc/UTC" > /etc/timezone | ||
|
|
||
| # bash is installed for more convenient debugging. | ||
| RUN apk --no-cache add bash | ||
|
|
||
| # copy payload code only | ||
| COPY main.py ./ | ||
| COPY source_openweather ./source_openweather | ||
|
|
||
| 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.name=airbyte/source-openweather |
132 changes: 132 additions & 0 deletions
132
airbyte-integrations/connectors/source-openweather/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 |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| # Open Weather Source | ||
|
|
||
| This is the repository for the Open Weather source connector, written in Python. | ||
| For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/open-weather). | ||
|
|
||
| ## Local development | ||
|
|
||
| ### Prerequisites | ||
| **To iterate on this connector, make sure to complete this prerequisites section.** | ||
|
|
||
| #### Minimum Python version required `= 3.7.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. | ||
|
|
||
| To build using Gradle, from the Airbyte repository root, run: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-openweather:build | ||
| ``` | ||
|
|
||
| #### Create credentials | ||
| **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/open-weather) | ||
| to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_openweather/spec.json` 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 open-weather 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 | ||
| First, make sure you build the latest Docker image: | ||
| ``` | ||
| docker build . -t airbyte/source-openweather:dev | ||
| ``` | ||
|
|
||
| You can also build the connector image via Gradle: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-openweather:airbyteDocker | ||
| ``` | ||
| When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in | ||
| the Dockerfile. | ||
|
|
||
| #### Run | ||
| Then run any of the connector commands as follows: | ||
| ``` | ||
| docker run --rm airbyte/source-openweather:dev spec | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-openweather:dev check --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-openweather:dev discover --config /secrets/config.json | ||
| 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 | ||
| ``` | ||
| ## 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 [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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 | ||
| ``` | ||
| python -m pytest integration_tests -p integration_tests.acceptance | ||
| ``` | ||
| To run your integration tests with docker | ||
|
|
||
| ### Using gradle to run tests | ||
| All commands should be run from airbyte project root. | ||
| To run unit tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-openweather:unitTest | ||
| ``` | ||
| To run acceptance and custom integration tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-openweather:integrationTest | ||
| ``` | ||
|
|
||
| ## Dependency Management | ||
| All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development. | ||
| We split dependencies between two groups, dependencies that are: | ||
| * required for your connector to work need to go to `MAIN_REQUIREMENTS` list. | ||
| * required for the testing need to go to `TEST_REQUIREMENTS` list | ||
|
|
||
| ### 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 unit and integration tests. | ||
| 1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)). | ||
| 1. Create a Pull Request. | ||
| 1. Pat yourself on the back for being an awesome contributor. | ||
| 1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. |
18 changes: 18 additions & 0 deletions
18
airbyte-integrations/connectors/source-openweather/acceptance-test-config.yml
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 |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| connector_image: airbyte/source-openweather:dev | ||
| tests: | ||
| spec: | ||
| - spec_path: "source_openweather/spec.json" | ||
| connection: | ||
| - config_path: "secrets/config.json" | ||
| status: "succeed" | ||
| - config_path: "integration_tests/invalid_config.json" | ||
| status: "failed" | ||
| discovery: | ||
| - config_path: "secrets/config.json" | ||
| basic_read: | ||
| - config_path: "secrets/config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" | ||
| incremental: | ||
| - config_path: "secrets/config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" | ||
| future_state_path: "integration_tests/abnormal_state.json" |
16 changes: 16 additions & 0 deletions
16
airbyte-integrations/connectors/source-openweather/acceptance-test-docker.sh
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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| #!/usr/bin/env sh | ||
|
|
||
| # Build latest connector image | ||
| docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2) | ||
|
|
||
| # Pull latest acctest image | ||
| docker pull airbyte/source-acceptance-test:latest | ||
|
|
||
| # Run | ||
| docker run --rm -it \ | ||
| -v /var/run/docker.sock:/var/run/docker.sock \ | ||
| -v /tmp:/tmp \ | ||
| -v $(pwd):/test_input \ | ||
| airbyte/source-acceptance-test \ | ||
| --acceptance-test-config /test_input | ||
|
|
16 changes: 16 additions & 0 deletions
16
airbyte-integrations/connectors/source-openweather/bootstrap.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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # OpenWeather | ||
| OpenWeather is an online service offering an API to retrieve historical, current and forecasted weather data over the globe. | ||
|
|
||
| ## One Call API | ||
| The *One Call API* enable retrieval of multiple weather data for a location in a single call. | ||
| I made this stream implementation a priority because it has a free plan that might be valuable for all data teams building models around weather data. | ||
| The API returns current weather data along with other time resolutions (minutely, hourly, daily) and weather alerts. | ||
|
|
||
| ### Full refresh vs incremental stream implementation | ||
| I did not implement a full refresh stream because One Call API calls are not idempotent: two subsequents calls with the same parameters might give different results. Moreover, it has no historical capabilities (there is a specific historical API for that) and only gives current weather conditions and forecasts. It's why I implemented an incremental stream without a feature to request past data. | ||
|
|
||
| ### Auth | ||
| API calls are authenticated through an API key passed in a query string parameter (`appid`). API keys can be generated from OpenWeather's user account panel. | ||
|
|
||
| ### Rate limits | ||
| The API does have some rate limiting logic but it's not very transparent to the user. There is no endpoint to check calls consumption. It is stated that the free plan allows 60 calls / minute or 1,000,000 calls/month. If the limit is exceeded the user account (not only the API key) gets blocked for an unknown duration. |
Oops, something went wrong.