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

🎉 New Source: Weatherstack [python cdk] #16473

Merged
merged 41 commits into from
Nov 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
a702088
Added Source Weatherstack
robgleason Sep 8, 2022
e60e0fe
Merge branch 'airbytehq:master' into New-Source-Weatherstack
robgleason Sep 8, 2022
ff6d8bb
Clean Code. Took out TODO's.
robgleason Sep 15, 2022
e8f3a9e
Merge branch 'New-Source-Weatherstack' of https://github.com/robgleas…
robgleason Sep 15, 2022
dd5cfcf
Added link to get API key
robgleason Sep 15, 2022
b262f5e
Remade check_connection and added Constants
robgleason Sep 20, 2022
213cca3
Added WeatherStack to source_definitions and updated Catalog.json
robgleason Sep 21, 2022
1b40726
deleted configured_catalog.json (not in use)
robgleason Sep 21, 2022
756e9ca
Revert "deleted configured_catalog.json (not in use)"
Sep 21, 2022
5b0a99a
chore: revert change
Sep 21, 2022
e3bda0a
chore: format and lint
Sep 21, 2022
876811f
chore: attempt to patch unit tests
Sep 22, 2022
e0cc5b3
Added Classes for Unit tests
robgleason Sep 27, 2022
520d7f2
Merge branch 'New-Source-Weatherstack' of https://github.com/robgleas…
robgleason Sep 27, 2022
10b999b
Merge branch 'New-Source-Weatherstack' into pr/16473
Sep 28, 2022
90cc53d
Merge pull request #1 from koconder/pr/16473
robgleason Sep 28, 2022
b5cc803
Merge branch 'master' into New-Source-Weatherstack
Sep 30, 2022
72d2a73
chore: fix coverage
Sep 30, 2022
bd0fe8b
Merge branch 'master' into New-Source-Weatherstack
Sep 30, 2022
c81dd71
Merge branch 'master' into New-Source-Weatherstack
Oct 1, 2022
1c9ed39
Merge branch 'master' into New-Source-Weatherstack
Oct 1, 2022
3694ee4
chore: fix unit tests for weatherstream
Oct 1, 2022
629ee3d
chore: fix weather stack unittests
Oct 1, 2022
2d707ec
chore: fix unittests fr weatherstack
Oct 2, 2022
ebd9de2
Merge branch 'master' into New-Source-Weatherstack
Oct 2, 2022
6a90505
Added schemas to catalogue
robgleason Oct 9, 2022
ae7c59c
Merge branch 'master' into New-Source-Weatherstack
Oct 9, 2022
eba6fdc
Merge branch 'master' into New-Source-Weatherstack
Oct 10, 2022
3b4c2d5
Merge branch 'master' into New-Source-Weatherstack
Oct 22, 2022
b3b24f9
Update setup.py
Oct 24, 2022
96d1dde
Merge branch 'master' into New-Source-Weatherstack
Oct 24, 2022
61fb844
Update build.gradle
Oct 24, 2022
70da124
Delete sample_state.json
Oct 24, 2022
e8b5ebc
Merge branch 'master' into New-Source-Weatherstack
vincentkoc Nov 3, 2022
8abef7e
support for various account types
Nov 3, 2022
04b86b6
Update source.py
Nov 3, 2022
675e773
Merge branch 'master' into New-Source-Weatherstack
vincentkoc Nov 6, 2022
530a7ef
Merge branch 'master' into New-Source-Weatherstack
vincentkoc Nov 7, 2022
1305178
Delete .dccache
vincentkoc Nov 8, 2022
e4b8fbc
Update source_definitions.yaml
vincentkoc Nov 8, 2022
3e62bc4
Update source_specs.yaml
vincentkoc Nov 8, 2022
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
Original file line number Diff line number Diff line change
Expand Up @@ -1347,6 +1347,13 @@
documentationUrl: https://docs.airbyte.com/integrations/sources/xkcd
sourceType: api
releaseStage: alpha
- name: Weatherstack
vincentkoc marked this conversation as resolved.
Show resolved Hide resolved
sourceDefinitionId: 5db8292c-5f5a-11ed-9b6a-0242ac120002
dockerRepository: airbyte/source-weatherstack
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.com/integrations/sources/weatherstack
sourceType: api
releaseStage: alpha
- name: Webflow
sourceDefinitionId: ef580275-d9a9-48bb-af5e-db0f5855be04
dockerRepository: airbyte/source-webflow
Expand Down
47 changes: 47 additions & 0 deletions airbyte-config/init/src/main/resources/seed/source_specs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12969,6 +12969,53 @@
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-weatherstack:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.io/integrations/sources/weatherstack"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Weatherstack Spec"
type: "object"
required:
- "access_key"
- "query"
- "historical_date"
properties:
is_paid_account:
order: 0
title: "Is Paid Account"
description: "Toggle if you're using a <a href=\"https://weatherstack.com/product\"\
>Paid subscription</a>"
type: "boolean"
default: false
access_key:
order: 1
type: "string"
description: "API access key used to retrieve data from the Weatherstack\
\ API.(https://weatherstack.com/product)"
airbyte_secret: true
query:
order: 2
type: "string"
description: "A location to query such as city, IP, latitudeLongitude, or\
\ zipcode. Multiple locations with semicolon seperated if using a professional\
\ plan or higher. For more info- (https://weatherstack.com/documentation#query_parameter)"
examples:
- "New York"
- "London"
- "98101"
historical_date:
order: 3
type: "string"
description: "This is required for enabling the Historical date API with\
\ format- (YYYY-MM-DD). * Note, only supported by paid accounts"
examples:
- "2015-01-21"
default": "2000-01-01"
pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}"
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-webflow:0.1.2"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/webflow"
Expand Down
1 change: 1 addition & 0 deletions airbyte-integrations/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
| Whisky Hunter | [![source-whisky-hunter](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-whisky-hunter%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-whisky-hunter) |
| Wrike | [![source-wrike](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-wrike%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-wrike) |
| YouTube Analytics | [![source-youtube-analytics](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-youtube-analytics%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-youtube-analytics) |
| Weatherstack | [![source-weatherstack](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-weatherstack%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-weatherstack) |
| Xkcd | [![source-xkcd](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-xkcd%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-xkcd) |
| Zapier Supported Storage | [![source-zapier-supported-storage](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-zapier-supported-storage%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-zapier-supported-storage) |
| Zendesk Chat | [![source-zendesk-chat](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-zendesk-chat%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-zendesk-chat) |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_weatherstack
!setup.py
!secrets
38 changes: 38 additions & 0 deletions airbyte-integrations/connectors/source-weatherstack/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
FROM python:3.9.13-alpine3.15 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_weatherstack ./source_weatherstack

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-weatherstack
132 changes: 132 additions & 0 deletions airbyte-integrations/connectors/source-weatherstack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Weatherstack Source

This is the repository for the Weatherstack source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/weatherstack).

## 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.

To build using Gradle, from the Airbyte repository root, run:
```
./gradlew :airbyte-integrations:connectors:source-weatherstack:build
```

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

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-weatherstack: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-weatherstack:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-weatherstack:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-weatherstack:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-weatherstack: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-weatherstack:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-weatherstack: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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-weatherstack:dev
tests:
spec:
- spec_path: "source_weatherstack/spec.yaml"
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"
empty_streams: []
full_refresh:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
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

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
plugins {
id 'airbyte-python'
id 'airbyte-docker'
id 'airbyte-source-acceptance-test'
}

airbytePython {
moduleDirectory 'source_weatherstack'
}

dependencies {
implementation files(project(':airbyte-integrations:bases:source-acceptance-test').airbyteDocker.outputs)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"current_weather": {
"historical_date": "9999-01-01"
},
"forecast": {
"historical_date": "9999-01-01"
},
"historical": {
"historical_date": "9999-01-01"
},
"location_lookup": {
"historical_date": "9999-01-01"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#


import pytest

pytest_plugins = ("source_acceptance_test.plugin",)


@pytest.fixture(scope="session", autouse=True)
def connector_setup():
"""This fixture is a placeholder for external resources that acceptance test might require."""
yield
Loading