Skip to main content

Source implementation for Openweather.

Project description

Openweather source connector

This is the repository for the Openweather source connector, written in Python. For information about how to use this connector within Airbyte, see the documentation.

Local development

Prerequisites

  • Python (~=3.9)
  • Poetry (~=1.7) - installation instructions here

Installing the connector

From this connector directory, run:

poetry install --with dev

Create credentials

If you are a community contributor, follow the instructions in the documentation to generate the necessary credentials. Then create a file secrets/config.json conforming to the source_openweather/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 sample_files/sample_config.json for a sample config file.

Locally running the connector

poetry run source-openweather spec
poetry run source-openweather check --config secrets/config.json
poetry run source-openweather discover --config secrets/config.json
poetry run source-openweather read --config secrets/config.json --catalog sample_files/configured_catalog.json

Running unit tests

To run unit tests locally, from the connector directory run:

poetry run pytest unit_tests

Building the docker image

  1. Install airbyte-ci
  2. Run the following command to build the docker image:
airbyte-ci connectors --name=source-openweather build

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

Running as a docker container

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

Running our CI test suite

You can run our full test suite locally using airbyte-ci:

airbyte-ci connectors --name=source-openweather test

Customizing acceptance Tests

Customize acceptance-test-config.yml file to configure acceptance tests. See Connector Acceptance Tests 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:

poetry add <package-name>

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-openweather test
  2. Bump the connector version (please follow 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/openweather.md).
  5. Create a Pull Request: use our PR naming conventions.
  6. Pat yourself on the back for being an awesome contributor.
  7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
  8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file airbyte_source_openweather-0.2.11.dev202407191147.tar.gz.

File metadata

File hashes

Hashes for airbyte_source_openweather-0.2.11.dev202407191147.tar.gz
Algorithm Hash digest
SHA256 1700e1d215ddc54ea9539eadf10235f36a3d7c6792c4139f302c090a3fe52fda
MD5 9363d959912c44ad028efaa9831d9b46
BLAKE2b-256 cadb79ce779d211d1c3eeb407faecfec88de031d50172327c9224848874b59a6

See more details on using hashes here.

File details

Details for the file airbyte_source_openweather-0.2.11.dev202407191147-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_source_openweather-0.2.11.dev202407191147-py3-none-any.whl
Algorithm Hash digest
SHA256 7833a2a33dc88340d5bc63f9d2c9fbf3019c63da3eda5fb131aeb60c939335c8
MD5 daf56aee66564cd74a2c64b32007f7ef
BLAKE2b-256 a90fddfd89a90182c7764d92c27a27fbc61e125733af1d10a6b7a877a0105fed

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page